Module org.apache.jena.ontapi

Package org.apache.jena.ontapi.model

Interface OntStatement

All Superinterfaces:

org.apache.jena.graph.FrontsTriple, org.apache.jena.rdf.model.Statement

All Known Implementing Classes:

OntStatementImpl

public interface OntStatement
extends org.apache.jena.rdf.model.Statement

An Ontology RDF Statement.

This is not a Resource. This is an extended Jena Model Statement with possibility to add, delete and find annotations in the same form of OntStatement or Ontology Annotation resources.

See Also:

• OntAnnotation
• Statement
• 2.2 Translation of Annotations

Method Summary

Modifier and Type	Method	Description
default OntStatement	addAnnotation(OntAnnotationProperty predicate, String text)	Creates and returns a textual no-lang sub-annotation-assertion.
default OntStatement	addAnnotation(OntAnnotationProperty predicate, String text, String lang)	Creates and returns a textual language-tagged sub-annotation-assertion.
OntStatement	addAnnotation(OntAnnotationProperty property, org.apache.jena.rdf.model.RDFNode value)	Annotates the statement with the given annotation property and RDF Node value and returns a newly added annotation assertion statement.
default OntStatement	annotate(OntAnnotationProperty property, String text)	Annotates the statement with the given predicate and textual message.
default OntStatement	annotate(OntAnnotationProperty property, String text, String lang)	Annotates the statement with the given predicate and language-tagged textual message.
default OntStatement	annotate(OntAnnotationProperty property, org.apache.jena.rdf.model.RDFNode value)	Annotates the statement with the given predicate and value.
Stream<OntAnnotation>	annotationResources()	Returns the stream of the annotation objects attached to this statement.
Stream<OntStatement>	annotations()	Lists all annotations related to this statement.
default Stream<OntStatement>	annotations(OntAnnotationProperty property)	Lists all annotations by the property.
default Optional<OntAnnotation>	asAnnotationResource()	Returns the primary annotation object (resource) which is related to this statement.
default boolean	belongsToAnnotation()	Answers true iff this statement is a part of Bulk Annotation Ontology Object.
default OntStatement	clearAnnotations()	Removes all sub-annotations including their children.
default OntStatement	deleteAnnotation(OntAnnotationProperty property)	Deletes all (sub-)annotations with the given predicate-property.
OntStatement	deleteAnnotation(OntAnnotationProperty property, org.apache.jena.rdf.model.RDFNode value)	Deletes the child annotation if present.
default List<OntAnnotation>	getAnnotationList()	Returns the annotation objects attached to this statement in the form of List with a fixed order.
OntModel	getModel()	Gets the Ontology RDF Model this Statement was created in.
default <O extends org.apache.jena.rdf.model.RDFNode> O	getObject(Class<O> type)	Answers a typed object of the statement.
OntObject	getSubject()	An accessor method to return the subject of the statements in form of Ontology Object.
default <S extends org.apache.jena.rdf.model.Resource> S	getSubject(Class<S> type)	Answers a typed subject of the statement.
default boolean	hasAnnotations()	Answers true iff this statement has any annotations attached (either plain or bulk).
default boolean	isAnnotationAssertion()	Answers true iff this is an annotation assertion.
default boolean	isDeclaration()	Answers true iff this statement is a declaration: @any rdf:type @any.
default boolean	isLocal()	Answers true iff this statement is in the base graph.

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

asTriple

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

changeLiteralObject, changeLiteralObject, changeLiteralObject, changeLiteralObject, changeLiteralObject, changeLiteralObject, changeObject, changeObject, changeObject, equals, getAlt, getBag, getBoolean, getByte, getChar, getDouble, getFloat, getInt, getLanguage, getList, getLiteral, getLong, getObject, getPredicate, getProperty, getResource, getSeq, getShort, getStatementProperty, getString, hashCode, remove

Method Details

getModel

OntModel getModel()

Gets the Ontology RDF Model this Statement was created in.

Specified by:

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

Returns:

OntModel

addAnnotation

OntStatement addAnnotation(OntAnnotationProperty property,
 org.apache.jena.rdf.model.RDFNode value)

Annotates the statement with the given annotation property and RDF Node value and returns a newly added annotation assertion statement.

