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

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 Summary

Modifier and Type	Method and Description
default void	accept(OWLAxiomVisitor visitor)
default <O> O	accept(OWLAxiomVisitorEx<O> visitor)
default void	accept(OWLObjectVisitor visitor) Accepts a visitor
default <O> O	accept(OWLObjectVisitorEx<O> visitor) Accepts a visitor
default Stream<?>	components()
default Stream<?>	componentsAnnotationsFirst()
default Stream<?>	componentsWithoutAnnotations()
default Stream<OWLDataPropertyExpression>	dataPropertyExpressions() Gets the set of data property expressions that make up the key.
default AxiomType<?>	getAxiomType() Gets the axiom type for this axiom.
OWLHasKeyAxiom	getAxiomWithoutAnnotations() Gets an axiom that is structurally equivalent to this axiom without annotations.
OWLClassExpression	getClassExpression() Gets the class expression, instances of which, this axiom acts as the key for.
default Set<OWLDataPropertyExpression>	getDataPropertyExpressions() Deprecated. use the stream method
default Set<OWLObjectPropertyExpression>	getObjectPropertyExpressions() Deprecated. use the stream method
default Set<OWLPropertyExpression>	getPropertyExpressions() Deprecated. use the stream method
default int	hashIndex()
default int	initHashCode()
default Stream<OWLObjectPropertyExpression>	objectPropertyExpressions() Gets the set of object property expressions that make up the key.
Stream<OWLPropertyExpression>	propertyExpressions() Gets the set of property expressions that form the key.

Methods inherited from interface org.semanticweb.owlapi.model.OWLLogicalAxiom

isLogicalAxiom

Methods inherited from interface org.semanticweb.owlapi.model.OWLAxiom

equalsIgnoreAnnotations, getAnnotatedAxiom, getAnnotatedAxiom, getAnnotatedAxiom, getAnnotatedAxiom, getAnnotatedAxiom, getAxiomWithoutAnnotations, getAxiomWithoutAnnotations, getNNF, isAnnotated, isAnnotationAxiom, isAnonymous, isAxiom, isIndividual, isOfType, isOfType, isOfType, typeIndex

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

getNestedClassExpressions, hashIteration, hasSharedStructure, isAnonymousExpression, isBottomEntity, isIRI, isOntology, isTopEntity, nestedClassExpressions

Methods inherited from interface java.lang.Comparable

compareTo

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

getSignature, signature, unsortedSignature

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

containsEntityInSignature

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

anonymousIndividuals, getAnonymousIndividuals

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

classesInSignature, getClassesInSignature

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

getObjectPropertiesInSignature, objectPropertiesInSignature

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

dataPropertiesInSignature, getDataPropertiesInSignature

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

getIndividualsInSignature, individualsInSignature

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

datatypesInSignature, getDatatypesInSignature

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

annotationPropertiesInSignature, getAnnotationPropertiesInSignature

Methods inherited from interface org.semanticweb.owlapi.model.HasAnnotations

annotations, annotations, annotations, annotationsAsList, getAnnotations, getAnnotations

Methods inherited from interface org.semanticweb.owlapi.model.HasOperands

getOperandsAsList, operands

Method Detail

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 annotationless version of this axiom

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; clled 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

@Deprecated
default Set<OWLPropertyExpression> getPropertyExpressions()

Deprecated. use the stream method

Gets the set of property expressions that form the key.

Returns:

The set of property expression that form the key

propertyExpressions

Stream<OWLPropertyExpression> propertyExpressions()

Gets the set of property expressions that form the key.

Returns:

The set of property expression that form the key

getObjectPropertyExpressions

@Deprecated
default Set<OWLObjectPropertyExpression> getObjectPropertyExpressions()

Deprecated. use the stream method

Gets the set of object property expressions that make up the key. This is simply a convenience method that filteres 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

objectPropertyExpressions

default Stream<OWLObjectPropertyExpression> objectPropertyExpressions()

Gets the set of object property expressions that make up the key. This is simply a convenience method that filteres 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

getDataPropertyExpressions

@Deprecated
default Set<OWLDataPropertyExpression> getDataPropertyExpressions()

Deprecated. use the stream method

Gets the set of data property expressions that make up the key. This is simply a convenience method that filteres 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

dataPropertyExpressions

default Stream<OWLDataPropertyExpression> dataPropertyExpressions()

Gets the set of data property expressions that make up the key. This is simply a convenience method that filteres 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

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.