org.eclipse.rdf4j.model

Interface Model

All Superinterfaces:

Collection<Statement>, Graph, Iterable<Statement>, NamespaceAware, Serializable, Set<Statement>

All Known Implementing Classes:

AbstractModel, EmptyModel, FilteredModel, LinkedHashModel, TreeModel

public interface Model
extends Graph, Set<Statement>, Serializable, NamespaceAware

An RDF Model, represented as a Set of Statements with predictable iteration order.

Additional utility functionality for working with Model objects is available in the Models utility class.

Author:

James Leigh, Jeen Broekstra

See Also:

the Models utility class

Method Summary

Modifier and Type	Method and Description
boolean	add(Resource subj, IRI pred, Value obj, Resource... contexts) Adds one or more statements to the model.
default boolean	add(Resource subj, URI pred, Value obj, Resource... contexts) Deprecated. since 4.0. Use add(Resource, IRI, Value, Resource...) instead.
boolean	clear(Resource... context) Removes statements with the specified context exist in this model.
boolean	contains(Resource subj, IRI pred, Value obj, Resource... contexts) Determines if statements with the specified subject, predicate, object and (optionally) context exist in this model.
default boolean	contains(Resource subj, URI pred, Value obj, Resource... contexts) Deprecated. since 4.0. Use contains(Resource, IRI, Value, Resource...) instead.
default Set<Resource>	contexts() Returns a Set view of the contexts contained in this model.
Model	filter(Resource subj, IRI pred, Value obj, Resource... contexts) Returns a view of the statements with the specified subject, predicate, object and (optionally) context.
default Model	filter(Resource subj, URI pred, Value obj, Resource... contexts) Deprecated.
default Optional<IRI>	objectIRI() Deprecated. since 4.0. Instead, use Models#objectURI(Model) to retrieve an object URI value, and/or use the size of the set returned by objects() to verify if the object is unique.
default Optional<Literal>	objectLiteral() Deprecated. since 4.0. Instead, use Models.objectLiteral(Model) to retrieve an object Literal value, and/or use the size of the set returned by objects() to verify if the object is unique.
default Optional<Resource>	objectResource() Deprecated. since 4.0. Instead, use Models.objectResource(Model) to retrieve an object Resource value, and/or use the size of the set returned by objects() to verify if the object is unique.
Set<Value>	objects() Returns a Set view of the objects contained in this model.
default Optional<String>	objectString() Deprecated. since 4.0. Instead, use Models.objectString(Model) to retrieve an object string value, and/or use the size of the set returned by objects() to verify if the object is unique.
default Optional<IRI>	objectURI() Deprecated. use objectIRI() instead.
default Optional<Value>	objectValue() Deprecated. since 4.0. Instead, use Models.object(Model) to retrieve an object value, and/or use the size of the set returned by objects() to verify if the object is unique.
Set<IRI>	predicates() Returns a Set view of the predicates contained in this model.
boolean	remove(Resource subj, IRI pred, Value obj, Resource... contexts) Removes statements with the specified subject, predicate, object and (optionally) context exist in this model.
default boolean	remove(Resource subj, URI pred, Value obj, Resource... contexts) Deprecated. since 4.0. Use remove(Resource, IRI, Value, Resource...) instead.
Optional<Namespace>	removeNamespace(String prefix) Removes a namespace declaration by removing the association between a prefix and a namespace name.
void	setNamespace(Namespace namespace) Sets the prefix for a namespace.
default Namespace	setNamespace(String prefix, String name) Sets the prefix for a namespace.
default Optional<BNode>	subjectBNode() Deprecated. since 4.0. Instead, use Models.subjectBNode(Model) to retrieve a subject BNode, and/or use the size of the set returned by subjects() to verify if the subject is unique.
default Optional<IRI>	subjectIRI() Deprecated. since 4.0. Instead, use Models#subjectURI(Model) to retrieve a subject URI, and/or use the size of the set returned by subjects() to verify if the subject is unique.
default Optional<Resource>	subjectResource() Deprecated. since 4.0. Instead, use Models.subject(Model) to retrieve a subject Resource, and/or use the size of the set returned by subjects() to verify if the subject is unique.
Set<Resource>	subjects() Returns a Set view of the subjects contained in this model.
default Optional<IRI>	subjectURI() Deprecated. use subjectIRI() instead.
Model	unmodifiable() Returns an unmodifiable view of this model.

