Module org.apache.jena.ontapi

Package org.apache.jena.ontapi.model

Interface OntIndividual

All Superinterfaces:

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

All Known Subinterfaces:

OntIndividual.Anonymous, OntIndividual.Named

All Known Implementing Classes:

OntIndividualImpl, OntIndividualImpl.AnonymousImpl, OntIndividualImpl.NamedImpl

public interface OntIndividual
extends OntObject

Interface for named and anonymous individuals.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OntIndividual.Anonymous	An interface for Anonymous Individuals.
static interface	OntIndividual.Named	An interface for Named Individual which is an Entity OntEntity.

Method Summary

Modifier and Type	Method	Description
default OntIndividual	addAssertion(OntAnnotationProperty property, org.apache.jena.rdf.model.RDFNode value)	Adds annotation assertion AnnotationAssertion(A s t).
default OntIndividual	addAssertion(OntDataProperty property, org.apache.jena.rdf.model.Literal value)	Adds a positive data property assertion a R v.
default OntIndividual	addAssertion(OntObjectProperty.Named property, OntIndividual value)	Adds a positive object property assertion a1 PN a2.
default OntStatement	addClassAssertion(OntClass clazz)	Creates and returns a class-assertion statement a rdf:type C, where a is this individual.
default OntIndividual	addComment(String txt)	Creates _:this rdfs:comment "txt"^^xsd:string statement.
default OntIndividual	addComment(String txt, String lang)	Adds the given localized text annotation with builtin rdfs:comment predicate.
default OntStatement	addDifferentFromStatement(OntIndividual other)	Adds a owl:differentFrom individual statement.
default OntIndividual	addDifferentIndividual(OntIndividual other)	Adds a owl:differentFrom individual statement and returns this object itself to allow cascading calls.
default OntIndividual	addLabel(String txt)	Creates _:this rdfs:label "txt"^^xsd:string statement.
default OntIndividual	addLabel(String txt, String lang)	Adds the given localized text annotation with builtin rdfs:label predicate.
default OntIndividual	addNegativeAssertion(OntDataProperty property, org.apache.jena.rdf.model.Literal value)	Adds a negative data property assertion.
default OntIndividual	addNegativeAssertion(OntObjectProperty property, OntIndividual value)	Adds a negative object property assertion.
default OntIndividual	addProperty(OntNamedProperty property, org.apache.jena.rdf.model.RDFNode value)	Adds a property assertion statement.
default OntStatement	addSameAsStatement(OntIndividual other)	Adds a same individual reference.
default OntIndividual	addSameIndividual(OntIndividual other)	Adds a owl:sameAs individual statement and returns this object itself to allow cascading calls.
default OntIndividual	annotate(OntAnnotationProperty predicate, String txt, String lang)	Adds a language-tagged text for this object and the given predicate
default OntIndividual	annotate(OntAnnotationProperty predicate, org.apache.jena.rdf.model.RDFNode value)	Annotates the object with the given predicate and value.
default OntIndividual.Named	asNamed()
default OntIndividual	attachClass(OntClass clazz)	Adds a type (class expression) to this individual.
default Stream<OntClass>	classes()	Returns all class types (direct and indirect).
Stream<OntClass>	classes(boolean direct)	Answers a Stream over the class expressions to which this individual belongs, including super-classes if the flag direct is false.
Stream<OntStatement>	content()	Lists the content of the object, i.e., all characteristic statements (see OntObject.spec()), plus all additional statements in which this object is the subject, minus those of them whose predicate is an annotation property (annotations are not included).
OntIndividual	detachClass(org.apache.jena.rdf.model.Resource clazz)	Removes a class assertion statement for the given class.
default Stream<OntIndividual>	differentIndividuals()	Lists all different individuals.
default Stream<OntDisjoint.Individuals>	disjoints()	Lists all OntDisjoint sections where this individual is a member.
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.
default boolean	hasOntClass(OntClass clazz, boolean direct)	Answers true if the given class is in the class-type closure.
boolean	isLocal()	Determines if this Ontology Resource is locally defined.
default Stream<OntNegativeAssertion>	negativeAssertions()	Lists all negative property assertions for this individual.
default Stream<OntNegativeAssertion>	negativeAssertions(OntRelationalProperty property)	Lists all negative property assertions for this individual and the given property.
default Optional<OntClass>	ontClass()	Answers a class to which this individual belongs, If there is more than one such class, an arbitrary selection is made.
default Stream<OntStatement>	positiveAssertions()	Lists all positive assertions for this individual.
default Stream<OntStatement>	positiveAssertions(OntNamedProperty predicate)	Lists all positive property assertions for this individual and the given predicate.
default OntIndividual	removeAssertion(OntNamedProperty property, org.apache.jena.rdf.model.RDFNode value)	Removes a positive property assertion including its annotation.
default OntIndividual	removeDifferentIndividual(org.apache.jena.rdf.model.Resource other)	Removes a different individual statement for this and specified individuals, including the statement's annotation.
default OntIndividual	removeNegativeAssertion(OntRelationalProperty property, org.apache.jena.rdf.model.RDFNode value)	Removes a negative property assertion including its annotation.
default OntIndividual	removeSameIndividual(org.apache.jena.rdf.model.Resource other)	Removes a same individual statement for this and specified individuals, including the statement's annotation.
default Stream<OntIndividual>	sameIndividuals()	Lists all same individuals.

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

