org.semanticweb.owlapi.model

Interface OWLAnnotation

All Superinterfaces:

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

All Known Implementing Classes:

OWLAnnotationImpl

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

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.

Since:

2.0.0

Author:

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

Method Summary

Modifier and Type	Method and Description
void	accept(OWLAnnotationObjectVisitor visitor)
<O> O	accept(OWLAnnotationObjectVisitorEx<O> visitor)
default OWLAnnotationValue	annotationValue()
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, 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.HasAnnotationValue

anonymousIndividualValue, ifAnonymousIndividual, ifAnonymousIndividualOrElse, ifIri, ifIriOrElse, ifLiteral, ifLiteralOrElse, ifValue, iriValue, literalValue, map, map, mapAnonymousIndividual, mapAnonymousIndividualOrElse, mapAnonymousIndividualOrElseGet, mapIri, mapIriOrElse, mapIriOrElseGet, mapLiteral, mapLiteralOrElse, mapLiteralOrElseGet, mapValue, when

Method Detail

getProperty

@Nonnull
OWLAnnotationProperty getProperty()

Gets the property that this annotation acts along

Specified by:

getProperty in interface HasProperty<OWLAnnotationProperty>

Returns:

The annotation property

getValue

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

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

@Nonnull
OWLAnnotation getAnnotatedAnnotation(@Nonnull
                                              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(@Nonnull
            OWLAnnotationObjectVisitor visitor)

Parameters:

visitor - visitor to accept

accept

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

Type Parameters:

O - visitor return type

Parameters:

visitor - visitor to accept

Returns:

visitor value

annotationValue

default OWLAnnotationValue annotationValue()

Specified by:

annotationValue in interface HasAnnotationValue

Returns:

the annotation value itself; this method allows OWLAnnotationAssertionAxiom and OWLAnnotation to use the default methods rather than replicate the methods. For OWLAnnotationValue instances, the value returned is the object itself.