In the special case of a main statement (i.e., if this statement is a result of OntObject.getMainStatement()) the returned OntStatement has the same subject as this statement, and it is called a plain annotation assertion (in this case the method is equivalent to the OntObject.addAnnotation(OntAnnotationProperty, RDFNode) method). Otherwise, the returned statement is a part of a fresh or existing bulk annotation resource and its subject is a blank node.

Parameters:

property - OntAnnotationProperty named annotation property, not null

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

Returns:

a new Ont-Statement for newly added annotation

Throws:

OntJenaException - in case input is incorrect

See Also:

• annotate(OntAnnotationProperty, RDFNode)
• OntAnnotation.addAnnotation(OntAnnotationProperty, RDFNode)
• OntObject.addAnnotation(OntAnnotationProperty, RDFNode)
• OntObject.getMainStatement()

annotations

Stream<OntStatement> annotations()

Lists all annotations related to this statement. The returned stream consists of annotation assertions listed from the top-level bulk annotations plus plain annotation assertions in the special case of the main statement.

Returns:

Stream (unordered) of annotation assertion statements with annotation property as predicates, can be empty

See Also:

• asAnnotationResource()

deleteAnnotation

OntStatement deleteAnnotation(OntAnnotationProperty property,
 org.apache.jena.rdf.model.RDFNode value)
                       throws OntJenaException

Deletes the child annotation if present. Does nothing if no assertion found. Throws an exception if specified annotation has it its own annotations. If this statement is not root and the corresponding OntAnnotation resource has no assertions anymore, it deletes the whole OntAnnotation resource also.

Parameters:

property - OntAnnotationProperty named annotation property, not null

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

Returns:

this statement instance to allow cascading calls

Throws:

OntJenaException - in case input is incorrect or deleted annotation has it its own annotations

See Also:

• deleteAnnotation(OntAnnotationProperty)
• clearAnnotations()

annotationResources

Stream<OntAnnotation> annotationResources()

Returns the stream of the annotation objects attached to this statement. E.g., for the statement s A t the annotation object looks like

 _:b0 a owl:Axiom .
 _:b0 Aj tj .
 _:b0 owl:annotatedSource s .
 _:b0 owl:annotatedProperty A .
 _:b0 owl:annotatedTarget t .
 

Technically, although it usually does not make sense, it is allowed that a statement may have several such b-nodes.

Returns:

Stream (unordered) of OntAnnotation resources

See Also:

• to get first annotation-object
• to get all annotation-objects in a fixed order

getSubject

OntObject getSubject()

An accessor method to return the subject of the statements in form of Ontology Object.

Specified by:

getSubject in interface org.apache.jena.rdf.model.Statement

Returns:

OntObject

See Also:

• Statement.getSubject()

isLocal

default boolean isLocal()

Answers true iff this statement is in the base graph. The method is equivalent to the expression this.getModel().getBaseGraph().contains(this.asTriple()).

Returns:

true if it is a local statement

See Also:

• OntResource.isLocal()

getAnnotationList

default List<OntAnnotation> getAnnotationList()

Returns the annotation objects attached to this statement in the form of List with a fixed order.

Returns:

List of Ontology Annotations

See Also:

• annotationResources()

asAnnotationResource

default Optional<OntAnnotation> asAnnotationResource()

Returns the primary annotation object (resource) which is related to this statement. It is assumed that this method always returns the same result if no changes in graph are made, even after graph reloading.

Returns:

Optional around of OntAnnotation, can be empty

See Also:

• getAnnotationList()

annotations

default Stream<OntStatement> annotations(OntAnnotationProperty property)

Lists all annotations by the property.

Parameters:

property - OntAnnotationProperty the property

Returns:

Stream of OntStatements

deleteAnnotation

default OntStatement deleteAnnotation(OntAnnotationProperty property)

Deletes all (sub-)annotations with the given predicate-property.

Parameters:

property - OntAnnotationProperty

Returns:

this statement to allow cascading calls

See Also:

• clearAnnotations()
• deleteAnnotation(OntAnnotationProperty, RDFNode)

isDeclaration

default boolean isDeclaration()

Answers true iff this statement is a declaration: @any rdf:type @any.

Returns:

true if the predicate is rdf:type