asNode

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

addAnnotation, addAnnotation, addAnnotation, addStatement, annotations, annotationValues, annotationValues, clearAnnotations, 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

detachClass

OntIndividual detachClass(org.apache.jena.rdf.model.Resource clazz)

Removes a class assertion statement for the given class. Like others methods #remove..(..) (see OntObject.remove(Property, RDFNode)), this operation does nothing in case no match found and in case null is specified it removes all class assertion statements including all their annotations. To delete the individual with its content the method OntModel.removeOntObject(OntObject) can be used.

Parameters:

clazz - OntClass or null to remove all class assertions

Returns:

this instance to allow cascading calls

See Also:

• attachClass(OntClass)
• addClassAssertion(OntClass)
• OntModel.removeOntObject(OntObject)

classes

Stream<OntClass> classes(boolean direct)

Answers a Stream over the class expressions to which this individual belongs, including super-classes if the flag direct is false. If the flag direct is true, then only direct types are returned, and the method is effectively equivalent to the method classes(). See also OntClass.superClasses(boolean).

Parameters:

direct - if true, only answers those OntClasss that are direct types of this individual, not the superclasses of the class etc

Returns:

distinct Stream of class expressions

See Also:

• classes()
• OntClass.superClasses(boolean)

content

Stream<OntStatement> content()

Lists the content of the object, i.e., all characteristic statements (see OntObject.spec()), plus all additional statements in which this object is the subject, minus those of them whose predicate is an annotation property (annotations are not included). For individuals, content also includes negative property assertion statements.

Specified by:

content in interface OntObject

Returns:

Stream of content OntStatements

See Also:

• OntObject.spec()

asNamed

default OntIndividual.Named asNamed()

classes

default Stream<OntClass> classes()

Returns all class types (direct and indirect).

Returns:

Stream of OntClasss

hasOntClass

default boolean hasOntClass(OntClass clazz,
 boolean direct)

Answers true if the given class is in the class-type closure.

Parameters:

clazz - OntClass to test

direct - see classes(boolean)

Returns:

true if the specified class found

ontClass

default Optional<OntClass> ontClass()

Answers a class to which this individual belongs, If there is more than one such class, an arbitrary selection is made.

Returns:

Optional wrapping OntClass

sameIndividuals

default Stream<OntIndividual> sameIndividuals()

Lists all same individuals. The pattern to search for is ai owl:sameAs aj, where ai is this individual.

Returns:

Stream of OntIndividuals

disjoints

default Stream<OntDisjoint.Individuals> disjoints()

Lists all OntDisjoint sections where this individual is a member.

Returns:

a Stream of OntDisjoint.Individuals

differentIndividuals

default Stream<OntIndividual> differentIndividuals()

