Package org.semanticweb.owlapi.model

Interface OWLHasKeyAxiom

All Superinterfaces:
Comparable<OWLObject>, HasAnnotationPropertiesInSignature, HasAnnotations, HasAnonymousIndividuals, HasClassesInSignature, HasComponents, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasHashIndex, HasIndex, HasIndividualsInSignature, HasObjectPropertiesInSignature, HasOperands<OWLPropertyExpression>, HasSignature, IsAnonymous, OWLAxiom, OWLLogicalAxiom, OWLObject, Serializable
All Known Implementing Classes:
OWLHasKeyAxiomImpl
public interface OWLHasKeyAxiom extends OWLLogicalAxiom, HasOperands<OWLPropertyExpression>
Represents a HasKey axiom in the OWL 2 Specification.
Since:
3.0.0
Author:
Matthew Horridge, The University of Manchester, Information Management Group

  • Method Details

    • getAxiomWithoutAnnotations

      OWLHasKeyAxiom getAxiomWithoutAnnotations()
      Description copied from interface: OWLAxiom
      Gets an axiom that is structurally equivalent to this axiom without annotations. This essentially returns a version of this axiom stripped of any annotations.
      Specified by:
      getAxiomWithoutAnnotations in interface OWLAxiom
      Returns:
      The axiom without annotations

    • components

      default Stream<?> components()
      Specified by:
      components in interface HasComponents
      Returns:
      components as a stream. The stream is ordered (by visit order) but not sorted. Implementations that override components() must ensure the order is compatible with equals() and hashCode().

    • initHashCode

      default int initHashCode()
      Specified by:
      initHashCode in interface OWLObject
      Returns:
      hash code for the object; called on first use, cached by OWLObjectImpl in the default implementation.

    • componentsWithoutAnnotations

      default Stream<?> componentsWithoutAnnotations()
      Specified by:
      componentsWithoutAnnotations in interface HasComponents
      Returns:
      components as a stream; for objects that can have annotations on them, these are skipped. This is useful for comparing axioms without taking annotations into account. Note: annotations on nested objects are not affected. The stream is ordered (by visit order) but not sorted. Implementations that override components() must ensure the order is compatible with equals() and hashCode().

    • componentsAnnotationsFirst

      default Stream<?> componentsAnnotationsFirst()
      Specified by:
      componentsAnnotationsFirst in interface HasComponents
      Returns:
      components as a stream; for objects that can have annotations on them, annotation streams appear first. This is useful in renderers. The stream is ordered (by visit order) but not sorted. Implementations that override components() must ensure the order is compatible with equals() and hashCode().

    • hashIndex

      default int hashIndex()
      Specified by:
      hashIndex in interface HasHashIndex
      Returns:
      index for this type. This is not a hashcode for instances, rather a hashcode for the types.

    • getClassExpression

      OWLClassExpression getClassExpression()
      Gets the class expression, instances of which, this axiom acts as the key for.
      Returns:
      The class expression

    • getPropertyExpressions

      default Set<OWLPropertyExpression> getPropertyExpressions()
      Gets the set of property expressions that form the key.
      Returns:
      The set of property expression that form the key. The set that is returned is a copy; modifications to the returned set will not be reflected in this object.

    • propertyExpressions

      Stream<OWLPropertyExpression> propertyExpressions()
      Returns:
      The stream of property expression that form the key

    • getObjectPropertyExpressions

      default Set<OWLObjectPropertyExpression> getObjectPropertyExpressions()
      Gets the set of object property expressions that make up the key. This is simply a convenience method that filters out the object property expressions in the key. All of the properties returned by this method are included in the return value of the getPropertyExpressions() method.
      Returns:
      The set of object property expressions in the key described by this axiom. The set that is returned is a copy; modifications to the returned set will not be reflected in this object.

    • objectPropertyExpressions

      default Stream<OWLObjectPropertyExpression> objectPropertyExpressions()
      Gets the stream of object property expressions that make up the key. This is simply a convenience method that filters out the object property expressions in the key. All of the properties returned by this method are included in the return value of the getPropertyExpressions() method.
      Returns:
      stream of object property expressions in the key described by this axiom

    • getDataPropertyExpressions

      default Set<OWLDataPropertyExpression> getDataPropertyExpressions()
      Gets the set of data property expressions that make up the key. This is simply a convenience method that filters out the data property expressions in the key. All of the properties returned by this method are included in the return value of the getPropertyExpressions() method.
      Returns:
      The set of object property expressions in the key described by this axiom. The set that is returned is a copy; modifications to the returned set will not be reflected in this object.

    • dataPropertyExpressions

      default Stream<OWLDataPropertyExpression> dataPropertyExpressions()
      Gets the stream of data property expressions that make up the key. This is simply a convenience method that filters out the data property expressions in the key. All of the properties returned by this method are included in the return value of the getPropertyExpressions() method.
      Returns:
      The stream of object property expressions in the key described by this axiom

    • accept

      default void accept(OWLObjectVisitor visitor)
      Description copied from interface: OWLObject
      Accepts a visitor
      Specified by:
      accept in interface OWLObject
      Parameters:
      visitor - The visitor

    • accept

      default <O> O accept(OWLObjectVisitorEx<O> visitor)
      Description copied from interface: OWLObject
      Accepts a visitor
      Specified by:
      accept in interface OWLObject
      Type Parameters:
      O - visitor return type
      Parameters:
      visitor - The visitor
      Returns:
      visitor value

    • accept

      default void accept(OWLAxiomVisitor visitor)
      Specified by:
      accept in interface OWLAxiom
      Parameters:
      visitor - visitor to accept

    • accept

      default <O> O accept(OWLAxiomVisitorEx<O> visitor)
      Specified by:
      accept in interface OWLAxiom
      Type Parameters:
      O - visitor return type
      Parameters:
      visitor - visitor to accept
      Returns:
      visitor value

    • getAxiomType

      default AxiomType<?> getAxiomType()
      Description copied from interface: OWLAxiom
      Gets the axiom type for this axiom.
      Specified by:
      getAxiomType in interface OWLAxiom
      Returns:
      The axiom type that corresponds to the type of this axiom.