Module org.apache.jena.ontapi

Package org.apache.jena.ontapi.model

Interface OntClass.Named

All Superinterfaces:

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

All Known Implementing Classes:

OntSimpleClassImpl.NamedImpl, OntSimpleClassImpl.RLNamedImpl

Enclosing interface:

OntClass

public static interface OntClass.Named
extends OntEntity, OntClass

An Ontology Class Entity, a named class expression.

See Also:

• 5.1 Classes

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.jena.ontapi.model.OntClass

OntClass.CardinalityRestriction<O extends OntObject,P extends OntRelationalProperty>, OntClass.CollectionOf<O extends OntObject>, OntClass.ComplementOf, OntClass.ComponentRestriction<O extends org.apache.jena.rdf.model.RDFNode,P extends OntRelationalProperty>, OntClass.DataAllValuesFrom, OntClass.DataCardinality, OntClass.DataHasValue, OntClass.DataMaxCardinality, OntClass.DataMinCardinality, OntClass.DataSomeValuesFrom, OntClass.HasSelf, OntClass.IntersectionOf, OntClass.LogicalExpression, OntClass.Named, OntClass.NaryDataAllValuesFrom, OntClass.NaryDataSomeValuesFrom, OntClass.NaryRestriction<O extends OntObject,P extends OntRelationalProperty>, OntClass.ObjectAllValuesFrom, OntClass.ObjectCardinality, OntClass.ObjectHasValue, OntClass.ObjectMaxCardinality, OntClass.ObjectMinCardinality, OntClass.ObjectSomeValuesFrom, OntClass.OneOf, OntClass.Restriction, OntClass.UnaryRestriction<P extends OntRelationalProperty>, OntClass.UnionOf, OntClass.ValueRestriction<O extends org.apache.jena.rdf.model.RDFNode,P extends OntRelationalProperty>

Field Summary

Fields inherited from interface org.apache.jena.ontapi.model.OntEntity

TYPES

Method Summary

Modifier and Type	Method	Description
default OntClass.Named	addComment(String txt)	Creates _:this rdfs:comment "txt"^^xsd:string statement.
default OntClass.Named	addComment(String txt, String lang)	Adds the given localized text annotation with builtin rdfs:comment predicate.
default OntClass.Named	addDisjointClass(OntClass other)	Adds the given class as a disjoint class and returns this class expression instance to allow cascading calls.
default OntClass.Named	addDisjointUnion(Collection<OntClass> classes)
default OntClass.Named	addDisjointUnion(OntClass... classes)
default OntStatement	addDisjointUnionOfStatement(Collection<OntClass> classes)	Creates a disjoint-union section returning its root statement to allow adding annotations.
default OntStatement	addDisjointUnionOfStatement(OntClass... classes)	Creates a DisjointUnion ontology list and returns the statement CN owl:disjointUnionOf ( C1 ... Cn ) to allow the addition of annotations.
default OntClass.Named	addEquivalentClass(OntClass other)	Adds a new equivalent class.
default OntClass.Named	addHasKey(Collection<OntObjectProperty> objectProperties, Collection<OntDataProperty> dataProperties)	Creates an owl:hasKey statement returning this class to allow cascading calls.
default OntClass.Named	addHasKey(OntRelationalProperty... properties)	Creates an owl:hasKey statement returning this class to allow cascading calls.
default OntClass.Named	addLabel(String txt)	Creates _:this rdfs:label "txt"^^xsd:string statement.
default OntClass.Named	addLabel(String txt, String lang)	Adds the given localized text annotation with builtin rdfs:label predicate.
default OntClass.Named	addSubClass(OntClass other)	Adds the given class as a subclass and returns this class expression instance to allow cascading calls.
default OntClass.Named	addSuperClass(OntClass other)	Adds the given class as a superclass and returns this class expression instance to allow cascading calls.
default OntClass.Named	annotate(OntAnnotationProperty predicate, String txt, String lang)	Adds a language-tagged text for this object and the given predicate
default OntClass.Named	annotate(OntAnnotationProperty predicate, org.apache.jena.rdf.model.RDFNode value)	Annotates the object with the given predicate and value.
default OntClass.Named	clearDisjointUnions()	Deletes all DisjointUnion []-lists including their annotations, i.e., all those statements with the predicate owl:disjointUnionOf for which this resource is a subject.
default OntClass.Named	clearHasKeys()	Deletes all HasKey []-list including its annotations, i.e., all those statements with the predicate owl:hasKey for which this resource is a subject.
OntList<OntClass>	createDisjointUnion(Collection<OntClass> classes)	Creates a DisjointUnion as ontology []-list of Class Expressions that is attached to this OWL Class using the predicate owl:disjointUnionOf.
Stream<OntList<OntClass>>	disjointUnions()	Lists all DisjointUnion ontology lists that are attached to this OWL Class on predicate owl:disjointUnionOf.
default Optional<OntList<OntClass>>	findDisjointUnion(org.apache.jena.rdf.model.RDFNode list)	Finds a DisjointUnion logical construction attached to this class by the specified rdf-node in the form of OntList.
default Stream<OntClass>	fromDisjointUnionOf()	Returns all class expressions from the right part of the statement with this class as a subject and owl:disjointUnionOf as a predicate (the triple pattern: CN owl:disjointUnionOf ( C1 ... Cn )).
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.
default OntClass.Named	removeDisjointClass(org.apache.jena.rdf.model.Resource other)	Removes the specified disjoint class resource.
OntClass.Named	removeDisjointUnion(org.apache.jena.rdf.model.Resource list)	Deletes the given DisjointUnion list including its annotations.
default OntClass.Named	removeEquivalentClass(org.apache.jena.rdf.model.Resource other)	Removes the given equivalent class resource including the statement's annotations.
default OntClass.Named	removeSuperClass(org.apache.jena.rdf.model.Resource other)	Removes a superclass relationship for the given resource including all possible annotations.

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