Methods inherited from interface org.eclipse.rdf4j.model.Graph

getValueFactory, match

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.eclipse.rdf4j.model.NamespaceAware

getNamespace, getNamespaces

Method Detail

unmodifiable

Model unmodifiable()

Returns an unmodifiable view of this model. This method provides "read-only" access to this model. Query operations on the returned model "read through" to this model, and attempts to modify the returned model, whether direct or via its iterator, result in an UnsupportedOperationException.

Returns:

an unmodifiable view of the specified set.

setNamespace

default Namespace setNamespace(String prefix,
                               String name)

Sets the prefix for a namespace. This will replace any existing namespace associated to the prefix.

Parameters:

prefix - The new prefix.

name - The namespace name that the prefix maps to.

Returns:

The Namespace object for the given namespace.

setNamespace

void setNamespace(Namespace namespace)

Sets the prefix for a namespace. This will replace any existing namespace associated to the prefix.

Parameters:

namespace - A Namespace object to use in this Model.

removeNamespace

Optional<Namespace> removeNamespace(String prefix)

Removes a namespace declaration by removing the association between a prefix and a namespace name.

Parameters:

prefix - The namespace prefix of which the assocation with a namespace name is to be removed.

Returns:

the previous namespace bound to the prefix or Optional.empty()

contains

boolean contains(Resource subj,
                 IRI pred,
                 Value obj,
                 Resource... contexts)

Determines if statements with the specified subject, predicate, object and (optionally) context exist in this model. The subject, predicate and object parameters can be null to indicate wildcards. The contexts parameter is a wildcard and accepts zero or more values. If no contexts are specified, statements will match disregarding their context. If one or more contexts are specified, statements with a context matching one of these will match. Note: to match statements without an associated context, specify the value null and explicitly cast it to type Resource.

Examples: model.contains(s1, null, null) is true if any statements in this model have subject s1,
model.contains(null, null, null, c1) is true if any statements in this model have context c1,
model.contains(null, null, null, (Resource)null) is true if any statements in this model have no associated context,
model.contains(null, null, null, c1, c2, c3) is true if any statements in this model have context c1, c2 or c3 .

Parameters:

subj - The subject of the statements to match, null to match statements with any subject.

pred - The predicate of the statements to match, null to match statements with any predicate.

obj - The object of the statements to match, null to match statements with any object.

contexts - The contexts of the statements to match. If no contexts are specified, statements will match disregarding their context. If one or more contexts are specified, statements with a context matching one of these will match.

Returns:

true if statements match the specified pattern.

contains

@Deprecated
default boolean contains(Resource subj,
                                     URI pred,
                                     Value obj,
                                     Resource... contexts)

Deprecated. since 4.0. Use contains(Resource, IRI, Value, Resource...) instead.

add

boolean add(Resource subj,
            IRI pred,
            Value obj,
            Resource... contexts)

Adds one or more statements to the model. This method creates a statement for each specified context and adds those to the model. If no contexts are specified, a single statement with no associated context is added. If this Model is a filtered Model then null (if context empty) values are permitted and will use the corresponding filtered values.

Specified by:

add in interface Graph

Parameters:

subj - The statement's subject.

pred - The statement's predicate.

obj - The statement's object.

contexts - The contexts to add statements to.

Throws:

IllegalArgumentException - If This Model cannot store the given statement, because it is filtered out of this view.

UnsupportedOperationException - If this Model cannot accept any statements, because it is filtered to the empty set.

add

@Deprecated
default boolean add(Resource subj,
                                URI pred,
                                Value obj,
                                Resource... contexts)

Deprecated. since 4.0. Use add(Resource, IRI, Value, Resource...) instead.

clear

boolean clear(Resource... context)

Removes statements with the specified context exist in this model.

Parameters:

context - The context of the statements to remove.

Returns:

true if one or more statements have been removed.

remove

boolean remove(Resource subj,
               IRI pred,
               Value obj,
               Resource... contexts)

Removes statements with the specified subject, predicate, object and (optionally) context exist in this model. The subject, predicate and object parameters can be null to indicate wildcards. The contexts parameter is a wildcard and accepts zero or more values. If no contexts are specified, statements will be removed disregarding their context. If one or more contexts are specified, statements with a context matching one of these will be removed. Note: to remove statements without an associated context, specify the value null and explicitly cast it to type Resource.

