Module org.apache.jena.ontapi

Package org.apache.jena.ontapi.model

Interface OntEntity

All Superinterfaces:

org.apache.jena.graph.FrontsNode, OntObject, org.apache.jena.rdf.model.RDFNode, org.apache.jena.rdf.model.Resource

All Known Subinterfaces:

OntAnnotationProperty, OntClass.Named, OntDataProperty, OntDataRange.Named, OntIndividual.Named, OntNamedProperty<P>, OntObjectProperty.Named

All Known Implementing Classes:

OntAnnotationPropertyImpl, OntDataPropertyImpl, OntIndividualImpl.NamedImpl, OntNamedDataRangeImpl, OntObjectPropertyImpl.NamedImpl, OntSimpleClassImpl.NamedImpl, OntSimpleClassImpl.RLNamedImpl, OntSimplePropertyImpl

public interface OntEntity
extends OntObject

The base interface for OWL entities, which are always URI-Resource. In OWL2 there are 6 types of entities, see below.

See Also:

• OntClass.Named
• OntDataRange.Named
• OntIndividual.Named
• OntAnnotationProperty
• OntObjectProperty.Named
• OntDataProperty

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<Class<? extends OntEntity>>	TYPES

Method Summary

Modifier and Type	Method	Description
default <X extends org.apache.jena.rdf.model.RDFNode> X	getAs(Class<X> type)	Safely converts this RDF resource to the given type interface, if it is possible.
OntModel	getModel()	Returns the ontology model associated with this resource.
boolean	isBuiltIn()	Determines if this is a builtin entity.
boolean	isLocal()	Determines if this Ontology Resource is locally defined.
static org.apache.jena.util.iterator.ExtendedIterator<Class<? extends OntEntity>>	listEntityTypes()	Lists all OWL entity types.

Methods inherited from interface org.apache.jena.graph.FrontsNode

asNode

Methods inherited from interface org.apache.jena.ontapi.model.OntObject

addAnnotation, addAnnotation, addAnnotation, addComment, addComment, addLabel, addLabel, addStatement, annotate, annotate, annotations, annotationValues, annotationValues, clearAnnotations, content, getComment, getComment, getLabel, getLabel, getMainStatement, getRequiredProperty, hasType, objects, objects, objectType, remove, spec, statement, statement, statements, statements, types

Methods inherited from interface org.apache.jena.rdf.model.RDFNode

as, asLiteral, asResource, asStatementTerm, canAs, isAnon, isLiteral, isResource, isStatementTerm, isURIResource, visitWith

Methods inherited from interface org.apache.jena.rdf.model.Resource

abort, addLiteral, addLiteral, addLiteral, addLiteral, addLiteral, addLiteral, addLiteral, addProperty, addProperty, addProperty, addProperty, begin, commit, equals, getId, getLocalName, getNameSpace, getProperty, getProperty, getPropertyResourceValue, getRequiredProperty, getURI, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasProperty, hasProperty, hasProperty, hasProperty, hasURI, inModel, listProperties, listProperties, listProperties, removeAll, removeProperties, toString

Field Details

TYPES

static final Set<Class<? extends OntEntity>> TYPES

Method Details

listEntityTypes

static org.apache.jena.util.iterator.ExtendedIterator<Class<? extends OntEntity>> listEntityTypes()

Lists all OWL entity types.

Returns:

an ExtendedIterator of OWL entity Class-types

isBuiltIn

boolean isBuiltIn()

Determines if this is a builtin entity. In a standard (default) OWL2 vocabulary an entity is builtin if it is:

• a class and its IRI is either owl:Thing or owl:Nothing
• an object property and its IRI is either owl:topObjectProperty or owl:bottomObjectProperty
• a data property and its IRI is either owl:topDataProperty or owl:bottomDataProperty
• a datatype and its IRI is either rdfs:Literal, or rdf:PlainLiteral, or it is from the OWL 2 datatype map
• an annotation property and its IRI is one of the following:
  • rdfs:label
  • rdfs:comment
  • rdfs:seeAlso
  • rdfs:isDefinedBy
  • owl:deprecated
  • owl:versionInfo
  • owl:priorVersion
  • owl:backwardCompatibleWith
  • owl:incompatibleWith

Note: all the listed above IRIs refer to the default Builtins Vocabulary. A model with different Builtins vocabulary will naturally have a different Set of builtin IRIs, and this method will return a different result.

Returns:

true if it is a built-in entity

See Also:

• OWL2
• OntPersonality.Builtins

getModel

OntModel getModel()

Returns the ontology model associated with this resource. If the Resource was not created by a Model, the result may be null.

Specified by:

getModel in interface org.apache.jena.rdf.model.RDFNode

Returns:

OntModel

isLocal

boolean isLocal()

Determines if this Ontology Resource is locally defined. This means that the resource definition (i.e., a the root statement) belongs to the base ontology graph. If the ontology contains subgraphs (which should match owl:imports in OWL) and the resource is defined in one of them, than this method called from top-level interface will return false.

Returns:

true if this resource is local to the base model graph.

getAs

default <X extends org.apache.jena.rdf.model.RDFNode>
X getAs(Class<X> type)

Safely converts this RDF resource to the given type interface, if it is possible. Otherwise, returns null. A calling of this method is effectively equivalent to the expression this.canAs(type) ? this.as(type) : null.

Type Parameters:

X - any subtype of RDFNode

Parameters:

type - a Class-type of the desired RDF view (interface)

Returns:

an instance of the type X or null

See Also:

• RDFNode.as(Class)
• RDFNode.canAs(Class)