belongsToAnnotation

default boolean belongsToAnnotation()

Answers true iff this statement is a part of Bulk Annotation Ontology Object. This means that it is one of the following:

 _:x rdf:type              owl:Annotation .
 _:x p                     v .
 _:x owl:annotatedSource   this .
 _:x owl:annotatedProperty x .
 _:x owl:annotatedTarget   y .
 

Returns:

true if it is a part of bulk annotation object

See Also:

• OntAnnotation

isAnnotationAssertion

default boolean isAnnotationAssertion()

Answers true iff this is an annotation assertion. Annotation assertion is a statement s A t, where s is an IRI or anonymous individual, t is an IRI, anonymous individual, or literal, and A is an annotation property.

Returns:

true if the predicate is OntAnnotationProperty

clearAnnotations

default OntStatement clearAnnotations()

Removes all sub-annotations including their children.

Returns:

this statement to allow cascading calls

See Also:

• deleteAnnotation(OntAnnotationProperty, RDFNode)
• OntObject.clearAnnotations()

hasAnnotations

default boolean hasAnnotations()

Answers true iff this statement has any annotations attached (either plain or bulk).

Returns:

true if it is annotated

addAnnotation

default OntStatement addAnnotation(OntAnnotationProperty predicate,
 String text)

Creates and returns a textual no-lang sub-annotation-assertion.

Parameters:

predicate - OntAnnotationProperty, not null

text - String, the text message, not null

Returns:

OntStatement, new instance

See Also:

• OntObject.addAnnotation(OntAnnotationProperty, String, String)

addAnnotation

default OntStatement addAnnotation(OntAnnotationProperty predicate,
 String text,
 String lang)

Creates and returns a textual language-tagged sub-annotation-assertion.

Parameters:

predicate - OntAnnotationProperty, not null

text - String, the text message, not null

lang - String, language, optional

Returns:

OntStatement, new instance

See Also:

• OntObject.addAnnotation(OntAnnotationProperty, String, String)

annotate

default OntStatement annotate(OntAnnotationProperty property,
 String text)

Annotates the statement with the given predicate and textual message.

Parameters:

property - OntAnnotationProperty named annotation property, not null

text - String, the text message, not null

Returns:

this OntStatement to allow cascading calls

See Also:

• addAnnotation(OntAnnotationProperty, String)
• OntModel.getRDFSComment()
• OntModel.getRDFSLabel()

annotate

default OntStatement annotate(OntAnnotationProperty property,
 String text,
 String lang)

Annotates the statement with the given predicate and language-tagged textual message.

Parameters:

property - OntAnnotationProperty named annotation property, not null

text - String, the text message, not null

lang - String, language, optional

Returns:

this OntStatement to allow cascading calls

See Also:

• addAnnotation(OntAnnotationProperty, String, String)
• OntModel.getRDFSComment()
• OntModel.getRDFSLabel()

annotate

default OntStatement annotate(OntAnnotationProperty property,
 org.apache.jena.rdf.model.RDFNode value)

Annotates the statement with the given predicate and value. The method differs from addAnnotation(OntAnnotationProperty, RDFNode) only in a return object.

Parameters:

property - OntAnnotationProperty named annotation property, not null

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

Returns:

this OntStatement to allow cascading calls

See Also:

• addAnnotation(OntAnnotationProperty, RDFNode)
• OntModel.getRDFSComment()
• OntModel.getRDFSLabel()

getSubject

default <S extends org.apache.jena.rdf.model.Resource>
S getSubject(Class<S> type)

Answers a typed subject of the statement.

Type Parameters:

S - subtype of Resource

Parameters:

type - Class type

Returns:

Resource instance

Throws:

org.apache.jena.enhanced.UnsupportedPolymorphismException - if the subject node and the given type are incompatible

See Also:

• getSubject()

getObject

default <O extends org.apache.jena.rdf.model.RDFNode>
O getObject(Class<O> type)

Answers a typed object of the statement.

Type Parameters:

O - subtype of RDFNode

Parameters:

type - Class type

Returns:

RDFNode instance

Throws:

org.apache.jena.enhanced.UnsupportedPolymorphismException - if the object node and the given type are incompatible

See Also:

• Statement.getObject()