Package org.swrlapi.builtins.arguments

Interface SWRLBuiltInInputArgumentHandler

    • Method Detail

      • checkThatArgumentIsBound

        void checkThatArgumentIsBound​(int argumentNumber,
                              @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                       throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the argument is not bound

      • isBoundArgument

        boolean isBoundArgument​(int argumentNumber,
                        @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                 throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is bound
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isUnboundArgument

        boolean isUnboundArgument​(int argumentNumber,
                          @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                   throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is unbound
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkForUnboundArguments

        void checkForUnboundArguments​(@NonNull java.lang.String ruleName,
                              @NonNull java.lang.String builtInName,
                              @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                       throws SWRLBuiltInException
        Parameters:
        ruleName - The name of the rule
        builtInName - The name of the built-in
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If unbound arguments exist

      • getFirstUnboundArgumentNumber

        int getFirstUnboundArgumentNumber​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                           throws SWRLBuiltInException
        Get 0-offset position of first unbound argument; return -1 if no unbound arguments are found.
        Parameters:
        arguments - The built-in arguments
        Returns:
        The first unbound argument
        Throws:
        SWRLBuiltInException

      • checkForUnboundArguments

        void checkForUnboundArguments​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments,
                              @NonNull java.lang.String message)
                       throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        message - The exception message used if unbound arguments are found
        Throws:
        SWRLBuiltInException - If at least one argument is unbound

      • checkThatAllArgumentsAreBoundVariables

        void checkThatAllArgumentsAreBoundVariables​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments,
                                            @NonNull java.lang.String message)
                                     throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        message - The exception message used if non bound variables are found
        Throws:
        SWRLBuiltInException - If not all argument are bound variables

      • checkNumberOfArgumentsInRange

        void checkNumberOfArgumentsInRange​(int expectingAtLeast,
                                   int expectingAtMost,
                                   int actual)
                            throws InvalidSWRLBuiltInArgumentNumberException
        Parameters:
        expectingAtLeast - Minimum number of expected arguments
        expectingAtMost - Maximum number of expected arguments
        actual - Actual number of arguments
        Throws:
        InvalidSWRLBuiltInArgumentNumberException - If the condition is not met

      • checkArgumentNumber

        void checkArgumentNumber​(int argumentNumber,
                         @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                  throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the argument number is invalid

      • getArgumentAsAnIRI

        @NonNull org.semanticweb.owlapi.model.IRI getArgumentAsAnIRI​(int argumentNumber,
                                                             @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                                      throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        An IRI representation of the specified argument
        Throws:
        SWRLBuiltInException - If the specified argument cannot be converted to an IRI

      • checkThatArgumentIsAClassPropertyOrNamedIndividual

        void checkThatArgumentIsAClassPropertyOrNamedIndividual​(int argumentNumber,
                                                        @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                                 throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the argument does not meet the check

      • isArgumentAClassPropertyOrNamedIndividual

        boolean isArgumentAClassPropertyOrNamedIndividual​(int argumentNumber,
                                                  @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                           throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True is the argument is a class, property or individual
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getArgumentAsAClassIRI

        @NonNull org.semanticweb.owlapi.model.IRI getArgumentAsAClassIRI​(int argumentNumber,
                                                                 @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                                          throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        The IRI of the specified class argument
        Throws:
        SWRLBuiltInException - If an error occurs during IRI generation

      • isArgumentAClass

        boolean isArgumentAClass​(int argumentNumber,
                         @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                  throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is a class
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsAClass

        void checkThatArgumentIsAClass​(int argumentNumber,
                               @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                        throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not a class

      • isArgumentAClassExpression

        boolean isArgumentAClassExpression​(int argumentNumber,
                                   @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                            throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is a class expression
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsAClassExpression

        void checkThatArgumentIsAClassExpression​(int argumentNumber,
                                         @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                  throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not a class expression

      • isArgumentAnOWLNamedIndividual

        boolean isArgumentAnOWLNamedIndividual​(int argumentNumber,
                                       @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is an individual
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsANamedIndividual

        void checkThatArgumentIsANamedIndividual​(int argumentNumber,
                                         @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                  throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not an individual

      • getArgumentAsANamedIndividualIRI

        @NonNull org.semanticweb.owlapi.model.IRI getArgumentAsANamedIndividualIRI​(int argumentNumber,
                                                                           @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                                                    throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        The IRI of the OWL individual argument
        Throws:
        SWRLBuiltInException - If the argument cannot be represented as an IRI

      • getArgumentAsANamedIndividual

        @NonNull SWRLNamedIndividualBuiltInArgument getArgumentAsANamedIndividual​(int argumentNumber,
                                                                          @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                                                   throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A named individual built-in argument
        Throws:
        SWRLBuiltInException - If the argument cannot be represented as an individual built-in argument

      • isArgumentAProperty

        boolean isArgumentAProperty​(int argumentNumber,
                            @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                     throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is a property
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getArgumentAsAPropertyIRI

        @NonNull org.semanticweb.owlapi.model.IRI getArgumentAsAPropertyIRI​(int argumentNumber,
                                                                    @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                                             throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        The IRI of the specified property
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsAProperty

        void checkThatArgumentIsAProperty​(int argumentNumber,
                                  @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                           throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not a property

      • isArgumentAnObjectProperty

        boolean isArgumentAnObjectProperty​(int argumentNumber,
                                   @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                            throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is an object property
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentAnObjectPropertyExpression

        boolean isArgumentAnObjectPropertyExpression​(int argumentNumber,
                                             @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                      throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is an object property expressiom
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsAnObjectProperty

        void checkThatArgumentIsAnObjectProperty​(int argumentNumber,
                                         @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                  throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not an object property

      • checkThatArgumentIsAnObjectPropertyExpression

        void checkThatArgumentIsAnObjectPropertyExpression​(int argumentNumber,
                                                   @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                            throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not an object property expression

      • isArgumentADataProperty

        boolean isArgumentADataProperty​(int argumentNumber,
                                @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                         throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is a data property
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentADataPropertyExpression

        boolean isArgumentADataPropertyExpression​(int argumentNumber,
                                          @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                   throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is a data property expression
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsADataProperty

        void checkThatArgumentIsADataProperty​(int argumentNumber,
                                      @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                               throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not a data property

      • checkThatArgumentIsADataPropertyExpression

        void checkThatArgumentIsADataPropertyExpression​(int argumentNumber,
                                                @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                         throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not a data property expression

      • isArgumentAnAnnotationProperty

        boolean isArgumentAnAnnotationProperty​(int argumentNumber,
                                       @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is an annotation property
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsAnAnnotationProperty

        void checkThatArgumentIsAnAnnotationProperty​(int argumentNumber,
                                             @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                      throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not an annotation property

      • isArgumentADatatype

        boolean isArgumentADatatype​(int argumentNumber,
                            @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                     throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is a datatype
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsADatatype

        void checkThatArgumentIsADatatype​(int argumentNumber,
                                  @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                           throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not a datatype

      • areAllArgumentLiterals

        boolean areAllArgumentLiterals​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                        throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if all arguments are literals
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsALiteral

        void checkThatArgumentIsALiteral​(int argumentNumber,
                                 @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                          throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not a literal

      • isArgumentALiteral

        boolean isArgumentALiteral​(int argumentNumber,
                           @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                    throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is a literal
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getArgumentAsAnOWLLiteral

        @NonNull org.semanticweb.owlapi.model.OWLLiteral getArgumentAsAnOWLLiteral​(int argumentNumber,
                                                                           @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                                                    throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        An OWL literal
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getArgumentAsAnOWLLiteral

        @NonNull org.semanticweb.owlapi.model.OWLLiteral getArgumentAsAnOWLLiteral​(@NonNull SWRLBuiltInArgument argument)
                                                                    throws SWRLBuiltInException
        Parameters:
        argument - A built-in argument
        Returns:
        An OWL literal
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • areAllArgumentsBooleans

        boolean areAllArgumentsBooleans​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                         throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True is all arguments are booleans
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsABoolean

        void checkThatArgumentIsABoolean​(int argumentNumber,
                                 @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                          throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentABoolean

        boolean isArgumentABoolean​(int argumentNumber,
                           @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                    throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is a boolean
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getArgumentAsABoolean

        boolean getArgumentAsABoolean​(int argumentNumber,
                              @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                       throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A boolean argument value
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentAString

        boolean isArgumentAString​(int argumentNumber,
                          @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                   throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is a string
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getArgumentAsAString

        @NonNull java.lang.String getArgumentAsAString​(int argumentNumber,
                                               @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                        throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A string representation of an argument
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getLiteralArgumentAsAString

        @NonNull java.lang.String getLiteralArgumentAsAString​(int argumentNumber,
                                                      @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                               throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A string representation of an literal argument
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • representArgumentAsAString

        @NonNull java.lang.String representArgumentAsAString​(int argumentNumber,
                                                     @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                              throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A string representation of an argument
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • areAllArgumentsStrings

        boolean areAllArgumentsStrings​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                        throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if all arguments are strings
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsAString

        void checkThatArgumentIsAString​(int argumentNumber,
                                @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                         throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not a string

      • checkThatArgumentIsOfAnOrderedType

        void checkThatArgumentIsOfAnOrderedType​(int argumentNumber,
                                        @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                 throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not of an ordered type

      • isArgumentOfAnOrderedType

        boolean isArgumentOfAnOrderedType​(int argumentNumber,
                                  @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                           throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is of an ordered type
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • areAllArgumentsOfAnOrderedType

        boolean areAllArgumentsOfAnOrderedType​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if all arguments are of an ordered type
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentNumeric

        boolean isArgumentNumeric​(int argumentNumber,
                          @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                   throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is numeric
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentNonNumeric

        boolean isArgumentNonNumeric​(int argumentNumber,
                             @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                      throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument if not numeric
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatAllArgumentsAreOfAnOrderedType

        void checkThatAllArgumentsAreOfAnOrderedType​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                      throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If not all arguments are of an ordered type

      • checkThatArgumentIsNumeric

        void checkThatArgumentIsNumeric​(int argumentNumber,
                                @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                         throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not numeric

      • areAllArgumentsNumeric

        boolean areAllArgumentsNumeric​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                        throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if all arguments are numeric
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsNonNumeric

        void checkThatArgumentIsNonNumeric​(int argumentNumber,
                                   @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                            throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is numeric

      • areAllArgumentsBytes

        boolean areAllArgumentsBytes​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                      throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if all arguments are bytes
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isWidestNumericArgumentAByte

        boolean isWidestNumericArgumentAByte​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                              throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if a byte is the widest numeric argument
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentConvertibleToByte

        boolean isArgumentConvertibleToByte​(int argumentNumber,
                                    @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                             throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is convertible to a byte
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentAByte

        boolean isArgumentAByte​(int argumentNumber,
                        @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                 throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is a byte
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getArgumentAsAByte

        short getArgumentAsAByte​(int argumentNumber,
                         @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                  throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A byte representation of the specified argument
        Throws:
        SWRLBuiltInException - If the argument is not convertible to a byte

      • checkThatArgumentIsAByte

        void checkThatArgumentIsAByte​(int argumentNumber,
                              @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                       throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the argument is not a byte

      • areAllArgumentsShorts

        boolean areAllArgumentsShorts​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                       throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if all arguments are shorts
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isWidestNumericArgumentAShort

        boolean isWidestNumericArgumentAShort​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                               throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True is a short is the widest numeric argument
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentConvertibleToShort

        boolean isArgumentConvertibleToShort​(int argumentNumber,
                                     @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                              throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is convertible to short
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentAShort

        boolean isArgumentAShort​(int argumentNumber,
                         @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                  throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True is the specified argument is a short
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getArgumentAsAShort

        short getArgumentAsAShort​(int argumentNumber,
                          @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                   throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A short representation of the specified argument
        Throws:
        SWRLBuiltInException - If the specified argument can not be converted to a short

      • checkThatArgumentIsAShort

        void checkThatArgumentIsAShort​(int argumentNumber,
                               @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                        throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not a short

      • isWidestNumericArgumentAnInt

        boolean isWidestNumericArgumentAnInt​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                              throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if an int is the widest numeric argument
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • areAllArgumentsInts

        boolean areAllArgumentsInts​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                     throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if all arguments are ints
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentConvertibleToInt

        boolean isArgumentConvertibleToInt​(int argumentNumber,
                                   @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                            throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is convertible to an int
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsAnInt

        void checkThatArgumentIsAnInt​(int argumentNumber,
                              @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                       throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specifed argument is not an int

      • isArgumentAnInt

        boolean isArgumentAnInt​(int argumentNumber,
                        @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                 throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is an int
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getArgumentAsAnInt

        int getArgumentAsAnInt​(int argumentNumber,
                       @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        An int representation of the specified argument
        Throws:
        SWRLBuiltInException - If the specified argument cannot be converted to an int

      • getArgumentAsAPositiveInt

        int getArgumentAsAPositiveInt​(int argumentNumber,
                              @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                       throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A positive int representation of the specified argument
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isWidestNumericArgumentALong

        boolean isWidestNumericArgumentALong​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                              throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True is the widest numeric argument is a long
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • areAllArgumentsLongs

        boolean areAllArgumentsLongs​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                      throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if all arguments are longs
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentConvertibleToLong

        boolean isArgumentConvertibleToLong​(int argumentNumber,
                                    @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                             throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is convertible to a long
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentALong

        boolean isArgumentALong​(int argumentNumber,
                        @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                 throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the argument is a long
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getArgumentAsALong

        long getArgumentAsALong​(int argumentNumber,
                        @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                 throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A long representation of the specified argument
        Throws:
        SWRLBuiltInException - If the specified argument cannot be converted to a long

      • getArgumentAsAPositiveLong

        long getArgumentAsAPositiveLong​(int argumentNumber,
                                @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                         throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A positive long representation of the specified argument
        Throws:
        SWRLBuiltInException - If the specified argument cannot be converted to a positive long

      • checkThatArgumentIsALong

        void checkThatArgumentIsALong​(int argumentNumber,
                              @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                       throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not a long

      • isWidestNumericArgumentAFloat

        boolean isWidestNumericArgumentAFloat​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                               throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if the widest numeric argument is a float
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • areAllArgumentsFloats

        boolean areAllArgumentsFloats​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                       throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if all arguments are floats
        Throws:
        SWRLBuiltInException - If the specified argument cannot be converted to a long

      • isArgumentConvertibleToFloat

        boolean isArgumentConvertibleToFloat​(int argumentNumber,
                                     @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                              throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is convertible to a float
        Throws:
        SWRLBuiltInException - If the specified argument cannot be converted to a long

      • checkThatArgumentIsAFloat

        void checkThatArgumentIsAFloat​(int argumentNumber,
                               @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                        throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not a float

      • isArgumentAFloat

        boolean isArgumentAFloat​(int argumentNumber,
                         @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                  throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is a float
        Throws:
        SWRLBuiltInException - If the specified argument cannot be converted to a long

      • getArgumentAsAFloat

        float getArgumentAsAFloat​(int argumentNumber,
                          @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                   throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A float representation of the specified argument
        Throws:
        SWRLBuiltInException - If the specified argument cannot be converted to a float

      • getArgumentAsAFloat

        float getArgumentAsAFloat​(@NonNull SWRLBuiltInArgument argument)
                   throws SWRLBuiltInException
        Parameters:
        argument - The built-in argument
        Returns:
        A float representation of the built-in argument
        Throws:
        SWRLBuiltInException - If the argument cannot be converted to a float

      • isWidestNumericArgumentADouble

        boolean isWidestNumericArgumentADouble​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if the widest numeric argument is a double
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • areAllArgumentsDoubles

        boolean areAllArgumentsDoubles​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                        throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if all arguments are doubles
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isArgumentConvertibleToDouble

        boolean isArgumentConvertibleToDouble​(int argumentNumber,
                                      @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                               throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is convertible to a double
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • checkThatArgumentIsADouble

        void checkThatArgumentIsADouble​(int argumentNumber,
                                @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                         throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Throws:
        SWRLBuiltInException - If the specified argument is not an xsd:double

      • isArgumentADouble

        boolean isArgumentADouble​(int argumentNumber,
                          @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                   throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        True if the specified argument is an xsd:double
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getArgumentAsADouble

        double getArgumentAsADouble​(int argumentNumber,
                            @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                     throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A double representing the specified argument
        Throws:
        SWRLBuiltInException - If the specified argument cannot be converted to a double

      • getArgumentAsADouble

        double getArgumentAsADouble​(SWRLBuiltInArgument argument)
                     throws SWRLBuiltInException
        Parameters:
        argument - A built-in argument
        Returns:
        A double representation of the built-in argument
        Throws:
        SWRLBuiltInException - If the built-in argument cannot be converted to a double

      • areAllArgumentsDecimals

        boolean areAllArgumentsDecimals​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                         throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if all arguments are xsd:decimals
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • isWidestNumericArgumentAnInteger

        boolean isWidestNumericArgumentAnInteger​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                  throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if the widest numeric argument is an xsd:integer
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getArgumentAsAPositiveInteger

        @NonNull java.math.BigInteger getArgumentAsAPositiveInteger​(int argumentNumber,
                                                            @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                                     throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A positive integer representation of the specified argument
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • areAllArgumentsIntegers

        boolean areAllArgumentsIntegers​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                         throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        Returns:
        True if all arguments are xsd:integers
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getArgumentAsADecimal

        @NonNull java.math.BigDecimal getArgumentAsADecimal​(int argumentNumber,
                                                    @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                             throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A decimal representing the specified argument
        Throws:
        SWRLBuiltInException - If the specified argument cannot be converted to a double

      • getArgumentAsADecimal

        @NonNull java.math.BigDecimal getArgumentAsADecimal​(SWRLBuiltInArgument argument)
                                             throws SWRLBuiltInException
        Parameters:
        argument - A built-in argument
        Returns:
        A decimal representation of the built-on argument
        Throws:
        SWRLBuiltInException - If the built-in argument cannot be converted to a double

      • getArgumentAsAnInteger

        @NonNull java.math.BigInteger getArgumentAsAnInteger​(int argumentNumber,
                                                     @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                              throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        An integer representing the specified argument
        Throws:
        SWRLBuiltInException - If the specified argument cannot be converted to a double

      • getArgumentAsAnInteger

        @NonNull java.math.BigInteger getArgumentAsAnInteger​(SWRLBuiltInArgument argument)
                                              throws SWRLBuiltInException
        Parameters:
        argument - A built-in argument
        Returns:
        An integer representation of the built-on argument
        Throws:
        SWRLBuiltInException - If the built-in argument cannot be converted to a double

      • cloneArguments

        @NonNull java.util.List<@NonNull SWRLBuiltInArgument> cloneArguments​(java.util.List<@NonNull SWRLBuiltInArgument> arguments)
        Parameters:
        arguments - The built-in arguments
        Returns:
        A clone of the built-in argument list

      • getArgumentAsAPropertyValue

        @NonNull java.lang.Object getArgumentAsAPropertyValue​(int argumentNumber,
                                                      @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                               throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        A property value
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getVariableName

        @NonNull java.lang.String getVariableName​(int argumentNumber,
                                          @NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
                                   throws SWRLBuiltInException
        Parameters:
        argumentNumber - The 0-based index of the argument
        arguments - The built-in arguments
        Returns:
        The prefixed name of a variable
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • getInputArgumentValues

        @NonNull java.util.Map<@NonNull java.lang.Integer,​@NonNull org.semanticweb.owlapi.model.OWLObject> getInputArgumentValues​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments,
                                                                                                                                @NonNull SWRLBuiltInArgumentType<?>... builtInArgumentTypes)
                                                                                                                         throws SWRLBuiltInException
        Parameters:
        arguments - The built-in arguments
        builtInArgumentTypes - The types of the built-in arguments
        Returns:
        A map of built-in argument numbers to arguments
        Throws:
        SWRLBuiltInException - If an error occurs during processing

      • makeInvalidArgumentTypeMessage

        @NonNull java.lang.String makeInvalidArgumentTypeMessage​(@NonNull SWRLBuiltInArgument argument,
                                                         @NonNull java.lang.String expectedTypeName)
                                                  throws SWRLBuiltInException
        Parameters:
        argument - The built-in argument
        expectedTypeName - The expected type of the argument
        Returns:
        A user-readable message
        Throws:
        SWRLBuiltInException - If an error occurs during processing