uk.ac.manchester.cs.owl.owlapi

Class OWLAnnotationPropertyImpl

java.lang.Object

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

uk.ac.manchester.cs.owl.owlapi.OWLAnnotationPropertyImpl

All Implemented Interfaces:

Serializable, Comparable<OWLObject>, OWLAnnotationProperty, OWLEntity, OWLNamedObject, OWLObject

public class OWLAnnotationPropertyImpl
extends OWLObjectImpl
implements OWLAnnotationProperty

Author:

Matthew Horridge, The University of Manchester, Information Management Group, Date: 14-Jan-2009

See Also:

Serialized Form

Property Summary

Properties

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 A convenience method that determines if this entity is an OWLAnnotationProperty
boolean	isOWLData A convenience method that determines if this entity is an OWLDataProperty
boolean	isOWLObject A convenience method that determines if this entity is an OWLObjectProperty

Field Summary

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

NO_ANNOTATIONS, OWL_THING

Constructor Summary

Constructors

Constructor and Description
OWLAnnotationPropertyImpl(IRI i)

Method Summary

Methods

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
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() A convenience method that obtains this entity as an OWLObjectProperty (in order to avoid explicit casting).
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.
Set<OWLAnnotationProperty>	getSubProperties(OWLOntology ontology) Gets the annotation properties which are asserted to be sub-properties of this annotation property in the specified ontology.
Set<OWLAnnotationProperty>	getSubProperties(OWLOntology ontology, boolean includeImportsClosure) Gets the annotation properties which are asserted to be sub-properties of this annotation property in the specified ontology and potentially its imports closure.
Set<OWLAnnotationProperty>	getSubProperties(Set<OWLOntology> ontologies) Gets the annotation properties which are asserted to be sub-properties of this annotation property in the specified set of ontologies.
Set<OWLAnnotationProperty>	getSuperProperties(OWLOntology ontology) Gets the annotation properties which are asserted to be super-properties of this annotation property in the specified ontology.
Set<OWLAnnotationProperty>	getSuperProperties(OWLOntology ontology, boolean includeImportsClosure) Gets the annotation properties which are asserted to be super-properties of this annotation property in the specified ontology and potentially its imports closure.
Set<OWLAnnotationProperty>	getSuperProperties(Set<OWLOntology> ontologies) Gets the annotation properties which are asserted to be super-properties of this annotation property in the specified set of ontologies.
boolean	isBuiltIn() Determines if this entity is a built in entity.
boolean	isComment() Determines if this annotation property has an IRI corresponding to rdfs:comment.
boolean	isDeprecated() Determines if this annotation property has an IRI corresponding to owl:deprecated.
boolean	isLabel() Determines if this annotation property has an IRI corresponding to rdfs:label.
boolean	isOWLAnnotationProperty() A convenience method that determines if this entity is an OWLAnnotationProperty
boolean	isOWLClass() A convenience method that determines if this entity is an OWLClass
boolean	isOWLDataProperty() A convenience method that determines if this entity is an 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() A convenience method that determines if this entity is an OWLObjectProperty
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.OWLObjectImpl

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

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface java.lang.Comparable

compareTo

Property Detail

asOWLData

Specified by:

asOWLDataProperty in interface OWLEntity

Returns:

The entity as an OWLDataProperty.

asOWLObject

Specified by:

asOWLObjectProperty in interface OWLEntity

Returns:

The entity as an OWLObjectProperty.

isOWLData

Specified by:

isOWLDataProperty in interface OWLEntity

Returns:

true if this entity is an OWLDataProperty, otherwise false

isOWLObject

Specified by:

isOWLObjectProperty in interface OWLEntity

Returns:

true if this entity is an OWLObjectProperty, otherwise false

asOWLAnnotation

Specified by:

asOWLAnnotationProperty in interface OWLEntity

Returns:

The entity as an OWLAnnotationProperty.

isOWLAnnotation

Specified by:

isOWLAnnotationProperty in interface OWLEntity

Returns:

true if this entity is an OWLAnnotationProperty, otherwise false

Constructor Detail

OWLAnnotationPropertyImpl

public OWLAnnotationPropertyImpl(IRI i)

Parameters:

i - iri for property

Method Detail

getIRI

public IRI getIRI()

Description copied from interface: OWLNamedObject

Gets the IRI of this object

Specified by:

getIRI in interface OWLNamedObject

Returns:

The IRI of this object

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.

isDeprecated

public boolean isDeprecated()

Description copied from interface: OWLAnnotationProperty

Determines if this annotation property has an IRI corresponding to owl:deprecated. An annotation along the owl:deprecated property which has a value of "true"^^xsd:boolean can be used to deprecate IRIs. (See Section 5.5 of the OWL 2 specification.

Specified by:

isDeprecated in interface OWLAnnotationProperty

Returns:

true if the IRI of this annotation property is owl:deprecated, where owl: expands to the usual prefix, otherwise false.

compareObjectOfSameType

protected int compareObjectOfSameType(OWLObject object)

Specified by:

compareObjectOfSameType in class OWLObjectImpl

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

isComment

public boolean isComment()

Description copied from interface: OWLAnnotationProperty

Determines if this annotation property has an IRI corresponding to rdfs:comment.

Specified by:

isComment in interface OWLAnnotationProperty

Returns:

true if the IRI of this annotation property is rdfs:comment, where rdfs: expands to the usual prefix, otherwise false.

isLabel

public boolean isLabel()

Description copied from interface: OWLAnnotationProperty

Determines if this annotation property has an IRI corresponding to rdfs:label.

Specified by:

isLabel in interface OWLAnnotationProperty

Returns:

true if the IRI of this annotation property is rdfs:label, where rdfs: expands to the usual prefix, otherwise false.

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

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.

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.

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)

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.

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.

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.

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()