Lists all different individuals. The pattern to search for is thisIndividual owl:differentFrom otherIndividual, where otherIndividual is one of the returned.

Returns:

Stream of OntIndividuals

See Also:

• OntDisjoint.Individuals

positiveAssertions

default Stream<OntStatement> positiveAssertions()

Lists all positive assertions for this individual.

Returns:

Stream of OntStatements

positiveAssertions

default Stream<OntStatement> positiveAssertions(OntNamedProperty predicate)

Lists all positive property assertions for this individual and the given predicate.

Parameters:

predicate - OntNamedProperty or null

Returns:

Stream of OntStatements

negativeAssertions

default Stream<OntNegativeAssertion> negativeAssertions()

Lists all negative property assertions for this individual.

Returns:

Stream of negative property assertions

negativeAssertions

default Stream<OntNegativeAssertion> negativeAssertions(OntRelationalProperty property)

Lists all negative property assertions for this individual and the given property.

Parameters:

property - OntRelationalProperty or null

Returns:

Stream of negative property assertions

addClassAssertion

default OntStatement addClassAssertion(OntClass clazz)

Creates and returns a class-assertion statement a rdf:type C, where a is this individual.

Parameters:

clazz - OntClass, not null

Returns:

OntStatement to allow subsequent annotations adding

See Also:

• attachClass(OntClass)
• detachClass(Resource)

addDifferentFromStatement

default OntStatement addDifferentFromStatement(OntIndividual other)

Adds a owl:differentFrom individual statement.

Parameters:

other - OntIndividual, not null

Returns:

OntStatement to provide the ability to add annotations subsequently

See Also:

• addDifferentIndividual(OntIndividual)
• removeDifferentIndividual(Resource)
• OntDisjoint.Individuals

addSameAsStatement

default OntStatement addSameAsStatement(OntIndividual other)

Adds a same individual reference.

Parameters:

other - OntIndividual, not null

Returns:

OntStatement to allow subsequent annotations adding

See Also:

• addSameIndividual(OntIndividual)
• removeSameIndividual(Resource)
• 9.6.1 Individual Equality

attachClass

default OntIndividual attachClass(OntClass clazz)

Adds a type (class expression) to this individual.

Parameters:

clazz - OntClass

Returns:

this instance to allow cascading calls

See Also:

• addClassAssertion(OntClass)
• detachClass(Resource)

addDifferentIndividual

default OntIndividual addDifferentIndividual(OntIndividual other)

Adds a owl:differentFrom individual statement and returns this object itself to allow cascading calls.

Parameters:

other - OntIndividual, not null

Returns:

this instance to allow cascading calls

See Also:

• addDifferentFromStatement(OntIndividual)
• removeDifferentIndividual(Resource)
• OntDisjoint.Individuals
• 9.6.2 Individual Inequality

addSameIndividual

default OntIndividual addSameIndividual(OntIndividual other)

Adds a owl:sameAs individual statement and returns this object itself to allow cascading calls.

Parameters:

other - other OntIndividual, not null

Returns:

this instance to allow cascading calls

See Also:

• addSameAsStatement(OntIndividual)
• removeSameIndividual(Resource)

addAssertion

default OntIndividual addAssertion(OntAnnotationProperty property,
 org.apache.jena.rdf.model.RDFNode value)

Adds annotation assertion AnnotationAssertion(A s t). In general case it is s A t, where s is IRI or anonymous individual, A - annotation property, and t - IRI, anonymous individual, or literal.

Parameters:

property - OntAnnotationProperty

value - RDFNode (IRI, anonymous individual, or literal)

Returns:

this individual to allow cascading calls

See Also:

• OntObject.addAnnotation(OntAnnotationProperty, RDFNode)
• removeAssertion(OntNamedProperty, RDFNode)

addAssertion

default OntIndividual addAssertion(OntDataProperty property,
 org.apache.jena.rdf.model.Literal value)

Adds a positive data property assertion a R v.

Parameters:

property - OntDataProperty

value - Literal

Returns:

this individual to allow cascading calls

See Also:

• removeAssertion(OntNamedProperty, RDFNode)

addAssertion

