uk.ac.manchester.cs.owl.owlapi

Class OWLEquivalentClassesAxiomImpl

java.lang.Object

uk.ac.manchester.cs.owl.owlapi.OWLObjectImplWithEntityAndAnonCaching

uk.ac.manchester.cs.owl.owlapi.OWLAxiomImplWithEntityAndAnonCaching

uk.ac.manchester.cs.owl.owlapi.OWLLogicalAxiomImplWithEntityAndAnonCaching

uk.ac.manchester.cs.owl.owlapi.OWLClassAxiomImpl

uk.ac.manchester.cs.owl.owlapi.OWLNaryClassAxiomImpl

uk.ac.manchester.cs.owl.owlapi.OWLEquivalentClassesAxiomImpl

All Implemented Interfaces:

Serializable, Comparable<OWLObject>, HasAnnotationPropertiesInSignature, HasAnnotations, HasAnonymousIndividuals, HasClassesInSignature, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasIndividualsInSignature, HasObjectPropertiesInSignature, HasSignature, IsAnonymous, OWLAxiom, OWLClassAxiom, OWLEquivalentClassesAxiom, OWLLogicalAxiom, OWLNaryAxiom<OWLClassExpression>, OWLNaryClassAxiom, OWLObject, OWLSubClassOfAxiomSetShortCut, CollectionContainer<OWLAnnotation>

public class OWLEquivalentClassesAxiomImpl
extends OWLNaryClassAxiomImpl
implements OWLEquivalentClassesAxiom

Since:

2.0.0

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OWLEquivalentClassesAxiomImpl(Set<? extends OWLClassExpression> classExpressions, Collection<? extends OWLAnnotation> annotations)

Method Summary

Modifier and Type	Method and Description
void	accept(OWLAxiomVisitor visitor)
<O> O	accept(OWLAxiomVisitorEx<O> visitor)
void	accept(OWLObjectVisitor visitor) Accepts a visitor
<O> O	accept(OWLObjectVisitorEx<O> visitor) Accepts a visitor
Set<OWLSubClassOfAxiom>	asOWLSubClassOfAxioms()
Set<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.
boolean	equals(Object obj)
OWLEquivalentClassesAxiom	getAnnotatedAxiom(Set<OWLAnnotation> annotations) Gets a copy of this axiom that is annotated with the specified annotations.
AxiomType<?>	getAxiomType() Gets the axiom type for this axiom.
OWLEquivalentClassesAxiom	getAxiomWithoutAnnotations() Gets an axiom that is structurally equivalent to this axiom without annotations.
Set<OWLClass>	getNamedClasses() Gets the named classes (excluding owl:Thing and owl:Nothing) that are in this equivalent classes axiom.
Set<OWLEquivalentClassesAxiom>	splitToAnnotatedPairs() Splits this axiom to pairs, including annotations.

Methods inherited from class uk.ac.manchester.cs.owl.owlapi.OWLNaryClassAxiomImpl

contains, getClassExpressions, getClassExpressionsAsList, getClassExpressionsMinus, walkPairwise

Methods inherited from class uk.ac.manchester.cs.owl.owlapi.OWLLogicalAxiomImplWithEntityAndAnonCaching

isAnnotationAxiom, isLogicalAxiom

Methods inherited from class uk.ac.manchester.cs.owl.owlapi.OWLAxiomImplWithEntityAndAnonCaching

accept, equalsIgnoreAnnotations, getAnnotations, getAnnotations, getNNF, isAnnotated, isOfType, isOfType

Methods inherited from class uk.ac.manchester.cs.owl.owlapi.OWLObjectImplWithEntityAndAnonCaching

compareTo, containsEntityInSignature, getAnnotationPropertiesInSignature, getAnonymousIndividuals, getClassesInSignature, getDataPropertiesInSignature, getDatatypesInSignature, getIndividualsInSignature, getNestedClassExpressions, getObjectPropertiesInSignature, getSignature, hashCode, isBottomEntity, isTopEntity, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

contains, getClassExpressions, getClassExpressionsAsList, getClassExpressionsMinus

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

