Package org.swrlapi.core

Interface SWRLAPIBuiltInAtom

  • All Superinterfaces:
    java.lang.Comparable<org.semanticweb.owlapi.model.OWLObject>, org.semanticweb.owlapi.model.HasAnnotationPropertiesInSignature, org.semanticweb.owlapi.model.HasAnonymousIndividuals, org.semanticweb.owlapi.model.HasClassesInSignature, org.semanticweb.owlapi.model.HasContainsEntityInSignature, org.semanticweb.owlapi.model.HasDataPropertiesInSignature, org.semanticweb.owlapi.model.HasDatatypesInSignature, org.semanticweb.owlapi.model.HasIndividualsInSignature, org.semanticweb.owlapi.model.HasObjectPropertiesInSignature, org.semanticweb.owlapi.model.HasSignature, org.semanticweb.owlapi.model.IsAnonymous, org.semanticweb.owlapi.model.OWLObject, java.io.Serializable, org.semanticweb.owlapi.model.SWRLAtom, org.semanticweb.owlapi.model.SWRLBuiltInAtom, org.semanticweb.owlapi.model.SWRLObject
    public interface SWRLAPIBuiltInAtom
extends org.semanticweb.owlapi.model.SWRLBuiltInAtom
    The SWRLAPI's built-in atom extends the OWLAPI's built-in atom with additional functionality. In addition to the SWRLBuiltInArgument class, this interface is the SWRLAPI's primary OWLAPI extension point.
    See Also:
    SWRLBuiltInArgument

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addArguments​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> additionalArguments)  
      @NonNull java.util.List<@NonNull java.lang.String> getArgumentsVariableNames()  
      @NonNull java.util.List<@NonNull java.lang.String> getArgumentsVariableNamesExceptFirst()  
      java.lang.String getArgumentVariableName​(int argumentNumber)  
      @NonNull java.util.List<@NonNull SWRLBuiltInArgument> getBuiltInArguments()  
      int getBuiltInIndex()  
      @NonNull org.semanticweb.owlapi.model.IRI getBuiltInIRI()  
      java.lang.String getBuiltInPrefixedName()  
      int getNumberOfArguments()  
      @NonNull java.util.Set<@NonNull java.lang.String> getPathVariableNames()
      Indicates variables that this built-in depends on (directly or indirectly)
      java.lang.String getRuleName()  
      @NonNull java.util.Set<@NonNull java.lang.String> getUnboundArgumentVariableNames()  
      boolean hasPathVariables()  
      boolean hasUnboundArguments()  
      boolean hasVariableArguments()  
      boolean isArgumentAVariable​(int argumentNumber)  
      boolean isArgumentUnbound​(int argumentNumber)  
      void setBuiltInArguments​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)  
      void setBuiltInIndex​(int builtInIndex)  
      void setPathVariableNames​(java.util.Set<@NonNull java.lang.String> variableNames)  
      void setUsesSQWRLCollectionResults()
      Indicate that the built-in uses a SQWRL collection result
      boolean usesAtLeastOneVariableOf​(java.util.Set<@NonNull java.lang.String> variableNames)  
      boolean usesSQWRLCollectionResults()  

      • Methods inherited from interface java.lang.Comparable

        compareTo

      • Methods inherited from interface org.semanticweb.owlapi.model.HasAnnotationPropertiesInSignature

        getAnnotationPropertiesInSignature

      • Methods inherited from interface org.semanticweb.owlapi.model.HasAnonymousIndividuals

        getAnonymousIndividuals

      • Methods inherited from interface org.semanticweb.owlapi.model.HasClassesInSignature

        getClassesInSignature

      • Methods inherited from interface org.semanticweb.owlapi.model.HasContainsEntityInSignature

        containsEntityInSignature

      • Methods inherited from interface org.semanticweb.owlapi.model.HasDataPropertiesInSignature

        getDataPropertiesInSignature

      • Methods inherited from interface org.semanticweb.owlapi.model.HasDatatypesInSignature

        getDatatypesInSignature

      • Methods inherited from interface org.semanticweb.owlapi.model.HasIndividualsInSignature

        getIndividualsInSignature

      • Methods inherited from interface org.semanticweb.owlapi.model.HasObjectPropertiesInSignature

        getObjectPropertiesInSignature

      • Methods inherited from interface org.semanticweb.owlapi.model.HasSignature

        getSignature

      • Methods inherited from interface org.semanticweb.owlapi.model.IsAnonymous

        isAnonymous, isNamed

      • Methods inherited from interface org.semanticweb.owlapi.model.OWLObject

        accept, accept, getNestedClassExpressions, isBottomEntity, isIndividual, isIRI, isTopEntity, toString

      • Methods inherited from interface org.semanticweb.owlapi.model.SWRLAtom

        getAllArguments

      • Methods inherited from interface org.semanticweb.owlapi.model.SWRLBuiltInAtom

        getArguments, getPredicate, isCoreBuiltIn

      • Methods inherited from interface org.semanticweb.owlapi.model.SWRLObject

        accept, accept

    • Method Detail

      • getBuiltInPrefixedName

        java.lang.String getBuiltInPrefixedName()
        Returns:
        The prefixed name of the built-in

      • getBuiltInIRI

        @NonNull org.semanticweb.owlapi.model.IRI getBuiltInIRI()
        Returns:
        The IRI of the built-in

      • getBuiltInIndex

        int getBuiltInIndex()
        Returns:
        The 0-based index of the built-in in the enclosing rule

      • setBuiltInIndex

        void setBuiltInIndex​(int builtInIndex)
        Parameters:
        builtInIndex - The 0-based index of the built-in in the enclosing rule

      • usesAtLeastOneVariableOf

        boolean usesAtLeastOneVariableOf​(java.util.Set<@NonNull java.lang.String> variableNames)
                          throws SWRLBuiltInException
        Parameters:
        variableNames - A set of variable names
        Returns:
        True if the built-in uses at lease one of the supplied variables
        Throws:
        SWRLBuiltInException

      • getBuiltInArguments

        @NonNull java.util.List<@NonNull SWRLBuiltInArgument> getBuiltInArguments()
        Returns:
        A list of built-in arguments

      • getNumberOfArguments

        int getNumberOfArguments()
        Returns:
        The number of built-in arguments

      • isArgumentAVariable

        boolean isArgumentAVariable​(int argumentNumber)
        Parameters:
        argumentNumber - A argument index
        Returns:
        If the specified argument is a variable

      • isArgumentUnbound

        boolean isArgumentUnbound​(int argumentNumber)
                   throws SWRLBuiltInException
        Parameters:
        argumentNumber - A argument index
        Returns:
        If the specified argument is unbound
        Throws:
        SWRLBuiltInException

      • hasVariableArguments

        boolean hasVariableArguments()
        Returns:
        True if at least one argument is a variable

      • getUnboundArgumentVariableNames

        @NonNull java.util.Set<@NonNull java.lang.String> getUnboundArgumentVariableNames()
                                                                           throws SWRLBuiltInException
        Returns:
        The names of the unbound variable arguments
        Throws:
        SWRLBuiltInException

      • getArgumentVariableName

        java.lang.String getArgumentVariableName​(int argumentNumber)
                                  throws SWRLBuiltInException
        Parameters:
        argumentNumber - An argument index
        Returns:
        A variable name
        Throws:
        SWRLBuiltInException

      • getArgumentsVariableNamesExceptFirst

        @NonNull java.util.List<@NonNull java.lang.String> getArgumentsVariableNamesExceptFirst()
                                                                                 throws SWRLBuiltInException
        Returns:
        A list of variable names
        Throws:
        SWRLBuiltInException

      • getRuleName

        java.lang.String getRuleName()
        Returns:
        The name of the rule

      • setBuiltInArguments

        void setBuiltInArguments​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> arguments)
        Parameters:
        arguments - A list of built-in arguments

      • addArguments

        void addArguments​(@NonNull java.util.List<@NonNull SWRLBuiltInArgument> additionalArguments)
        Parameters:
        additionalArguments - A list of built-in arguments

      • setPathVariableNames

        void setPathVariableNames​(java.util.Set<@NonNull java.lang.String> variableNames)
        Parameters:
        variableNames - A set of variable names

      • hasPathVariables

        boolean hasPathVariables()
        Returns:
        True if the built-in has at least one path variable

      • getPathVariableNames

        @NonNull java.util.Set<@NonNull java.lang.String> getPathVariableNames()
        Indicates variables that this built-in depends on (directly or indirectly)
        Returns:
        A list of variable names

      • setUsesSQWRLCollectionResults

        void setUsesSQWRLCollectionResults()
        Indicate that the built-in uses a SQWRL collection result

      • usesSQWRLCollectionResults

        boolean usesSQWRLCollectionResults()
        Returns:
        True if the built-in uses a SQWRL collection result