asNode

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

addDisjointWithStatement, addEquivalentClassStatement, addHasKeyStatement, addHasKeyStatement, addSubClassOfStatement, asAssertionClass, asDisjointClass, asEquivalentClass, asNamed, asSubClass, asSuperClass, canAsAssertionClass, canAsDisjointClass, canAsEquivalentClass, canAsSubClass, canAsSuperClass, createHasKey, createIndividual, createIndividual, declaredProperties, declaredProperties, disjointClasses, disjoints, equivalentClasses, findHasKey, fromHasKey, hasDeclaredProperty, hasKeys, hasSubClass, hasSuperClass, individuals, individuals, isDisjoint, isHierarchyRoot, properties, removeHasKey, removeIndividual, removeSubClass, subClass, subClasses, subClasses, superClass, superClasses, superClasses

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

isBuiltIn

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

addAnnotation, addAnnotation, addAnnotation, addStatement, 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

Method Details

disjointUnions

Stream<OntList<OntClass>> disjointUnions()

Lists all DisjointUnion ontology lists that are attached to this OWL Class on predicate owl:disjointUnionOf.

Returns:

Stream of OntLists with parameter-type OntCE

createDisjointUnion

OntList<OntClass> createDisjointUnion(Collection<OntClass> classes)

Creates a DisjointUnion as ontology []-list of Class Expressions that is attached to this OWL Class using the predicate owl:disjointUnionOf. The resulting rdf-list will consist of all the elements of the specified collection in the same order but with exclusion of duplicates. Note: nulls in the collection will cause exception. For additional information about DisjointUnion logical construction see 9.1.4 Disjoint Union of Class Expressions.

Parameters:

classes - Collection (preferably Set) of class expressions

Returns:

OntList of OntClasss

See Also:

• addDisjointUnionOfStatement(OntClass...)
• removeDisjointUnion(Resource)

removeDisjointUnion

OntClass.Named removeDisjointUnion(org.apache.jena.rdf.model.Resource list)

Deletes the given DisjointUnion list including its annotations.

Parameters:

list - Resource can be OntList or RDFList

Returns:

this instance to allow cascading calls

Throws:

OntJenaException - if the list is not found

See Also:

• addDisjointUnion(Collection)
• createDisjointUnion(Collection)
• addDisjointUnionOfStatement(OntClass...)
• createDisjointUnion(Collection)

findDisjointUnion

default Optional<OntList<OntClass>> findDisjointUnion(org.apache.jena.rdf.model.RDFNode list)

Finds a DisjointUnion logical construction attached to this class by the specified rdf-node in the form of OntList.

Parameters:

list - RDFNode

Returns:

Optional around OntList of class expressions

addDisjointUnionOfStatement

default OntStatement addDisjointUnionOfStatement(OntClass... classes)

Creates a DisjointUnion ontology list and returns the statement CN owl:disjointUnionOf ( C1 ... Cn ) to allow the addition of annotations. About RDF Graph annotation specification see, for example, 2.3.1 Axioms that Generate a Main Triple.

Parameters:

classes - Array of class expressions without nulls, duplicates will be discarded and order will be saved