equalsIgnoreAnnotations, getAnnotations, getAnnotations, getNNF, isAnnotated, isAnnotationAxiom, isLogicalAxiom, isOfType, isOfType

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

getNestedClassExpressions, isBottomEntity, isIndividual, isIRI, isTopEntity, toString

Methods inherited from interface java.lang.Comparable

compareTo

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

getSignature

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

containsEntityInSignature

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.HasObjectPropertiesInSignature

getObjectPropertiesInSignature

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

getDataPropertiesInSignature

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

getIndividualsInSignature

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

getDatatypesInSignature

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

getAnnotationPropertiesInSignature

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

isAnonymous, isNamed

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

walkPairwise

Constructor Detail

OWLEquivalentClassesAxiomImpl

public OWLEquivalentClassesAxiomImpl(@Nonnull
                                     Set<? extends OWLClassExpression> classExpressions,
                                     @Nonnull
                                     Collection<? extends OWLAnnotation> annotations)

Parameters:

classExpressions - equivalent classes

annotations - annotations

Method Detail

getAxiomWithoutAnnotations

public 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

Specified by:

getAxiomWithoutAnnotations in interface OWLEquivalentClassesAxiom

Returns:

the axiom deprived of annotations

getAnnotatedAxiom

public OWLEquivalentClassesAxiom getAnnotatedAxiom(Set<OWLAnnotation> annotations)

Description copied from interface: OWLAxiom

Gets a copy of this axiom that is annotated with the specified annotations. If this axiom has any annotations on it they will be merged with the specified set of annotations. Note that this axiom will not be modified (or remove from any ontologies).

Specified by:

getAnnotatedAxiom in interface OWLAxiom

Parameters:

annotations - The annotations that will be added to existing annotations to annotate the copy of this axiom

Returns:

A copy of this axiom that has the specified annotations plus any existing annotations returned by the OWLAxiom#getAnnotations() method.

asPairwiseAxioms

public Set<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 OWLEquivalentClassesAxiom

Specified by:

asPairwiseAxioms in interface OWLNaryAxiom<OWLClassExpression>

Returns:

This axiom as a set of pairwise axioms.

splitToAnnotatedPairs

public Set<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 OWLEquivalentClassesAxiom

Specified by:

splitToAnnotatedPairs in interface OWLNaryAxiom<OWLClassExpression>

Returns:

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

containsNamedEquivalentClass

public boolean containsNamedEquivalentClass()

Description copied from interface: OWLEquivalentClassesAxiom

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

Specified by:

containsNamedEquivalentClass in interface OWLEquivalentClassesAxiom

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.

containsOWLNothing

public boolean containsOWLNothing()

Description copied from interface: OWLEquivalentClassesAxiom

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

Specified by:

containsOWLNothing in interface OWLEquivalentClassesAxiom

Returns:

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

containsOWLThing

public boolean containsOWLThing()

Description copied from interface: OWLEquivalentClassesAxiom

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

Specified by:

containsOWLThing in interface OWLEquivalentClassesAxiom

Returns:

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

getNamedClasses

public Set<OWLClass> getNamedClasses()

Description copied from interface: OWLEquivalentClassesAxiom

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

Specified by:

getNamedClasses in interface OWLEquivalentClassesAxiom

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

asOWLSubClassOfAxioms

public Set<OWLSubClassOfAxiom> asOWLSubClassOfAxioms()

Specified by:

asOWLSubClassOfAxioms in interface OWLSubClassOfAxiomSetShortCut

Returns:

the set of axioms equivalent to this expression

equals

public boolean equals(Object obj)

Overrides:

equals in class OWLNaryClassAxiomImpl

accept

public void accept(OWLAxiomVisitor visitor)

Specified by:

accept in interface OWLAxiom

Parameters:

visitor - visitor to accept

accept

public void accept(OWLObjectVisitor visitor)

Description copied from interface: OWLObject

Accepts a visitor

Specified by:

accept in interface OWLObject

Parameters:

visitor - The visitor

accept

public <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

accept

public <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

getAxiomType

public 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.