Module org.apache.jena.ontapi

Package org.apache.jena.ontapi.model

Interface OntDataRange

All Superinterfaces:

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

All Known Subinterfaces:

OntDataRange.Combination<N>, OntDataRange.ComplementOf, OntDataRange.IntersectionOf, OntDataRange.Named, OntDataRange.OneOf, OntDataRange.Restriction, OntDataRange.UnionOf

All Known Implementing Classes:

OntDataRangeImpl, OntDataRangeImpl.ComplementOfImpl, OntDataRangeImpl.IntersectionOfImpl, OntDataRangeImpl.OneOfImpl, OntDataRangeImpl.RestrictionImpl, OntDataRangeImpl.UnionOfImpl, OntNamedDataRangeImpl

public interface OntDataRange
extends OntObject

A base abstraction for Ontology Data Range Expressions (both named and anonymous).

See Also:

• - a named data range (i.e. OWL Datatype)
• 2.4 Data Ranges
• 7 Data Ranges

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OntDataRange.Combination<N extends org.apache.jena.rdf.model.RDFNode>	An abstract datarange that unites DataRanges consisting of multiple components.
static interface	OntDataRange.ComplementOf
static interface	OntDataRange.IntersectionOf
static interface	OntDataRange.Named	Interface encapsulating an Ontology Datatype, OWL Entity, a named data range expression.
static interface	OntDataRange.OneOf
static interface	OntDataRange.Restriction
static interface	OntDataRange.UnionOf

Method Summary

Modifier and Type	Method	Description
default int	arity()	Returns a data range arity.
default OntDataRange.Named	asNamed()
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	isLocal()	Determines if this Ontology Resource is locally defined.

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, canAs, isAnon, isLiteral, isResource, isStmtResource, 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, getStmtTerm, getURI, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasLiteral, hasProperty, hasProperty, hasProperty, hasProperty, hasURI, inModel, listProperties, listProperties, listProperties, removeAll, removeProperties, toString

Method Details

asNamed

default OntDataRange.Named asNamed()

arity

default int arity()

Returns a data range arity. OWL2 spec says:

This specification currently does not define data ranges of arity more than one.

So n-ary data ranges are not supported and, therefore, the method always returns 1.

Returns:

int, positive number

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)