uk.ac.manchester.cs.owl.owlapi

Class OWLClassImpl

java.lang.Object

uk.ac.manchester.cs.owl.owlapi.OWLObjectImplWithoutEntityAndAnonCaching

uk.ac.manchester.cs.owl.owlapi.OWLClassExpressionImpl

uk.ac.manchester.cs.owl.owlapi.OWLClassImpl

All Implemented Interfaces:

Serializable, Comparable<OWLObject>, HasAnnotationPropertiesInSignature, HasAnonymousIndividuals, HasClassesInSignature, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasIndividualsInSignature, HasIRI, HasObjectPropertiesInSignature, HasSignature, OWLClass, OWLClassExpression, OWLEntity, OWLLogicalEntity, OWLNamedObject, OWLObject, OWLPrimitive, OWLPropertyRange, SWRLPredicate, HasIncrementalSignatureGenerationSupport

public class OWLClassImpl
extends OWLClassExpressionImpl
implements OWLClass, Serializable

Since:

2.0.0

Author:

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

See Also:

Serialized Form

Property Summary

Type	Property and Description
OWLAnnotationProperty	asOWLAnnotation A convenience method that obtains this entity as an OWLAnnotationProperty (in order to avoid explicit casting).
OWLDataProperty	asOWLData A convenience method that obtains this entity as an OWLDataProperty (in order to avoid explicit casting).
OWLObjectProperty	asOWLObject A convenience method that obtains this entity as an OWLObjectProperty (in order to avoid explicit casting).
boolean	isOWLAnnotation Gets the value of the property oWLAnnotationProperty.
boolean	isOWLData Gets the value of the property oWLDataProperty.
boolean	isOWLObject Gets the value of the property oWLObjectProperty.

Constructor Summary

Constructors

Constructor and Description
OWLClassImpl(IRI iri)

Method Summary

Modifier and Type	Method and Description
void	accept(OWLClassExpressionVisitor visitor) Accepts a visit from an OWLExpressionVisitor
<O> O	accept(OWLClassExpressionVisitorEx<O> visitor)
void	accept(OWLEntityVisitor visitor)
<O> O	accept(OWLEntityVisitorEx<O> visitor)
void	accept(OWLNamedObjectVisitor visitor) Accepts a visitor
<O> O	accept(OWLNamedObjectVisitorEx<O> visitor) Accepts a visitor
void	accept(OWLObjectVisitor visitor) Accepts a visitor
<O> O	accept(OWLObjectVisitorEx<O> visitor) Accepts a visitor
void	addAnonymousIndividualsToSet(Set<OWLAnonymousIndividual> anons)
void	addSignatureEntitiesToSet(Set<OWLEntity> entities)
Set<OWLClassExpression>	asConjunctSet() Interprets this expression as a conjunction and returns the conjuncts.
Set<OWLClassExpression>	asDisjunctSet() Interprets this expression as a disjunction and returns the disjuncts.
OWLAnnotationProperty	asOWLAnnotationProperty() A convenience method that obtains this entity as an OWLAnnotationProperty (in order to avoid explicit casting).
OWLClass	asOWLClass() If this class expression is in fact a named class then this method may be used to obtain the expression as an OWLClass without the need for casting.
OWLDataProperty	asOWLDataProperty() A convenience method that obtains this entity as an OWLDataProperty (in order to avoid explicit casting).
OWLDatatype	asOWLDatatype() A convenience method that obtains this entity as an OWLDatatype (in order to avoid explicit casting).
OWLNamedIndividual	asOWLNamedIndividual() A convenience method that obtains this entity as an OWLNamedIndividual (in order to avoid explicit casting).
OWLObjectProperty	asOWLObjectProperty() A convenience method that obtains this entity as an OWLObjectProperty (in order to avoid explicit casting).
boolean	containsConjunct(OWLClassExpression ce) Determines if this class expression contains a particular conjunct.
boolean	equals(Object obj)
ClassExpressionType	getClassExpressionType() Gets the class expression type for this class expression
OWLClassExpression	getComplementNNF() Gets the negation normal form of the complement of this expression.
EntityType<?>	getEntityType() Gets the entity type for this entity
IRI	getIRI() Gets the IRI of this object
OWLClassExpression	getNNF() Gets this expression in negation normal form.
OWLClassExpression	getObjectComplementOf() Gets the object complement of this class expression.
boolean	isAnonymous() Determines whether or not this expression represents an anonymous class expression.
boolean	isBottomEntity() Determines if this object is either, owl:Nothing (the bottom class), owl:bottomObjectProperty (the bottom object property) , owl:bottomDataProperty (the bottom data property).
boolean	isBuiltIn() Determines if this entity is a built in entity.
boolean	isClassExpressionLiteral() Determines if this class is a literal.
boolean	isOWLAnnotationProperty() Gets the value of the property oWLAnnotationProperty.
boolean	isOWLClass() A convenience method that determines if this entity is an OWLClass
boolean	isOWLDataProperty() Gets the value of the property oWLDataProperty.
boolean	isOWLDatatype() A convenience method that determines if this entity is an OWLDatatype
boolean	isOWLNamedIndividual() A convenience method that determines if this entity is an OWLNamedIndividual
boolean	isOWLNothing() Determines if this expression is the built in class owl:Nothing.
boolean	isOWLObjectProperty() Gets the value of the property oWLObjectProperty.
boolean	isOWLThing() Determines if this expression is the built in class owl:Thing.
boolean	isTopEntity() Determines if this object is either, owl:Thing (the top class), owl:topObjectProperty (the top object property) , owl:topDataProperty (the top data property) or rdfs:Literal (the top datatype).
boolean	isType(EntityType<?> entityType) Tests to see if this entity is of the specified type
String	toStringID() Returns a string representation that can be used as the ID of this entity.

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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

