uk.ac.manchester.cs.owl.owlapi

Class OWLObjectPropertyImpl

java.lang.Object

uk.ac.manchester.cs.owl.owlapi.OWLObjectImpl

uk.ac.manchester.cs.owl.owlapi.OWLPropertyExpressionImpl<OWLClassExpression,OWLObjectPropertyExpression>

uk.ac.manchester.cs.owl.owlapi.OWLObjectPropertyExpressionImpl

uk.ac.manchester.cs.owl.owlapi.OWLObjectPropertyImpl

All Implemented Interfaces:

Serializable, Comparable<OWLObject>, HasAnonymousIndividuals, HasClassesInSignature, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasIndividualsInSignature, HasIRI, HasObjectPropertiesInSignature, HasSignature, OWLEntity, OWLLogicalEntity, OWLNamedObject, OWLObject, OWLObjectProperty, OWLObjectPropertyExpression, OWLPrimitive, OWLProperty<OWLClassExpression,OWLObjectPropertyExpression>, OWLPropertyExpression<OWLClassExpression,OWLObjectPropertyExpression>, SWRLPredicate

public class OWLObjectPropertyImpl
extends OWLObjectPropertyExpressionImpl
implements OWLObjectProperty

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group, Date: 26-Oct-2006

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 If the property is a named object property then this method will obtain the property as such.
boolean	isOWLAnnotation Gets the value of the property oWLAnnotationProperty.
boolean	isOWLBottomData Gets the value of the property oWLBottomDataProperty.
boolean	isOWLBottomObject Gets the value of the property oWLBottomObjectProperty.
boolean	isOWLData Gets the value of the property oWLDataProperty.
boolean	isOWLObject Gets the value of the property oWLObjectProperty.
boolean	isOWLTopData Gets the value of the property oWLTopDataProperty.
boolean	isOWLTopObject Gets the value of the property oWLTopObjectProperty.

Field Summary

Fields inherited from class uk.ac.manchester.cs.owl.owlapi.OWLObjectImpl

NO_ANNOTATIONS, OWL_THING

Constructor Summary

Constructors

Constructor and Description
OWLObjectPropertyImpl(IRI iri)

Method Summary