Returns:

OntStatement to allow the subsequent annotations addition

See Also:

• createDisjointUnion(Collection)
• createDisjointUnion(Collection)
• addDisjointUnion(OntClass...)
• addDisjointUnionOfStatement(OntClass...)
• removeDisjointUnion(Resource)

addDisjointUnionOfStatement

default OntStatement addDisjointUnionOfStatement(Collection<OntClass> classes)

Creates a disjoint-union section returning its root statement to allow adding annotations. The triple pattern: CN owl:disjointUnionOf ( C1 ... Cn ).

Parameters:

classes - a collection of class expressions without nulls

Returns:

OntStatement to allow the subsequent annotations addition

See Also:

• createDisjointUnion(Collection)
• 2.3.1 Axioms that Generate a Main Triple
• createDisjointUnion(Collection)
• addDisjointUnion(Collection)
• addDisjointUnionOfStatement(Collection)
• removeDisjointUnion(Resource)

addSuperClass

default OntClass.Named addSuperClass(OntClass other)

Adds the given class as a superclass and returns this class expression instance to allow cascading calls.

Specified by:

addSuperClass in interface OntClass

Parameters:

other - OntClass, not null

Returns:

this instance to allow cascading calls

See Also:

• OntClass.addSubClassOfStatement(OntClass)
• OntClass.removeSuperClass(Resource)

addSubClass

default OntClass.Named addSubClass(OntClass other)

Adds the given class as a subclass and returns this class expression instance to allow cascading calls.

Specified by:

addSubClass in interface OntClass

Parameters:

other - OntClass, not null

Returns:

this instance to allow cascading calls

See Also:

• OntClass.addSuperClass(OntClass)

addEquivalentClass

default OntClass.Named addEquivalentClass(OntClass other)

Adds a new equivalent class.

Specified by:

addEquivalentClass in interface OntClass

Parameters:

other - OntClass, not null

Returns:

this instance to allow cascading calls

See Also:

• OntClass.addEquivalentClassStatement(OntClass)
• OntClass.removeDisjointClass(Resource)

addHasKey

default OntClass.Named addHasKey(Collection<OntObjectProperty> objectProperties,
 Collection<OntDataProperty> dataProperties)

Creates an owl:hasKey statement returning this class to allow cascading calls.

Specified by:

addHasKey in interface OntClass

Parameters:

objectProperties - the collection of OntObjectPropertys

dataProperties - the collection of OntDataPropertys

Returns:

this instance to allow cascading calls

See Also:

• OntClass.addHasKeyStatement(Collection, Collection)
• OntClass.addHasKey(OntRelationalProperty...)

addHasKey

default OntClass.Named addHasKey(OntRelationalProperty... properties)

Creates an owl:hasKey statement returning this class to allow cascading calls.

Specified by:

addHasKey in interface OntClass

Parameters:

properties - Array of OntRelationalPropertys without nulls

Returns:

this instance to allow cascading calls

See Also:

• OntClass.addHasKeyStatement(OntRelationalProperty...)
• OntClass.addHasKey(Collection, Collection)
• OntClass.removeHasKey(Resource)
• OntClass.clearHasKeys()

addDisjointUnion

default OntClass.Named addDisjointUnion(Collection<OntClass> classes)

Parameters:

classes - a collection of class expressions without nulls

Returns:

this instance to allow cascading calls

addDisjointUnion

default OntClass.Named addDisjointUnion(OntClass... classes)

Parameters:

classes - Array of class expressions without nulls, duplicates will be discarded and order will be saved

Returns:

this instance to allow cascading calls

addDisjointClass

default OntClass.Named addDisjointClass(OntClass other)

Adds the given class as a disjoint class and returns this class expression instance to allow cascading calls.

Specified by:

addDisjointClass in interface OntClass

Parameters:

other - OntClass, not null

Returns:

this instance to allow cascading calls

See Also:

• OntClass.addDisjointWithStatement(OntClass)
• OntClass.removeDisjointClass(Resource)

removeSuperClass

default OntClass.Named removeSuperClass(org.apache.jena.rdf.model.Resource other)

Removes a superclass relationship for the given resource including all possible annotations. No-op in case no match found. Removes all rdfs:subClassOf statements with all their annotations in case null is specified.

Specified by:

removeSuperClass in interface OntClass

Parameters:

other - Resource or null to remove all rdfs:subClassOf statements

Returns:

this instance to allow cascading calls

See Also:

• OntClass.addSubClassOfStatement(OntClass)
• OntClass.addSuperClass(OntClass)

