Interface Dataset
- All Superinterfaces:
AutoCloseable
,GraphLike<Quad>
- All Known Subinterfaces:
JsonLdDataset
,RDF4JDataset
- All Known Implementing Classes:
DatasetImpl
,JsonLdDatasetImpl
,RepositoryDatasetImpl
- Since:
- 0.3.0-incubating
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(BlankNodeOrIRI graphName, BlankNodeOrIRI subject, IRI predicate, RDFTerm object) Add a quad to the dataset, possibly mapping any of the components to those supported by this dataset.void
Add a quad to the dataset, possibly mapping any of the components of the Quad to those supported by this dataset.void
clear()
Clear the dataset, removing all quads.default void
close()
Close the dataset, relinquishing any underlying resources.boolean
contains
(Optional<BlankNodeOrIRI> graphName, BlankNodeOrIRI subject, IRI predicate, RDFTerm object) Check if dataset contains a pattern of quads.boolean
Check if dataset contains quad.getGraph()
Get the default graph of this dataset.getGraph
(BlankNodeOrIRI graphName) Get a named graph in this dataset.Get the graph names in this Dataset.iterate()
Get an Iterable for iterating over all quads in the dataset.iterate
(Optional<BlankNodeOrIRI> graphName, BlankNodeOrIRI subject, IRI predicate, RDFTerm object) Get an Iterable for iterating over the quads in the dataset that match the pattern.void
remove
(Optional<BlankNodeOrIRI> graphName, BlankNodeOrIRI subject, IRI predicate, RDFTerm object) Remove a concrete pattern of quads from the default graph of the dataset.void
Remove a concrete quad from the dataset.long
size()
Number of quads contained by the dataset.stream()
Get all quads contained by the dataset.stream
(Optional<BlankNodeOrIRI> graphName, BlankNodeOrIRI subject, IRI predicate, RDFTerm object) Get all quads contained by the dataset matched with the pattern.
-
Method Details
-
add
Add a quad to the dataset, possibly mapping any of the components of the Quad to those supported by this dataset. -
add
Add a quad to the dataset, possibly mapping any of the components to those supported by this dataset.- Parameters:
graphName
- The graph the quad belongs to, ornull
for the default graphsubject
- The quad subjectpredicate
- The quad predicateobject
- The quad object
-
contains
Check if dataset contains quad. -
contains
boolean contains(Optional<BlankNodeOrIRI> graphName, BlankNodeOrIRI subject, IRI predicate, RDFTerm object) Check if dataset contains a pattern of quads.- Parameters:
graphName
- The graph the quad belongs to, wrapped as anOptional
(null
is a wildcard,Optional.empty()
is the default graph)subject
- The quad subject (null
is a wildcard)predicate
- The quad predicate (null
is a wildcard)object
- The quad object (null
is a wildcard)- Returns:
- True if the dataset contains any quads that match the given pattern.
-
close
Close the dataset, relinquishing any underlying resources.For example, this would close any open file and network streams and free database locks held by the dataset implementation.
The behaviour of the other dataset methods are undefined after closing the dataset.
Implementations might not need
close()
, hence the default implementation does nothing.- Specified by:
close
in interfaceAutoCloseable
- Throws:
Exception
-
getGraph
Graph getGraph()Get the default graph of this dataset.The
Triple
s of the default graph are equivalent to theQuad
s in this Dataset which has theQuad.getGraphName()
set toOptional.empty()
.It is unspecified if modifications to the returned Graph are reflected in this Dataset.
The returned graph MAY be empty.
- Returns:
- The default graph of this Dataset
- See Also:
-
getGraph
Get a named graph in this dataset.The
Triple
s of the named graph are equivalent to the the Quads of this Dataset which has theQuad.getGraphName()
equal to the providedgraphName
, or equal toOptional.empty()
if the providedgraphName
isnull
.It is unspecified if modifications to the returned Graph are reflected in this Dataset.
It is unspecified if requesting an unknown or empty graph will return
Optional.empty()
or create a new emptyGraph
.- Parameters:
graphName
- The name of the graph, ornull
for the default graph.- Returns:
- The named Graph, or
Optional.empty()
if the dataset do not contain the named graph. - See Also:
-
getGraphNames
Stream<BlankNodeOrIRI> getGraphNames()Get the graph names in this Dataset.The set of returned graph names is equivalent to the set of unique
Quad.getGraphName()
of all thestream()
of this dataset (excluding the default graph).The returned
Stream
SHOULD NOT contain duplicate graph names.The graph names can be used with
getGraph(BlankNodeOrIRI)
to retrieve the correspondingGraph
, however callers should be aware of any concurrent modifications to the Dataset may cause such calls to returnOptional.empty()
.Note that a Dataset always contains a default graph which is not named, and thus is not represented in the returned Stream. The default graph is accessible via
getGraph()
or by usingOptional.empty()
in the Quad access methods).- Returns:
- A
Stream
of the graph names of this Dataset.
-
remove
Remove a concrete quad from the dataset. -
remove
void remove(Optional<BlankNodeOrIRI> graphName, BlankNodeOrIRI subject, IRI predicate, RDFTerm object) Remove a concrete pattern of quads from the default graph of the dataset.- Parameters:
graphName
- The graph the quad belongs to, wrapped as anOptional
(null
is a wildcard,Optional.empty()
is the default graph)subject
- The quad subject (null
is a wildcard)predicate
- The quad predicate (null
is a wildcard)object
- The quad object (null
is a wildcard)
-
clear
void clear()Clear the dataset, removing all quads. -
size
long size()Number of quads contained by the dataset.The count of a set does not include duplicates, consistent with the
Quad.equals(Object)
equals method for eachQuad
. -
stream
Get all quads contained by the dataset.
The iteration does not contain any duplicate quads, as determined by the
Quad.equals(Object)
method for eachQuad
.The behaviour of the
Stream
is not specified ifadd(Quad)
,remove(Quad)
orclear()
are called on theDataset
before it terminates.Implementations may throw
ConcurrentModificationException
from Stream methods if they detect a conflict while the Stream is active. -
stream
Stream<? extends Quad> stream(Optional<BlankNodeOrIRI> graphName, BlankNodeOrIRI subject, IRI predicate, RDFTerm object) Get all quads contained by the dataset matched with the pattern.The iteration does not contain any duplicate quads, as determined by the
Quad.equals(Object)
method for eachQuad
.The behaviour of the
Stream
is not specified ifadd(Quad)
,remove(Quad)
orclear()
are called on theDataset
before it terminates.Implementations may throw
ConcurrentModificationException
from Stream methods if they detect a conflict while the Stream is active.- Parameters:
graphName
- The graph the quad belongs to, wrapped as anOptional
(null
is a wildcard,Optional.empty()
is the default graph)subject
- The quad subject (null
is a wildcard)predicate
- The quad predicate (null
is a wildcard)object
- The quad object (null
is a wildcard)- Returns:
- A
Stream
over the matched quads.
-
iterate
Get an Iterable for iterating over all quads in the dataset.This method is meant to be used with a Java for-each loop, e.g.:
for (Quad t : dataset.iterate()) { System.out.println(t); }
The behaviour of the iterator is not specified ifadd(Quad)
,remove(Quad)
orclear()
, are called on theDataset
before it terminates. It is undefined if the returnedIterator
supports theIterator.remove()
method.Implementations may throw
ConcurrentModificationException
from Iterator methods if they detect a concurrency conflict while the Iterator is active.The
Iterable.iterator()
must only be called once, that is the Iterable must only be iterated over once. AIllegalStateException
may be thrown on attempt to reuse the Iterable.The default implementation of this method will call
stream()
to return itsBaseStream.iterator()
.- Specified by:
iterate
in interfaceGraphLike<Quad>
- Returns:
- A
Iterable
that returnsIterator
over all of the quads in the dataset - Throws:
IllegalStateException
- if theIterable
has been reusedConcurrentModificationException
- if a concurrency conflict occurs while the Iterator is active.
-
iterate
default Iterable<Quad> iterate(Optional<BlankNodeOrIRI> graphName, BlankNodeOrIRI subject, IRI predicate, RDFTerm object) throws ConcurrentModificationException, IllegalStateException Get an Iterable for iterating over the quads in the dataset that match the pattern.This method is meant to be used with a Java for-each loop, e.g.:
IRI alice = factory.createIRI("http://example.com/alice"); IRI knows = factory.createIRI("http://xmlns.com/foaf/0.1/"); for (Quad t : dataset.iterate(null, alice, knows, null)) { System.out.println(t.getGraphName()); System.out.println(t.getObject()); }
The behaviour of the iterator is not specified if
add(Quad)
,remove(Quad)
orclear()
, are called on theDataset
before it terminates. It is undefined if the returnedIterator
supports theIterator.remove()
method.Implementations may throw
ConcurrentModificationException
from Iterator methods if they detect a concurrency conflict while the Iterator is active.The
Iterable.iterator()
must only be called once, that is the Iterable must only be iterated over once. AIllegalStateException
may be thrown on attempt to reuse the Iterable.The default implementation of this method will call
stream(Optional, BlankNodeOrIRI, IRI, RDFTerm)
to return itsBaseStream.iterator()
.- Parameters:
graphName
- The graph the quad belongs to, wrapped as anOptional
(null
is a wildcard,Optional.empty()
is the default graph)subject
- The quad subject (null
is a wildcard)predicate
- The quad predicate (null
is a wildcard)object
- The quad object (null
is a wildcard)- Returns:
- A
Iterable
that returnsIterator
over the matching quads in the dataset - Throws:
IllegalStateException
- if theIterable
has been reusedConcurrentModificationException
- if a concurrency conflict occurs while the Iterator is active.
-