getNestedClassExpressions, 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

Property Detail

asOWLData

public OWLDataProperty asOWLDataProperty

Specified by:

asOWLDataProperty in interface OWLEntity

Returns:

The entity as an OWLDataProperty.

asOWLObject

public OWLObjectProperty asOWLObjectProperty

Specified by:

asOWLObjectProperty in interface OWLEntity

Returns:

The entity as an OWLObjectProperty.

isOWLData

public boolean isOWLDataProperty

Gets the value of the property oWLDataProperty.

Specified by:

isOWLDataProperty in interface OWLEntity

Returns:

true if this entity is an OWLDataProperty, otherwise false

isOWLObject

public boolean isOWLObjectProperty

Gets the value of the property oWLObjectProperty.

Specified by:

isOWLObjectProperty in interface OWLEntity

Returns:

true if this entity is an OWLObjectProperty, otherwise false

asOWLAnnotation

public OWLAnnotationProperty asOWLAnnotationProperty

Specified by:

asOWLAnnotationProperty in interface OWLEntity

Returns:

The entity as an OWLAnnotationProperty.

isOWLAnnotation

public boolean isOWLAnnotationProperty

Gets the value of the property oWLAnnotationProperty.

Specified by:

isOWLAnnotationProperty in interface OWLEntity

Returns:

true if this entity is an OWLAnnotationProperty, otherwise false

Constructor Detail

OWLClassImpl

public OWLClassImpl(@Nonnull
                    IRI iri)

Parameters:

iri - class iri

Method Detail

isTopEntity

public boolean isTopEntity()

Description copied from interface: OWLObject

Determines if this object is either, owl:Thing (the top class), owl:topObjectProperty (the top object property) , owl:topDataProperty (the top data property) or rdfs:Literal (the top datatype).

Specified by:

isTopEntity in interface OWLObject

Overrides:

isTopEntity in class OWLObjectImplWithoutEntityAndAnonCaching

Returns:

true if this object corresponds to one of the above entities.

isBottomEntity

public boolean isBottomEntity()

Description copied from interface: OWLObject

