org.semanticweb.owlapi.model

Interface OWLEquivalentClassesAxiom

All Superinterfaces:

Comparable<OWLObject>, HasAnnotationPropertiesInSignature, HasAnnotations, HasAnonymousIndividuals, HasClassesInSignature, HasComponents, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasHashIndex, HasIndex, HasIndividualsInSignature, HasObjectPropertiesInSignature, HasOperands<OWLClassExpression>, HasSignature, IsAnonymous, OWLAxiom, OWLClassAxiom, OWLLogicalAxiom, OWLNaryAxiom<OWLClassExpression>, OWLNaryClassAxiom, OWLObject, OWLSubClassOfAxiomSetShortCut, Serializable

All Known Implementing Classes:

OWLEquivalentClassesAxiomImpl

public interface OWLEquivalentClassesAxiom
extends OWLNaryClassAxiom

Represents an EquivalentClasses axiom in the OWL 2 Specification.

Since:

2.0.0

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics 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
Collection<OWLEquivalentClassesAxiom>	asPairwiseAxioms() Gets this axiom as a set of pairwise axioms; if the axiom contains only two operands, the axiom itself is returned unchanged, including its annotations.
boolean	containsNamedEquivalentClass() Determines if this equivalent classes axiom contains at least one named class (excluding owl:Thing or owl:Nothing).
boolean	containsOWLNothing() Determines if this class axiom makes a class expression equivalent to nothing.
boolean	containsOWLThing() Determines if this class axiom makes a class expression equivalent to thing.
default AxiomType<?>	getAxiomType() Gets the axiom type for this axiom.
OWLEquivalentClassesAxiom	getAxiomWithoutAnnotations() Gets an axiom that is structurally equivalent to this axiom without annotations.
default Set<OWLClass>	getNamedClasses() Gets the named classes (excluding owl:Thing and owl:Nothing) that are in this equivalent classes axiom.
default int	hashIndex()
Stream<OWLClass>	namedClasses() Gets the named classes (excluding owl:Thing and owl:Nothing) that are in this equivalent classes axiom.
Collection<OWLEquivalentClassesAxiom>	splitToAnnotatedPairs() Splits this axiom to pairs, including annotations.

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

classExpressions, components, componentsAnnotationsFirst, componentsWithoutAnnotations, contains, getClassExpressions, getClassExpressionsAsList, getClassExpressionsMinus, initHashCode, operands

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, 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.IsAnonymous

isAnonymous, isNamed

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

annotations, annotations, annotations, annotationsAsList, getAnnotations, getAnnotations

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

allMatch, allMatchAllPairs, anyMatch, anyMatchAllPairs, forEach, forEachAllPairs, walkAllPairwise, walkPairwise

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

getOperandsAsList

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

asOWLSubClassOfAxioms

Method Detail

getAxiomWithoutAnnotations

OWLEquivalentClassesAxiom 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

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.

containsNamedEquivalentClass

boolean containsNamedEquivalentClass()

Determines if this equivalent classes axiom contains at least one named class (excluding owl:Thing or owl:Nothing).

Returns:

true if the axiom contains at least one named class otherwise false. Note that this method will return false if the only named classes are owl:Thing or owl:Nothing.

getNamedClasses

default Set<OWLClass> getNamedClasses()

Gets the named classes (excluding owl:Thing and owl:Nothing) that are in this equivalent classes axiom.

Returns:

A set of classes that represents the named classes that are specified to be equivalent to some other class (expression), excluding the built in classes owl:Thing and owl:Nothing. The set that is returned is a copy; modifications to the returned set will not be reflected in this object.

namedClasses

Stream<OWLClass> namedClasses()

Gets the named classes (excluding owl:Thing and owl:Nothing) that are in this equivalent classes axiom.

Returns:

stream of classes that represents the named classes that are specified to be equivalent to some other class (expression), excluding the built in classes owl:Thing and owl:Nothing

containsOWLNothing

boolean containsOWLNothing()

Determines if this class axiom makes a class expression equivalent to nothing.

Returns:

true if this axiom contains owl:Nothing as an equivalent class.

containsOWLThing

boolean containsOWLThing()

Determines if this class axiom makes a class expression equivalent to thing.

Returns:

true if this axioms contains owl:Thing as an equivalent class.

asPairwiseAxioms

Collection<OWLEquivalentClassesAxiom> asPairwiseAxioms()

Description copied from interface: OWLNaryAxiom

Gets this axiom as a set of pairwise axioms; if the axiom contains only two operands, the axiom itself is returned unchanged, including its annotations. Note that, aside from this exception, annotations on this axiom will not be copied to each axiom returned in the set of pairwise axioms.
Note: This will contain all pairs, i.e., for the set "a, b, c" the pairs "a, b", "a, c", "b, c" will be returned. For some applications, only "a, b", "b, c" are required.

Specified by:

asPairwiseAxioms in interface OWLNaryAxiom<OWLClassExpression>

Returns:

This axiom as a set of pairwise axioms.

splitToAnnotatedPairs

Collection<OWLEquivalentClassesAxiom> splitToAnnotatedPairs()

Description copied from interface: OWLNaryAxiom

Splits this axiom to pairs, including annotations. This method implements the process described at http://www.w3.org/TR/owl2-mapping-to-rdf/# Axioms_that_are_Translated_to_Multiple_Triples which is used, for example, in serializing EquivalentProperty axioms with three operands. Note that annotations on this axiom will be copied to each axiom returned in the set of pairwise axioms. Note: This will contain only the "An, An+1" pairs, i.e., for the set "a, b, c" the pairs "a, b" and "b, c" will be returned, but not "a, c".

Specified by:

splitToAnnotatedPairs in interface OWLNaryAxiom<OWLClassExpression>

Returns:

This axiom as a set of pairwise axioms, annotations included.

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.