removeDisjointClass

default OntClass.Named removeDisjointClass(org.apache.jena.rdf.model.Resource other)

Removes the specified disjoint class resource. No-op in case no match found. Removes all owl:disjointWith statements with all their annotations in case null is specified.

Specified by:

removeDisjointClass in interface OntClass

Parameters:

other - Resource, or null to remove all disjoint classes

Returns:

this instance to allow cascading calls

See Also:

• OntClass.addDisjointWithStatement(OntClass)
• OntClass.addDisjointClass(OntClass)
• OntDisjoint.Classes

removeEquivalentClass

default OntClass.Named removeEquivalentClass(org.apache.jena.rdf.model.Resource other)

Removes the given equivalent class resource including the statement's annotations. No-op in case no match found. Removes all owl:equivalentClass statements with all their annotations in case null is specified.

Specified by:

removeEquivalentClass in interface OntClass

Parameters:

other - Resource, or null to remove all equivalent classes

Returns:

this instance to allow cascading calls

See Also:

• OntClass.addEquivalentClassStatement(OntClass)
• OntClass.addEquivalentClass(OntClass)
• OntDataRange.Named.removeEquivalentClass(Resource)

clearHasKeys

default OntClass.Named clearHasKeys()

Deletes all HasKey []-list including its annotations, i.e., all those statements with the predicate owl:hasKey for which this resource is a subject.

Specified by:

clearHasKeys in interface OntClass

Returns:

this instance to allow cascading calls

clearDisjointUnions

default OntClass.Named clearDisjointUnions()

Deletes all DisjointUnion []-lists including their annotations, i.e., all those statements with the predicate owl:disjointUnionOf for which this resource is a subject.

Returns:

this instance to allow cascading calls

See Also:

• removeDisjointUnion(Resource)

fromDisjointUnionOf

default Stream<OntClass> fromDisjointUnionOf()

Returns all class expressions from the right part of the statement with this class as a subject and owl:disjointUnionOf as a predicate (the triple pattern: CN owl:disjointUnionOf ( C1 ... Cn )). If there are several []-lists in the model that satisfy these conditions, all their content will be merged into the one distinct stream.

Returns:

distinct stream of class expressionss

See Also:

• disjointUnions()

addComment

default OntClass.Named addComment(String txt)

Creates _:this rdfs:comment "txt"^^xsd:string statement.

Specified by:

addComment in interface OntObject

Parameters:

txt - String, not null

Returns:

this object to allow cascading calls

See Also:

• OntModel.getRDFSComment()

addComment

default OntClass.Named addComment(String txt,
 String lang)

Adds the given localized text annotation with builtin rdfs:comment predicate.

Specified by:

addComment in interface OntObject

Parameters:

txt - String, the literal lexical form, not null

lang - String, the language tag, nullable

Returns:

this object to allow cascading calls

See Also:

• OntModel.getRDFSComment()

addLabel

default OntClass.Named addLabel(String txt)

Creates _:this rdfs:label "txt"^^xsd:string statement.

Specified by:

addLabel in interface OntObject

Parameters:

txt - String, the literal lexical form, not null

Returns:

this object to allow cascading calls

See Also:

• OntModel.getRDFSLabel()

addLabel

default OntClass.Named addLabel(String txt,
 String lang)

Adds the given localized text annotation with builtin rdfs:label predicate.

Specified by:

addLabel in interface OntObject

Parameters:

txt - String, the literal lexical form, not null

lang - String, the language tag, nullable

Returns:

this object to allow cascading calls

See Also:

• OntModel.getRDFSLabel()

annotate

default OntClass.Named annotate(OntAnnotationProperty predicate,
 String txt,
 String lang)

Adds a language-tagged text for this object and the given predicate

Specified by:

annotate in interface OntObject

Parameters:

predicate - OntAnnotationProperty - named annotation property, not null

txt - String, the literal lexical form, cannot be null

lang - String, the language tag, can be null

Returns:

this object to allow cascading calls

annotate

default OntClass.Named annotate(OntAnnotationProperty predicate,
 org.apache.jena.rdf.model.RDFNode value)

Annotates the object with the given predicate and value.

Specified by:

annotate in interface OntObject

Parameters:

predicate - OntAnnotationProperty - named annotation property, not null

value - RDFNode - the value: uri-resource, literal or anonymous individual, not null

Returns:

this object to allow cascading calls

See Also:

• OntObject.addAnnotation(OntAnnotationProperty, RDFNode)

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)