Determines if this object is either, owl:Nothing (the bottom class), owl:bottomObjectProperty (the bottom object property) , owl:bottomDataProperty (the bottom data property).

Specified by:

isBottomEntity in interface OWLObject

Overrides:

isBottomEntity in class OWLObjectImplWithoutEntityAndAnonCaching

Returns:

true if this object corresponds to one of the above entities.

getClassExpressionType

public ClassExpressionType getClassExpressionType()

Description copied from interface: OWLClassExpression

Gets the class expression type for this class expression

Specified by:

getClassExpressionType in interface OWLClassExpression

Returns:

The class expression type

getObjectComplementOf

@Nonnull
public OWLClassExpression getObjectComplementOf()

Description copied from interface: OWLClassExpression

Gets the object complement of this class expression.

Specified by:

getObjectComplementOf in interface OWLClassExpression

Returns:

A class expression that is the complement of this class expression.

getEntityType

public EntityType<?> getEntityType()

Description copied from interface: OWLEntity

Gets the entity type for this entity

Specified by:

getEntityType in interface OWLEntity

Returns:

The entity type

isType

public boolean isType(EntityType<?> entityType)

Description copied from interface: OWLEntity

Tests to see if this entity is of the specified type

Specified by:

isType in interface OWLEntity

Parameters:

entityType - The entity type

Returns:

true if this entity is of the specified type, otherwise false.

toStringID

public String toStringID()

Description copied from interface: OWLEntity

Returns a string representation that can be used as the ID of this entity. This is the toString representation of the IRI

Specified by:

toStringID in interface OWLEntity

Returns:

A string representing the toString of the IRI of this entity.

getIRI

public IRI getIRI()

Description copied from interface: OWLNamedObject

Gets the IRI of this object

Specified by:

getIRI in interface HasIRI

Specified by:

getIRI in interface OWLNamedObject

Returns:

The IRI of this object

isBuiltIn

public boolean isBuiltIn()

Description copied from interface: OWLEntity

Determines if this entity is a built in entity. The entity is a built in entity if it is:

• a class and the URI corresponds to owl:Thing or owl:Nothing
• an object property and the URI corresponds to owl:topObjectProperty or owl:bottomObjectProperty
• a data property and the URI corresponds to owl:topDataProperty or owl:bottomDataProperty
• a datatype and the IRI is rdfs:Literal or is in the OWL 2 datatype map or is rdf:PlainLiteral
• an annotation property and the URI is in the set of built in annotation property URIs, i.e. one of:
  • rdfs:label
  • rdfs:comment
  • rdfs:seeAlso
  • rdfs:isDefinedBy
  • owl:deprecated
  • owl:priorVersion
  • owl:backwardCompatibleWith
  • owl:incompatibleWith

Specified by:

isBuiltIn in interface OWLEntity

Returns:

true if this entity is a built in entity, or false if this entity is not a builtin entity.

isAnonymous

public boolean isAnonymous()

Description copied from interface: OWLClassExpression

Determines whether or not this expression represents an anonymous class expression.

Specified by:

isAnonymous in interface OWLClassExpression

Returns:

true if this is an anonymous class expression, or false if this is a named class ( OWLClass)

isClassExpressionLiteral

public boolean isClassExpressionLiteral()

Description copied from interface: OWLClassExpression

Determines if this class is a literal. A literal being either a named class or the negation of a named class (i.e. A or not(A)).

Specified by:

isClassExpressionLiteral in interface OWLClassExpression

Returns:

true if this is a literal, or false if this is not a literal.

asOWLClass

public OWLClass asOWLClass()

Description copied from interface: OWLClassExpression

If this class expression is in fact a named class then this method may be used to obtain the expression as an OWLClass without the need for casting. The general pattern of use is to use the isAnonymous to first check

Specified by:

asOWLClass in interface OWLClassExpression

Specified by:

asOWLClass in interface OWLEntity

Returns:

This class expression as an OWLClass.

isOWLThing

public boolean isOWLThing()

Description copied from interface: OWLClassExpression

