org.semanticweb.owlapi.model

Interface OWLAnnotation

All Superinterfaces:

Comparable<OWLObject>, HasAnnotations, HasAnonymousIndividuals, HasClassesInSignature, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasIndividualsInSignature, HasObjectPropertiesInSignature, HasProperty<OWLAnnotationProperty>, HasSignature, OWLObject, Serializable

public interface OWLAnnotation
extends OWLObject, HasAnnotations, HasProperty<OWLAnnotationProperty>

Annotations are used in the various types of annotation axioms, which bind annotations to their subjects (i.e. axioms or declarations).
An annotation is equal to another annotation if both objects have equal annotation URIs and have equal annotation values.

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group, Date: 18-Dec-2006

Method Summary

Modifier and Type	Method and Description
void	accept(OWLAnnotationObjectVisitor visitor)
<O> O	accept(OWLAnnotationObjectVisitorEx<O> visitor)
OWLAnnotation	getAnnotatedAnnotation(Set<OWLAnnotation> annotations) Gets an OWLAnnotation which is a copy of this annotation but which has the specified annotations.
Set<OWLAnnotation>	getAnnotations() Gets the annotations on this annotation
OWLAnnotationProperty	getProperty() Gets the property that this annotation acts along
OWLAnnotationValue	getValue() Gets the annotation value.
boolean	isDeprecatedIRIAnnotation() Determines if this annotation is an annotation used to deprecate an IRI.

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

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

Methods inherited from interface java.lang.Comparable

compareTo

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

containsEntityInSignature

Method Detail

getProperty

OWLAnnotationProperty getProperty()

Gets the property that this annotation acts along

Specified by:

getProperty in interface HasProperty<OWLAnnotationProperty>

Returns:

The annotation property

getValue

OWLAnnotationValue getValue()

Gets the annotation value. The type of value will depend upon the type of the annotation e.g. whether the annotation is an OWLLiteral, an IRI or an OWLAnonymousIndividual.

Returns:

The annotation value.

See Also:

OWLAnnotationValueVisitor, OWLAnnotationValueVisitorEx

isDeprecatedIRIAnnotation

boolean isDeprecatedIRIAnnotation()

Determines if this annotation is an annotation used to deprecate an IRI. This is the case if the annotation property has an IRI of owl:deprecated and the value of the annotation is "true"^^xsd:boolean

Returns:

true if this annotation is an annotation that can be used to deprecate an IRI, otherwise false.

getAnnotations

Set<OWLAnnotation> getAnnotations()

Gets the annotations on this annotation

Specified by:

getAnnotations in interface HasAnnotations

Returns:

A (possibly empty) set of annotations that annotate this annotation

getAnnotatedAnnotation

OWLAnnotation getAnnotatedAnnotation(Set<OWLAnnotation> annotations)

Gets an OWLAnnotation which is a copy of this annotation but which has the specified annotations.

Parameters:

annotations - The annotations

Returns:

A copy of this annotation with the specified annotations annotating it

accept

void accept(OWLAnnotationObjectVisitor visitor)

Parameters:

visitor - visitor to accept

accept

<O> O accept(OWLAnnotationObjectVisitorEx<O> visitor)

Type Parameters:

O - visitor return type

Parameters:

visitor - visitor to accept

Returns:

visitor value