Examples: model.remove(s1, null, null) removes any statements in this model have subject s1,
model.remove(null, null, null, c1) removes any statements in this model have context c1 ,
model.remove(null, null, null, (Resource)null) removes any statements in this model have no associated context,
model.remove(null, null, null, c1, c2, c3) removes any statements in this model have context c1, c2 or c3.

Parameters:

subj - The subject of the statements to remove, null to remove statements with any subject.

pred - The predicate of the statements to remove, null to remove statements with any predicate.

obj - The object of the statements to remove, null to remove statements with any object.

contexts - The contexts of the statements to remove. If no contexts are specified, statements will be removed disregarding their context. If one or more contexts are specified, statements with a context matching one of these will be removed.

Returns:

true if one or more statements have been removed.

remove

@Deprecated
default boolean remove(Resource subj,
                                   URI pred,
                                   Value obj,
                                   Resource... contexts)

Deprecated. since 4.0. Use remove(Resource, IRI, Value, Resource...) instead.

filter

Model filter(Resource subj,
             IRI pred,
             Value obj,
             Resource... contexts)

Returns a view of the statements with the specified subject, predicate, object and (optionally) context. The subject, predicate and object parameters can be null to indicate wildcards. The contexts parameter is a wildcard and accepts zero or more values. If no contexts are specified, statements will match disregarding their context. If one or more contexts are specified, statements with a context matching one of these will match. Note: to match statements without an associated context, specify the value null and explicitly cast it to type Resource.

The returned model is backed by this Model, so changes to this Model are reflected in the returned model, and vice-versa. If this Model is modified while an iteration over the returned model is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The model supports element removal, which removes the corresponding statement from this Model, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. The statements passed to the add and addAll operations must match the parameter pattern.

Examples: model.filter(s1, null, null) matches all statements that have subject s1,
model.filter(null, null, null, c1) matches all statements that have context c1,
model.filter(null, null, null, (Resource)null) matches all statements that have no associated context,
model.filter(null, null, null, c1, c2, c3) matches all statements that have context c1, c2 or c3.

Parameters:

subj - The subject of the statements to match, null to match statements with any subject.

pred - The predicate of the statements to match, null to match statements with any predicate.

obj - The object of the statements to match, null to match statements with any object.

contexts - The contexts of the statements to match. If no contexts are specified, statements will match disregarding their context. If one or more contexts are specified, statements with a context matching one of these will match.

Returns:

The statements that match the specified pattern.

filter

@Deprecated
default Model filter(Resource subj,
                                 URI pred,
                                 Value obj,
                                 Resource... contexts)

Deprecated.

subjects

Set<Resource> subjects()

Returns a Set view of the subjects contained in this model. The set is backed by the model, so changes to the model are reflected in the set, and vice-versa. If the model is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes all statements from the model for which that element is a subject value, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations if the parameters pred or obj are null.

Returns:

a set view of the subjects contained in this model

subjectResource

@Deprecated
default Optional<Resource> subjectResource()
                                                throws ModelException

Deprecated. since 4.0. Instead, use Models.subject(Model) to retrieve a subject Resource, and/or use the size of the set returned by subjects() to verify if the subject is unique.

Gets the subject of the statement(s). If the model contains one or more statements, all these statements should have the same subject. A ModelException is thrown if this is not the case.

Returns:

The subject of the matched statement(s), or Optional.empty() if no matching statements were found.

Throws:

ModelException - If the statements matched by the specified parameters have more than one unique subject.

subjectIRI

@Deprecated
default Optional<IRI> subjectIRI()
                                      throws ModelException

Deprecated. since 4.0. Instead, use Models#subjectURI(Model) to retrieve a subject URI, and/or use the size of the set returned by subjects() to verify if the subject is unique.

Utility method that casts the return value of subjectResource() to a IRI, or throws a ModelException if that value is not an IRI.

Returns:

The subject of the matched statement(s), or null if no matching statements were found.

Throws:

ModelException - If such an exception is thrown by subjectResource() or if its return value is not a IRI.

subjectURI

@Deprecated
default Optional<IRI> subjectURI()
                                      throws ModelException

Deprecated. use subjectIRI() instead.

Provided for backward-compatibility purposes only, this method executes subjectIRI() instead.

Throws:

ModelException

subjectBNode