Determines if this expression is the built in class owl:Thing. This method does not determine if the class is equivalent to owl:Thing.

Specified by:

isOWLThing in interface OWLClassExpression

Returns:

true if this expression is owl:Thing, or false if this expression is not owl:Thing

isOWLNothing

public boolean isOWLNothing()

Description copied from interface: OWLClassExpression

Determines if this expression is the built in class owl:Nothing. This method does not determine if the class is equivalent to owl:Nothing.

Specified by:

isOWLNothing in interface OWLClassExpression

Returns:

true if this expression is owl:Nothing, or false if this expression is not owl:Nothing.

getNNF

public OWLClassExpression getNNF()

Description copied from interface: OWLClassExpression

Gets this expression in negation normal form.

Specified by:

getNNF in interface OWLClassExpression

Returns:

The expression in negation normal form.

asConjunctSet

public Set<OWLClassExpression> asConjunctSet()

Description copied from interface: OWLClassExpression

Interprets this expression as a conjunction and returns the conjuncts. This method does not normalise the expression (full CNF is not computed).

Specified by:

asConjunctSet in interface OWLClassExpression

Returns:

The conjucts of this expression if it is a conjunction (object intersection of), or otherwise a singleton set containing this expression. Note that nested conjunctions will be flattened, for example, calling this method on (A and B) and C will return the set {A, B, C}

containsConjunct

public boolean containsConjunct(OWLClassExpression ce)

Description copied from interface: OWLClassExpression

Determines if this class expression contains a particular conjunct. This method does not do any normalisation such as applying DeMorgans rules.

Specified by:

containsConjunct in interface OWLClassExpression

Parameters:

ce - The conjunct to test for

Returns:

true if this class expression is equal to ce or if this class expression is an ObjectIntersectionOf (possibly nested withing another ObjectIntersectionOf) that contains ce, otherwise false.

asDisjunctSet

public Set<OWLClassExpression> asDisjunctSet()

Description copied from interface: OWLClassExpression

Interprets this expression as a disjunction and returns the disjuncts. This method does not normalise the expression (full DNF is not computed).

Specified by:

asDisjunctSet in interface OWLClassExpression

Returns:

The disjuncts of this expression if it is a disjunction (object union of), or otherwise a singleton set containing this expression. Note that nested disjunctions will be flattened, for example, calling this method on (A or B) or C will return the set {A, B, C}

getComplementNNF

public OWLClassExpression getComplementNNF()

Description copied from interface: OWLClassExpression

Gets the negation normal form of the complement of this expression.

Specified by:

getComplementNNF in interface OWLClassExpression

Returns:

A expression that represents the NNF of the complement of this expression.

asOWLDataProperty

public OWLDataProperty asOWLDataProperty()

Description copied from interface: OWLEntity

A convenience method that obtains this entity as an OWLDataProperty (in order to avoid explicit casting).

Specified by:

asOWLDataProperty in interface OWLEntity

Returns:

The entity as an OWLDataProperty.

asOWLDatatype

public OWLDatatype asOWLDatatype()

Description copied from interface: OWLEntity

A convenience method that obtains this entity as an OWLDatatype (in order to avoid explicit casting).

Specified by:

asOWLDatatype in interface OWLEntity

Returns:

The entity as an OWLDatatype.

asOWLNamedIndividual

public OWLNamedIndividual asOWLNamedIndividual()

Description copied from interface: OWLEntity

A convenience method that obtains this entity as an OWLNamedIndividual (in order to avoid explicit casting).

Specified by:

asOWLNamedIndividual in interface OWLEntity

Returns:

The entity as an OWLNamedIndividual.

asOWLObjectProperty

public OWLObjectProperty asOWLObjectProperty()

Description copied from interface: OWLEntity

A convenience method that obtains this entity as an OWLObjectProperty (in order to avoid explicit casting).

Specified by:

asOWLObjectProperty in interface OWLEntity

Returns:

The entity as an OWLObjectProperty.

isOWLClass

public boolean isOWLClass()