Modifier and Type	Method and Description
void	accept(OWLEntityVisitor visitor) Accepts a visitor
<O> O	accept(OWLEntityVisitorEx<O> visitor) Accepts a visitor
void	accept(OWLNamedObjectVisitor visitor) Accepts a visitor
void	accept(OWLObjectVisitor visitor) Accepts a visitor
<O> O	accept(OWLObjectVisitorEx<O> visitor) Accepts a visitor
void	accept(OWLPropertyExpressionVisitor visitor)
<O> O	accept(OWLPropertyExpressionVisitorEx<O> visitor)
OWLAnnotationProperty	asOWLAnnotationProperty() A convenience method that obtains this entity as an OWLAnnotationProperty (in order to avoid explicit casting).
OWLClass	asOWLClass() A convenience method that obtains this entity as an OWLClass (in order to avoid explicit 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() If the property is a named object property then this method will obtain the property as such.
protected int	compareObjectOfSameType(OWLObject object)
boolean	equals(Object obj)
Set<OWLAnnotationAssertionAxiom>	getAnnotationAssertionAxioms(OWLOntology ontology)
Set<OWLAnnotation>	getAnnotations(OWLOntology ontology) Gets the annotations for this entity.
Set<OWLAnnotation>	getAnnotations(OWLOntology ontology, OWLAnnotationProperty annotationProperty) Obtains the annotations on this entity where the annotation has the specified annotation property.
EntityType<?>	getEntityType() Gets the entity type for this entity
IRI	getIRI() Gets the IRI of this object
<E extends OWLEntity> E	getOWLEntity(EntityType<E> entityType) Gets an entity that has the same IRI as this entity but is of the specified type.
Set<OWLAxiom>	getReferencingAxioms(OWLOntology ontology) Gets the axioms in the specified ontology that contain this entity in their signature.
Set<OWLAxiom>	getReferencingAxioms(OWLOntology ontology, boolean includeImports) Gets the axioms in the specified ontology and possibly its imports closure that contain this entity in their signature.
protected Set<? extends OWLSubPropertyAxiom<OWLObjectPropertyExpression>>	getSubPropertyAxiomsForRHS(OWLOntology ont)
boolean	isAnonymous() Determines if this property expression is anonymous.
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	isOWLAnnotationProperty() Gets the value of the property oWLAnnotationProperty.
boolean	isOWLBottomDataProperty() Gets the value of the property oWLBottomDataProperty.
boolean	isOWLBottomObjectProperty() Gets the value of the property oWLBottomObjectProperty.
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	isOWLObjectProperty() Gets the value of the property oWLObjectProperty.
boolean	isOWLTopDataProperty() Gets the value of the property oWLTopDataProperty.
boolean	isOWLTopObjectProperty() Gets the value of the property oWLTopObjectProperty.
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.OWLObjectPropertyExpressionImpl

getDisjointPropertiesAxioms, getDomainAxioms, getEquivalentPropertiesAxioms, getInverseProperty, getInverses, getInverses, getNamedProperty, getRangeAxioms, getSimplified, getSubPropertyAxioms, isAsymmetric, isAsymmetric, isDataPropertyExpression, isFunctional, isFunctional, isInverseFunctional, isInverseFunctional, isIrreflexive, isIrreflexive, isObjectPropertyExpression, isReflexive, isReflexive, isSymmetric, isSymmetric, isTransitive, isTransitive

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

getDisjointProperties, getDisjointProperties, getDomains, getDomains, getEquivalentProperties, getEquivalentProperties, getRanges, getRanges, getSubProperties, getSubProperties, getSuperProperties, getSuperProperties

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

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getInverseProperty, getInverses, getInverses, getNamedProperty, getSimplified, isAsymmetric, isAsymmetric, isInverseFunctional, isInverseFunctional, isIrreflexive, isIrreflexive, isReflexive, isReflexive, isSymmetric, isSymmetric, isTransitive, isTransitive

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

getDisjointProperties, getDisjointProperties, getDomains, getDomains, getEquivalentProperties, getEquivalentProperties, getRanges, getRanges, getSubProperties, getSubProperties, getSuperProperties, getSuperProperties, isDataPropertyExpression, isFunctional, isFunctional, isObjectPropertyExpression

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

getAnonymousIndividuals, getClassesInSignature, getDataPropertiesInSignature, getDatatypesInSignature, getIndividualsInSignature, getNestedClassExpressions, getObjectPropertiesInSignature, getSignature

Methods inherited from interface java.lang.Comparable

compareTo

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

containsEntityInSignature

Property Detail

asOWLObject

public OWLObjectProperty asOWLObjectProperty

Specified by:

asOWLObjectProperty in interface OWLEntity

Specified by:

asOWLObjectProperty in interface OWLObjectPropertyExpression

asOWLData

public OWLDataProperty asOWLDataProperty

Specified by:

asOWLDataProperty in interface OWLEntity

isOWLData

public boolean isOWLDataProperty

Gets the value of the property oWLDataProperty.

Specified by:

isOWLDataProperty in interface OWLEntity

isOWLObject

public boolean isOWLObjectProperty

Gets the value of the property oWLObjectProperty.

Specified by:

isOWLObjectProperty in interface OWLEntity

asOWLAnnotation

public OWLAnnotationProperty asOWLAnnotationProperty

Specified by:

asOWLAnnotationProperty in interface OWLEntity

isOWLAnnotation

public boolean isOWLAnnotationProperty

Gets the value of the property oWLAnnotationProperty.

Specified by:

isOWLAnnotationProperty in interface OWLEntity

isOWLTopObject

public boolean isOWLTopObjectProperty

Gets the value of the property oWLTopObjectProperty.

Specified by:

isOWLTopObjectProperty in interface OWLPropertyExpression<OWLClassExpression,OWLObjectPropertyExpression>

isOWLBottomObject

public boolean isOWLBottomObjectProperty

Gets the value of the property oWLBottomObjectProperty.

Specified by:

isOWLBottomObjectProperty in interface OWLPropertyExpression<OWLClassExpression,OWLObjectPropertyExpression>

isOWLTopData

public boolean isOWLTopDataProperty

Gets the value of the property oWLTopDataProperty.

Specified by:

isOWLTopDataProperty in interface OWLPropertyExpression<OWLClassExpression,OWLObjectPropertyExpression>

isOWLBottomData

public boolean isOWLBottomDataProperty

Gets the value of the property oWLBottomDataProperty.

Specified by:

isOWLBottomDataProperty in interface OWLPropertyExpression<OWLClassExpression,OWLObjectPropertyExpression>

Constructor Detail

OWLObjectPropertyImpl

public OWLObjectPropertyImpl(IRI iri)

Parameters:

iri - property 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 OWLObjectImpl

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 OWLObjectImpl

Returns:

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

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

getOWLEntity

public <E extends OWLEntity> E getOWLEntity(EntityType<E> entityType)

Description copied from interface: OWLEntity

Gets an entity that has the same IRI as this entity but is of the specified type.

Specified by:

getOWLEntity in interface OWLEntity

Type Parameters:

E - entity type

Parameters:

entityType - The type of the entity to obtain. This entity is not affected in any way.

Returns:

An entity that has the same IRI as this entity and is of the specified 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.

equals

public boolean equals(Object obj)

Overrides:

equals in class OWLObjectPropertyExpressionImpl

accept

public void accept(OWLEntityVisitor visitor)

Description copied from interface: OWLEntity

Accepts a visitor

Specified by:

accept in interface OWLEntity

Parameters:

visitor - The visitor

accept

public void accept(OWLPropertyExpressionVisitor visitor)

Specified by:

accept in interface OWLPropertyExpression<OWLClassExpression,OWLObjectPropertyExpression>

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 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(OWLEntityVisitorEx<O> visitor)

Description copied from interface: OWLEntity

Accepts a visitor

Specified by:

accept in interface OWLEntity

Type Parameters:

O - visitor return type

Parameters:

visitor - The visitor

Returns:

visitor value

accept

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

Specified by:

accept in interface OWLPropertyExpression<OWLClassExpression,OWLObjectPropertyExpression>

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

isAnonymous

public boolean isAnonymous()

Description copied from interface: OWLPropertyExpression

Determines if this property expression is anonymous.

Specified by:

isAnonymous in interface OWLPropertyExpression<OWLClassExpression,OWLObjectPropertyExpression>

Returns:

true if the property expression is anonymous (because it is the inverse of a property). false if this property is a named object property or named data property.

asOWLObjectProperty

public OWLObjectProperty asOWLObjectProperty()

Description copied from interface: OWLObjectPropertyExpression

If the property is a named object property then this method will obtain the property as such. The general pattern of use is that the isAnonymous method should first be used to determine if the property is named (i.e. not an object property expression such as inv(p)). If the property is named then this method may be used to obtain the property as a named property without casting.

Specified by:

asOWLObjectProperty in interface OWLEntity

Specified by:

asOWLObjectProperty in interface OWLObjectPropertyExpression

getSubPropertyAxiomsForRHS

protected Set<? extends OWLSubPropertyAxiom<OWLObjectPropertyExpression>> getSubPropertyAxiomsForRHS(OWLOntology ont)

Specified by:

getSubPropertyAxiomsForRHS in class OWLPropertyExpressionImpl<OWLClassExpression,OWLObjectPropertyExpression>

getAnnotations

public Set<OWLAnnotation> getAnnotations(OWLOntology ontology)

Description copied from interface: OWLEntity

Gets the annotations for this entity. These are deemed to be annotations in annotation assertion axioms that have a subject that is an IRI that is equal to the IRI of this entity.

Specified by:

getAnnotations in interface OWLEntity

Parameters:

ontology - The ontology to be examined for annotation assertion axioms

Returns:

The annotations that participate directly in an annotation assertion whose subject is an IRI corresponding to the IRI of this entity.

getAnnotationAssertionAxioms

public Set<OWLAnnotationAssertionAxiom> getAnnotationAssertionAxioms(OWLOntology ontology)

Specified by:

getAnnotationAssertionAxioms in interface OWLEntity

Parameters:

ontology - the ontology to use

Returns:

the annotation assertion axioms about this entity in the provided ontology

getAnnotations

public Set<OWLAnnotation> getAnnotations(OWLOntology ontology,
                                         OWLAnnotationProperty annotationProperty)

Description copied from interface: OWLEntity

Obtains the annotations on this entity where the annotation has the specified annotation property.

Specified by:

getAnnotations in interface OWLEntity

Parameters:

ontology - The ontology to examine for annotation axioms

annotationProperty - The annotation property

Returns:

A set of OWLAnnotation objects that have the specified URI.

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

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.

asOWLClass

public OWLClass asOWLClass()

Description copied from interface: OWLEntity

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

Specified by:

asOWLClass in interface OWLEntity

Returns:

The entity as an OWLClass.

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

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

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

isOWLAnnotationProperty

public boolean isOWLAnnotationProperty()

Gets the value of the property oWLAnnotationProperty.

Specified by:

isOWLAnnotationProperty in interface OWLEntity

compareObjectOfSameType

protected int compareObjectOfSameType(OWLObject object)

Specified by:

compareObjectOfSameType in class OWLObjectImpl

isOWLTopObjectProperty

public boolean isOWLTopObjectProperty()

Gets the value of the property oWLTopObjectProperty.

Specified by:

isOWLTopObjectProperty in interface OWLPropertyExpression<OWLClassExpression,OWLObjectPropertyExpression>

isOWLBottomObjectProperty

public boolean isOWLBottomObjectProperty()

Gets the value of the property oWLBottomObjectProperty.

Specified by:

isOWLBottomObjectProperty in interface OWLPropertyExpression<OWLClassExpression,OWLObjectPropertyExpression>

isOWLTopDataProperty

public boolean isOWLTopDataProperty()

Gets the value of the property oWLTopDataProperty.

Specified by:

isOWLTopDataProperty in interface OWLPropertyExpression<OWLClassExpression,OWLObjectPropertyExpression>

isOWLBottomDataProperty

public boolean isOWLBottomDataProperty()

Gets the value of the property oWLBottomDataProperty.

Specified by:

isOWLBottomDataProperty in interface OWLPropertyExpression<OWLClassExpression,OWLObjectPropertyExpression>

getReferencingAxioms

public Set<OWLAxiom> getReferencingAxioms(OWLOntology ontology)

Description copied from interface: OWLEntity

Gets the axioms in the specified ontology that contain this entity in their signature.

Specified by:

getReferencingAxioms in interface OWLEntity

Parameters:

ontology - The ontology that will be searched for axioms

Returns:

The axioms in the specified ontology whose signature contains this entity.

getReferencingAxioms

public Set<OWLAxiom> getReferencingAxioms(OWLOntology ontology,
                                          boolean includeImports)

Description copied from interface: OWLEntity

Gets the axioms in the specified ontology and possibly its imports closure that contain this entity in their signature.

Specified by:

getReferencingAxioms in interface OWLEntity

Parameters:

ontology - The ontology that will be searched for axioms

includeImports - If true then axioms in the imports closure will also be returned, if false then only the axioms in the specified ontology will be returned.

Returns:

The axioms in the specified ontology whose signature contains this entity.