default OntIndividual addAssertion(OntObjectProperty.Named property,
 OntIndividual value)

Adds a positive object property assertion a1 PN a2.

Parameters:

property - OntObjectProperty.Named named object property

value - OntIndividual other individual

Returns:

this individual to allow cascading calls

See Also:

• removeAssertion(OntNamedProperty, RDFNode)

addProperty

default OntIndividual addProperty(OntNamedProperty property,
 org.apache.jena.rdf.model.RDFNode value)

Adds a property assertion statement. Caution: this method offers a way to add a statement that is contrary to the OWL2 specification. For example, it is possible to add object property-literal pair, that is not object property assertion.

Parameters:

property - OntNamedProperty, not null

value - RDFNode, not null

Returns:

this instance to allow cascading calls

See Also:

• Resource.addProperty(Property, RDFNode)
• removeAssertion(OntNamedProperty, RDFNode)

addNegativeAssertion

default OntIndividual addNegativeAssertion(OntObjectProperty property,
 OntIndividual value)

Adds a negative object property assertion.

 Functional syntax: NegativeObjectPropertyAssertion(P a1 a2)
 RDF Syntax:
 
 _:x rdf:type owl:NegativePropertyAssertion .
 _:x owl:sourceIndividual a1 .
 _:x owl:assertionProperty P .
 _:x owl:targetIndividual a2 .
 
 

Parameters:

property - OntObjectProperty

value - OntIndividual other individual

Returns:

this individual to allow cascading calls

addNegativeAssertion

default OntIndividual addNegativeAssertion(OntDataProperty property,
 org.apache.jena.rdf.model.Literal value)

Adds a negative data property assertion.

 Functional syntax: NegativeDataPropertyAssertion(R a v)
 RDF Syntax:
 
 _:x rdf:type owl:NegativePropertyAssertion.
 _:x owl:sourceIndividual a .
 _:x owl:assertionProperty R .
 _:x owl:targetValue v .
 
 

Parameters:

property - OntDataProperty

value - Literal

Returns:

this individual to allow cascading calls

removeAssertion

default OntIndividual removeAssertion(OntNamedProperty property,
 org.apache.jena.rdf.model.RDFNode value)

Removes a positive property assertion including its annotation.

Parameters:

property - OntNamedProperty, can be null to remove all positive property assertions

value - RDFNode (either OntIndividual or Literal), can be null to remove all assertions for the predicate property

Returns:

this instance to allow cascading calls

See Also:

• OntObject.remove(Property, RDFNode)
• addProperty(OntNamedProperty, RDFNode)

removeNegativeAssertion

default OntIndividual removeNegativeAssertion(OntRelationalProperty property,
 org.apache.jena.rdf.model.RDFNode value)

Removes a negative property assertion including its annotation.

Parameters:

property - OntNamedProperty, can be null to remove all negative property assertions

value - RDFNode (either OntIndividual or Literal), can be null to remove all assertions for the predicate property

Returns:

this instance to allow cascading calls

removeDifferentIndividual

default OntIndividual removeDifferentIndividual(org.apache.jena.rdf.model.Resource other)

Removes a different individual statement for this and specified individuals, including the statement's annotation. No-op in case no different individuals are found. Removes all triples with the predicate owl:differentFrom if null is specified.

Parameters:

other - Resource or null to remove all different individuals

Returns:

this instance to allow cascading calls

See Also:

• addDifferentFromStatement(OntIndividual)
• addDifferentIndividual(OntIndividual)
• OntDisjoint.Individuals

removeSameIndividual

default OntIndividual removeSameIndividual(org.apache.jena.rdf.model.Resource other)

Removes a same individual statement for this and specified individuals, including the statement's annotation. No-op in case no same individuals are found. Removes all triples with the predicate owl:sameAs if null is specified.

Parameters:

other - Resource or null to remove all same individuals

Returns:

this instance to allow cascading calls

See Also:

• addSameAsStatement(OntIndividual)
• addSameIndividual(OntIndividual)

addComment

default OntIndividual 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 OntIndividual 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 OntIndividual 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 OntIndividual 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 OntIndividual 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 OntIndividual 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)