Description copied from interface: OWLEntity

A convenience method that determines if this entity is an OWLClass

Specified by:

isOWLClass in interface OWLEntity

Returns:

true if this entity is an OWLClass, otherwise false

isOWLDataProperty

public boolean isOWLDataProperty()

Gets the value of the property oWLDataProperty.

Specified by:

isOWLDataProperty in interface OWLEntity

Returns:

true if this entity is an OWLDataProperty, otherwise false

isOWLDatatype

public boolean isOWLDatatype()

Description copied from interface: OWLEntity

A convenience method that determines if this entity is an OWLDatatype

Specified by:

isOWLDatatype in interface OWLEntity

Returns:

true if this entity is an OWLDatatype, otherwise false

isOWLNamedIndividual

public boolean isOWLNamedIndividual()

Description copied from interface: OWLEntity

A convenience method that determines if this entity is an OWLNamedIndividual

Specified by:

isOWLNamedIndividual in interface OWLEntity

Returns:

true if this entity is an OWLNamedIndividual, otherwise false

isOWLObjectProperty

public boolean isOWLObjectProperty()

Gets the value of the property oWLObjectProperty.

Specified by:

isOWLObjectProperty in interface OWLEntity

Returns:

true if this entity is an OWLObjectProperty, otherwise false

asOWLAnnotationProperty

public OWLAnnotationProperty asOWLAnnotationProperty()

Description copied from interface: OWLEntity

A convenience method that obtains this entity as an OWLAnnotationProperty (in order to avoid explicit casting).

Specified by:

asOWLAnnotationProperty in interface OWLEntity

Returns:

The entity as an OWLAnnotationProperty.

isOWLAnnotationProperty

public boolean isOWLAnnotationProperty()

Gets the value of the property oWLAnnotationProperty.

Specified by:

isOWLAnnotationProperty in interface OWLEntity

Returns:

true if this entity is an OWLAnnotationProperty, otherwise false

equals

public boolean equals(Object obj)

Overrides:

equals in class OWLObjectImplWithoutEntityAndAnonCaching

accept

public void accept(OWLClassExpressionVisitor visitor)

Description copied from interface: OWLClassExpression

Accepts a visit from an OWLExpressionVisitor

Specified by:

accept in interface OWLClassExpression

Parameters:

visitor - The visitor that wants to visit

accept

public void accept(OWLEntityVisitor visitor)

Specified by:

accept in interface OWLEntity

Parameters:

visitor - visitor

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 void accept(OWLNamedObjectVisitor visitor)

Description copied from interface: OWLNamedObject

Accepts a visitor

Specified by:

accept in interface OWLNamedObject

Parameters:

visitor - The visitor

accept

public <O> O accept(OWLNamedObjectVisitorEx<O> visitor)

Description copied from interface: OWLNamedObject

Accepts a visitor

Specified by:

accept in interface OWLNamedObject

Type Parameters:

O - visitor return type

Parameters:

visitor - The visitor

Returns:

visitor return value

accept

public <O> O accept(OWLEntityVisitorEx<O> visitor)

Specified by:

accept in interface OWLEntity

Type Parameters:

O - visitor return type

Parameters:

visitor - visitor

Returns:

visitor return value

accept

public <O> O accept(OWLClassExpressionVisitorEx<O> visitor)

Specified by:

accept in interface OWLClassExpression

Type Parameters:

O - visitor return type

Parameters:

visitor - visitor

Returns:

visitor return 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

addSignatureEntitiesToSet

public void addSignatureEntitiesToSet(Set<OWLEntity> entities)

Specified by:

addSignatureEntitiesToSet in interface HasIncrementalSignatureGenerationSupport

Parameters:

entities - entity set where entities will be added

addAnonymousIndividualsToSet

public void addAnonymousIndividualsToSet(Set<OWLAnonymousIndividual> anons)

Specified by:

addAnonymousIndividualsToSet in interface HasIncrementalSignatureGenerationSupport

Parameters:

anons - anonymous individuals set where individuals will be added