@Deprecated
default Optional<BNode> subjectBNode()
                                          throws ModelException

Deprecated. since 4.0. Instead, use Models.subjectBNode(Model) to retrieve a subject BNode, and/or use the size of the set returned by subjects() to verify if the subject is unique.

Utility method that casts the return value of subjectResource() to a BNode, or throws a ModelException if that value is not a BNode.

Returns:

The subject of the matched statement(s), or null if no matching statements were found.

Throws:

ModelException - If such an exception is thrown by subjectResource() or if its return value is not a BNode.

predicates

Set<IRI> predicates()

Returns a Set view of the predicates contained in this model. The set is backed by the model, so changes to the model are reflected in the set, and vice-versa. If the model is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes all statements from the model for which that element is a predicate value, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations if the parameters subj or obj are null.

Returns:

a set view of the predicates contained in this model

objects

Set<Value> objects()

Returns a Set view of the objects contained in this model. The set is backed by the model, so changes to the model are reflected in the set, and vice-versa. If the model is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes all statements from the model for which that element is an object value, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations if the parameters subj or pred are null.

Returns:

a set view of the objects contained in this model

contexts

default Set<Resource> contexts()

Returns a Set view of the contexts contained in this model. The set is backed by the model, so changes to the model are reflected in the set, and vice-versa. If the model is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes all statements from the model for which that element is a context value, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations if the parameters subj , pred or obj are null.

Returns:

a set view of the contexts contained in this model

objectValue

@Deprecated
default Optional<Value> objectValue()
                                         throws ModelException

Deprecated. since 4.0. Instead, use Models.object(Model) to retrieve an object value, and/or use the size of the set returned by objects() to verify if the object is unique.

Gets the object of the statement(s). If the model contains one or more statements, all these statements should have the same object. A ModelException is thrown if this is not the case.

Returns:

The object of the matched statement(s), or Optional.empty() if no matching statements were found.

Throws:

ModelException - If the statements matched by the specified parameters have more than one unique object.

objectLiteral

@Deprecated
default Optional<Literal> objectLiteral()
                                             throws ModelException

Deprecated. since 4.0. Instead, use Models.objectLiteral(Model) to retrieve an object Literal value, and/or use the size of the set returned by objects() to verify if the object is unique.

Utility method that casts the return value of objectValue() to a Literal, or throws a ModelUtilException if that value is not a Literal.

Returns:

The object of the matched statement(s), or Optional.empty() if no matching statements were found.

Throws:

ModelException - If such an exception is thrown by objectValue() or if its return value is not a Literal.

objectResource

@Deprecated
default Optional<Resource> objectResource()
                                               throws ModelException

Deprecated. since 4.0. Instead, use Models.objectResource(Model) to retrieve an object Resource value, and/or use the size of the set returned by objects() to verify if the object is unique.

Utility method that casts the return value of objectValue() to a Resource, or throws a ModelUtilException if that value is not a Resource.

Returns:

The object of the matched statement(s), or Optional.empty() if no matching statements were found.

Throws:

ModelException - If such an exception is thrown by objectValue() or if its return value is not a Resource.

objectIRI

@Deprecated
default Optional<IRI> objectIRI()
                                     throws ModelException

Deprecated. since 4.0. Instead, use Models#objectURI(Model) to retrieve an object URI value, and/or use the size of the set returned by objects() to verify if the object is unique.

Utility method that casts the return value of objectValue() to an IRI, or throws a ModelUtilException if that value is not an IRI.

Returns:

The object of the matched statement(s), or Optional.empty() if no matching statements were found.

Throws:

ModelException - If such an exception is thrown by objectValue() or if its return value is not an IRI.

objectURI

@Deprecated
default Optional<IRI> objectURI()
                                     throws ModelException

Deprecated. use objectIRI() instead.

Provided for backward-compatibility purposes only, this method executes objectIRI() instead.

Throws:

ModelException

objectString

@Deprecated
default Optional<String> objectString()
                                           throws ModelException

Deprecated. since 4.0. Instead, use Models.objectString(Model) to retrieve an object string value, and/or use the size of the set returned by objects() to verify if the object is unique.

Utility method that returns the string value of objectValue().

Returns:

The object string value of the matched statement(s), or Optional.empty() if no matching statements were found.

Throws:

ModelException - If the statements matched by the specified parameters have more than one unique object.