org.semanticweb.owlapi.model

Interface OWLEntity

All Superinterfaces:

AsOWLAnnotationProperty, AsOWLClass, AsOWLDataProperty, AsOWLDatatype, AsOWLNamedIndividual, AsOWLObjectProperty, Comparable<OWLObject>, HasAnnotationPropertiesInSignature, HasAnonymousIndividuals, HasClassesInSignature, HasComponents, HasContainsEntityInSignature, HasDataPropertiesInSignature, HasDatatypesInSignature, HasHashIndex, HasIndex, 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, AsOWLClass, AsOWLDataProperty, AsOWLDatatype, AsOWLAnnotationProperty, AsOWLNamedIndividual, AsOWLObjectProperty

Represents Entities in the OWL 2 Specification.

Since:

2.0.0

Author:

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

Property Summary

Properties inherited from interface org.semanticweb.owlapi.model.AsOWLDataProperty

asOWLDataProperty, isOWLDataProperty

Properties inherited from interface org.semanticweb.owlapi.model.AsOWLAnnotationProperty

asOWLAnnotationProperty, isOWLAnnotationProperty

Properties inherited from interface org.semanticweb.owlapi.model.AsOWLObjectProperty

asOWLObjectProperty, isOWLObjectProperty

Method Summary

Modifier and Type	Method and Description
void	accept(OWLEntityVisitor visitor)
<O> O	accept(OWLEntityVisitorEx<O> visitor)
EntityType<?>	getEntityType() Gets the entity type for this entity.
default boolean	isAnonymous()
default boolean	isBuiltIn() Determines if this entity is a built in entity.
default 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

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

getIRI

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

accept, accept, getNestedClassExpressions, hashIteration, hasSharedStructure, initHashCode, isAnonymousExpression, isAxiom, isBottomEntity, isIndividual, isIRI, isOntology, isTopEntity, nestedClassExpressions

Methods inherited from interface java.lang.Comparable

compareTo

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

getSignature, signature, unsortedSignature

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

containsEntityInSignature

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

anonymousIndividuals, getAnonymousIndividuals

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

classesInSignature, getClassesInSignature

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

getObjectPropertiesInSignature, objectPropertiesInSignature

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

dataPropertiesInSignature, getDataPropertiesInSignature

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

getIndividualsInSignature, individualsInSignature

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

datatypesInSignature, getDatatypesInSignature

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

annotationPropertiesInSignature, getAnnotationPropertiesInSignature

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

typeIndex

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

hashIndex

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

components, componentsAnnotationsFirst, componentsWithoutAnnotations

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

isNamed

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

asOWLClass, isOWLClass

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

asOWLDataProperty, isOWLDataProperty

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

asOWLDatatype, isOWLDatatype

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

asOWLAnnotationProperty, isOWLAnnotationProperty

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

asOWLNamedIndividual, isOWLNamedIndividual

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

asOWLObjectProperty, isOWLObjectProperty

Method Detail

getEntityType

EntityType<?> getEntityType()

Gets the entity type for this entity.

Returns:

The entity type

isType

default boolean isType(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

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

toStringID

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

Parameters:

visitor - visitor

accept

<O> O accept(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.