Description copied from interface: OWLEntity

A convenience method that determines if this entity is an 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()

Description copied from interface: OWLEntity

A convenience method that determines if this entity is an 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()

Description copied from interface: OWLEntity

A convenience method that determines if this entity is an OWLAnnotationProperty

Specified by:

isOWLAnnotationProperty in interface OWLEntity

Returns:

true if this entity is an OWLAnnotationProperty, otherwise false

accept

public void accept(OWLNamedObjectVisitor visitor)

Description copied from interface: OWLNamedObject

Accepts a visitor

Specified by:

accept in interface OWLNamedObject

Parameters:

visitor - The visitor

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.

getSubProperties

public Set<OWLAnnotationProperty> getSubProperties(OWLOntology ontology)

Description copied from interface: OWLAnnotationProperty

Gets the annotation properties which are asserted to be sub-properties of this annotation property in the specified ontology.

Specified by:

getSubProperties in interface OWLAnnotationProperty

Parameters:

ontology - The ontology to be examined for SubAnnotationPropertyOf axioms.

Returns:

A set of annotation properties such that for each property p in the set, it is the case that ontology contains an SubAnnotationPropertyOf(p, this) axiom where this refers to this annotation property.

getSubProperties

public Set<OWLAnnotationProperty> getSubProperties(OWLOntology ontology,
                                          boolean includeImportsClosure)

Description copied from interface: OWLAnnotationProperty

Gets the annotation properties which are asserted to be sub-properties of this annotation property in the specified ontology and potentially its imports closure.

Specified by:

getSubProperties in interface OWLAnnotationProperty

Parameters:

ontology - The ontology to be examined for SubAnnotationPropertyOf axioms.

includeImportsClosure - if true then the imports closure of this ontology is searched for SubAnnotationPropertyOf axioms that assert this property is the super property of some other annotation property. If false then only ontology is searched.

Returns:

If includeImportsClosure is true, a set of annotation properties such that for each property p in the set, it is the case that at least one ontology in the imports closure contains a SubAnnotationPropertyOf(p, this) axiom where this refers to this annotation property. If includeImportsClosure is false, a set of annotation properties such that for each property p in the set, it is the case that ontology contains a SubAnnotationPropertyOf(p, this) axiom where this refers to this annotation property.

getSubProperties

public Set<OWLAnnotationProperty> getSubProperties(Set<OWLOntology> ontologies)

Description copied from interface: OWLAnnotationProperty

Gets the annotation properties which are asserted to be sub-properties of this annotation property in the specified set of ontologies.

Specified by:

getSubProperties in interface OWLAnnotationProperty

Parameters:

ontologies - The set of ontologies to be examined for SubAnnotationPropertyOf axioms.

Returns:

A set of annotation properties such that for each property p in the set, it is the case that at least one ontology in ontologies contains a SubAnnotationPropertyOf(p, this) axiom where this refers to this annotation property.

getSuperProperties

public Set<OWLAnnotationProperty> getSuperProperties(OWLOntology ontology)

Description copied from interface: OWLAnnotationProperty

Gets the annotation properties which are asserted to be super-properties of this annotation property in the specified ontology.

Specified by:

getSuperProperties in interface OWLAnnotationProperty

Parameters:

ontology - The ontology to be examined for SubAnnotationPropertyOf axioms.

Returns:

A set of annotation properties such that for each property p in the set, it is the case that ontology contains an SubAnnotationPropertyOf(this, p) axiom where this refers to this annotation property.

getSuperProperties

public Set<OWLAnnotationProperty> getSuperProperties(OWLOntology ontology,
                                            boolean includeImportsClosure)

Description copied from interface: OWLAnnotationProperty

Gets the annotation properties which are asserted to be super-properties of this annotation property in the specified ontology and potentially its imports closure.

Specified by:

getSuperProperties in interface OWLAnnotationProperty

Parameters:

ontology - The ontology to be examined for SubAnnotationPropertyOf axioms.

includeImportsClosure - if true then the imports closure of this ontology is searched for SubAnnotationPropertyOf axioms that assert this property is the super property of some other annotation property. If false then only ontology is searched.

Returns:

If includeImportsClosure is true, a set of annotation properties such that for each property p in the set, it is the case that at least one ontology in the imports closure contains a SuperAnnotationPropertyOf(this, p) axiom where this refers to this annotation property. If includeImportsClosure is false, a set of annotation properties such that for each property p in the set, it is the case that ontology contains a SuperAnnotationPropertyOf(this, p) axiom where this refers to this annotation property.

getSuperProperties

public Set<OWLAnnotationProperty> getSuperProperties(Set<OWLOntology> ontologies)

Description copied from interface: OWLAnnotationProperty

Gets the annotation properties which are asserted to be super-properties of this annotation property in the specified set of ontologies.

Specified by:

getSuperProperties in interface OWLAnnotationProperty

Parameters:

ontologies - The set of ontologies to be examined for SubAnnotationPropertyOf axioms.

Returns:

A set of annotation properties such that for each property p in the set, it is the case that at least one ontology in ontologies contains a SubAnnotationPropertyOf(this, p) axiom where this refers to this annotation property.

equals

public boolean equals(Object obj)

Overrides:

equals in class OWLObjectImpl