org.semanticweb.owlapi.model

Interface OWLEntity

All Superinterfaces:

Comparable<OWLObject>, HasAnnotationPropertiesInSignature, HasAnonymousIndividuals, HasClassesInSignature, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasIndividualsInSignature, HasIRI, HasObjectPropertiesInSignature, HasSignature, IsAnonymous, OWLNamedObject, OWLObject, OWLPrimitive, Serializable

All Known Subinterfaces:

OWLAnnotationProperty, OWLClass, OWLDataProperty, OWLDatatype, OWLLogicalEntity, OWLNamedIndividual, OWLObjectProperty, OWLProperty

All Known Implementing Classes:

OWL2DatatypeImpl, OWLAnnotationPropertyImpl, OWLClassImpl, OWLDataPropertyImpl, OWLDatatypeImpl, OWLNamedIndividualImpl, OWLObjectPropertyImpl

public interface OWLEntity
extends OWLObject, OWLNamedObject, OWLPrimitive

Represents Entities in the OWL 2 Specification.

Since:

2.0.0

Author:

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

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.

Method Summary

Modifier and Type	Method and Description
void	accept(OWLEntityVisitor visitor)
<O> O	accept(OWLEntityVisitorEx<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() A convenience method that obtains this entity as an OWLObjectProperty (in order to avoid explicit casting).
EntityType<?>	getEntityType() Gets the entity type for this entity
default boolean	isAnonymous()
boolean	isBuiltIn() Determines if this entity is a built in entity.
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	isOWLObjectProperty() Gets the value of the property oWLObjectProperty.
boolean	isType(EntityType<?> entityType) Tests to see if this entity is of the specified type
String	toStringID()

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

accept, accept, getIRI

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

isNamed

Property Detail

isOWLObject

boolean isOWLObjectProperty

Gets the value of the property oWLObjectProperty.

asOWLObject

@Nonnull
OWLObjectProperty asOWLObjectProperty

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

isOWLData

boolean isOWLDataProperty

Gets the value of the property oWLDataProperty.

asOWLData

@Nonnull
OWLDataProperty asOWLDataProperty

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

isOWLAnnotation

boolean isOWLAnnotationProperty

Gets the value of the property oWLAnnotationProperty.

asOWLAnnotation

@Nonnull
OWLAnnotationProperty asOWLAnnotationProperty

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

Method Detail

getEntityType

@Nonnull
EntityType<?> getEntityType()

Gets the entity type for this entity

Returns:

The entity type

isType

boolean isType(@Nonnull
               EntityType<?> entityType)

Tests to see if this entity is of the specified type

Parameters:

entityType - The entity type

Returns:

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

isBuiltIn

boolean isBuiltIn()

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

Returns:

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

isOWLClass

boolean isOWLClass()

A convenience method that determines if this entity is an OWLClass

Returns:

true if this entity is an OWLClass, otherwise false

asOWLClass

@Nonnull
OWLClass asOWLClass()

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

Returns:

The entity as an OWLClass.

Throws:

OWLRuntimeException - if this entity is not an OWLClass (check with isOWLClass() first).

isOWLObjectProperty

boolean isOWLObjectProperty()

Gets the value of the property oWLObjectProperty.

asOWLObjectProperty

@Nonnull
OWLObjectProperty asOWLObjectProperty()

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

isOWLDataProperty

boolean isOWLDataProperty()

Gets the value of the property oWLDataProperty.

asOWLDataProperty

@Nonnull
OWLDataProperty asOWLDataProperty()

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

isOWLNamedIndividual

boolean isOWLNamedIndividual()

A convenience method that determines if this entity is an OWLNamedIndividual

Returns:

true if this entity is an OWLNamedIndividual, otherwise false

asOWLNamedIndividual

@Nonnull
OWLNamedIndividual asOWLNamedIndividual()

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

Returns:

The entity as an OWLNamedIndividual.

Throws:

OWLRuntimeException - if this entity is not an OWLIndividual (check with the isOWLIndividual method first).

isOWLDatatype

boolean isOWLDatatype()

A convenience method that determines if this entity is an OWLDatatype

Returns:

true if this entity is an OWLDatatype, otherwise false

asOWLDatatype

@Nonnull
OWLDatatype asOWLDatatype()

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

Returns:

The entity as an OWLDatatype.

Throws:

OWLRuntimeException - if this entity is not an OWLDatatype (check with the isOWLDatatype method first).

isOWLAnnotationProperty

boolean isOWLAnnotationProperty()

Gets the value of the property oWLAnnotationProperty.

asOWLAnnotationProperty

@Nonnull
OWLAnnotationProperty asOWLAnnotationProperty()

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

toStringID

@Nonnull
String toStringID()

Returns:

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

accept

void accept(@Nonnull
            OWLEntityVisitor visitor)

Parameters:

visitor - visitor

accept

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

Type Parameters:

O - visitor return type

Parameters:

visitor - visitor

Returns:

visitor return value

isAnonymous

default boolean isAnonymous()

Specified by:

isAnonymous in interface IsAnonymous

Returns:

true if this object is anonymous, false otherwise. For example, class expressions are anonymous while class entities are not (they have an IRI); OWLNamedIndividual instances are named, OWLAnonymousIndividual instances are anonymous. An ontology is anonymous if it does not have an ontology IRI. In this case, getOntologyID().getOntologyIRI() will return an empty optional.