- All Implemented Interfaces:
org.apache.jena.atlas.lib.Closeable
,org.apache.jena.atlas.lib.Sync
,DatasetGraph
,Transactional
- Direct Known Subclasses:
DatasetGraphMonitor
,DatasetGraphRDFS
,DatasetGraphReadOnly
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.jena.sparql.core.Transactional
Transactional.Promote
-
Constructor Summary
ConstructorsConstructorDescriptionCreate a operations wrapper arounddsg
.DatasetGraphWrapper
(DatasetGraph dsg, Context context) Create a operations wrapper arounddsg
withcontext
. -
Method Summary
Modifier and TypeMethodDescriptionvoid
abort()
Abort a transaction - finish the transaction and undo any changes (if a "write" transaction)void
Add a quadvoid
Add a quadvoid
Add the given graph to the dataset.void
begin()
Start a transaction which is READ mode and which will switch to WRITE if an update is attempted but only if no intermediate transaction has performed an update.void
Start either a READ or WRITE transaction.void
Start a transaction.
READ or WRITE transactions start in that state and do not change for the lifetime of the transaction.void
clear()
Remove everything - remove all named graphs, clear the default graphvoid
close()
Close the datasetvoid
commit()
Commit a transaction - finish the transaction and make any changes permanent (if a "write" transaction)boolean
Test whether the dataset (including default graph) contains a quad - may include wildcards, Node.ANY or nullboolean
Test whether the dataset contains a quad (including default graph)- may include wildcards, Node.ANY or nullboolean
containsGraph
(Node graphNode) Does the DatasetGraph contain a specific named graph? Whether a dataset contains a graph if there are no triples is not defined - see the specific implementation.void
Delete a quadvoid
Delete a quadvoid
Delete any quads matching the patternvoid
end()
Finish the transaction - if a write transaction and commit() has not been called, then abortfind()
Iterate over all quads in the dataset graphFind matching quads in the dataset (including default graph) - may include wildcards, Node.ANY or nullFind matching quads in the dataset - may include wildcards, Node.ANY or nullFind matching quads in the dataset in named graphs only - may include wildcards, Node.ANY or nullfinal DatasetGraph
getBase()
Recursively unwrap aDatasetGraphWrapper
.final DatasetGraph
Recursively unwrap aDatasetGraphWrapper
, stopping at aDatasetGraphWrapper
that indicate it is "view changing", ie shows quads to the base dataset graph.Get the context associated with this object - may be nullGet the default graph as a Jena GraphGet the graph named by graphNode : returns null when there is no such graph.getLock()
Return a lock for the dataset to help with concurrency controlReturn aGraph
that is the union of all named graphs in this dataset.final DatasetGraph
Return the DatasetGraph being wrapped.boolean
isEmpty()
Test whether the dataset is emptyboolean
Say whether inside a transaction.Iterate over all names of named graphsprefixes()
Prefixes for this DatasetGraphboolean
promote()
Attempt to promote a transaction from "read" to "write" when the transaction started with a "promote" mode (READ_PROMOTE
orREAD_COMMITTED_PROMOTE
).boolean
promote
(Transactional.Promote type) Attempt to promote a transaction from "read" mode to "write" and the transaction.void
removeGraph
(Node graphName) Remove all data associated with the named graph.void
Set the default graph.long
size()
Get the size (number of named graphs) - may be -1 for unknownboolean
Declare whetherTransactional.abort()
is supported.boolean
ADatasetGraph
supports transactions if it providesTransactional.begin()
/Transactional.commit()
/Transactional.end()
.void
sync()
toString()
Return the current mode of the transaction - "read" or "write".Return the transaction type used inbegin(TxnType)
.static DatasetGraph
unwrap
(DatasetGraph dsg) Unwrap aDatasetGraph
to find the baseDatasetGraph
.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.jena.sparql.core.DatasetGraph
addAll, stream, stream
Methods inherited from interface org.apache.jena.sparql.core.Transactional
calc, calculate, calculateRead, calculateWrite, exec, execute, executeRead, executeWrite
-
Constructor Details
-
DatasetGraphWrapper
-
DatasetGraphWrapper
Create a operations wrapper arounddsg
withcontext
.
-
-
Method Details
-
getWrapped
Return the DatasetGraph being wrapped. -
getBase
Recursively unwrap aDatasetGraphWrapper
.Note 1: Some use of DatasetGraphWrapper does not use the wrapped dataset stored in this object.
Note 2: TDB datasets require a transaction to unwrap.
- Returns:
- the first found
DatasetGraph
that is not an instance ofDatasetGraphWrapper
-
unwrap
Unwrap aDatasetGraph
to find the baseDatasetGraph
. CallsgetBase()
if the argument is aDatasetGraphWrapper
.Note 1: Some use of DatasetGraphWrapper does not use the wrapped dataset stored in this object.
Note 2: TDB datasets require a transaction to unwrap.
-
getBaseForQuery
Recursively unwrap aDatasetGraphWrapper
, stopping at aDatasetGraphWrapper
that indicate it is "view changing", ie shows quads to the base dataset graph.- Returns:
- the first found
DatasetGraph
that is not an instance ofDatasetGraphWrapper
-
containsGraph
Description copied from interface:DatasetGraph
Does the DatasetGraph contain a specific named graph? Whether a dataset contains a graph if there are no triples is not defined - see the specific implementation. Some datasets are "open" - they have all graphs even if no triples and this returns true always.- Specified by:
containsGraph
in interfaceDatasetGraph
- Returns:
- boolean
-
getDefaultGraph
Description copied from interface:DatasetGraph
Get the default graph as a Jena Graph- Specified by:
getDefaultGraph
in interfaceDatasetGraph
-
getUnionGraph
Description copied from interface:DatasetGraph
Return aGraph
that is the union of all named graphs in this dataset. This union graph is read-only (its prefix mapping in the current JVM may be changed but that may not persist).- Specified by:
getUnionGraph
in interfaceDatasetGraph
-
getGraph
Description copied from interface:DatasetGraph
Get the graph named by graphNode : returns null when there is no such graph. NB Whether a dataset contains a graph if there are no triples is not defined - see the specific implementation. Some datasets are "open" - they have all graphs even if no triples.- Specified by:
getGraph
in interfaceDatasetGraph
-
addGraph
Description copied from interface:DatasetGraph
Add the given graph to the dataset. Replaces any existing data for the named graph; to add data, get the graph and add triples to it, or add quads to the dataset. Do not assume that the same Java object is returned byDatasetGraph.getGraph(org.apache.jena.graph.Node)
- Specified by:
addGraph
in interfaceDatasetGraph
-
removeGraph
Description copied from interface:DatasetGraph
Remove all data associated with the named graph. This will include prefixes associated with the graph.- Specified by:
removeGraph
in interfaceDatasetGraph
-
setDefaultGraph
Description copied from interface:DatasetGraph
Set the default graph. This replaces the contents default graph, not merge data into it. Do not assume that the same object is returned byDatasetGraph.getDefaultGraph()
- Specified by:
setDefaultGraph
in interfaceDatasetGraph
-
getLock
Description copied from interface:DatasetGraph
Return a lock for the dataset to help with concurrency control- Specified by:
getLock
in interfaceDatasetGraph
- See Also:
-
listGraphNodes
Description copied from interface:DatasetGraph
Iterate over all names of named graphs- Specified by:
listGraphNodes
in interfaceDatasetGraph
-
add
Description copied from interface:DatasetGraph
Add a quad- Specified by:
add
in interfaceDatasetGraph
-
delete
Description copied from interface:DatasetGraph
Delete a quad- Specified by:
delete
in interfaceDatasetGraph
-
add
Description copied from interface:DatasetGraph
Add a quad- Specified by:
add
in interfaceDatasetGraph
-
delete
Description copied from interface:DatasetGraph
Delete a quad- Specified by:
delete
in interfaceDatasetGraph
-
deleteAny
Description copied from interface:DatasetGraph
Delete any quads matching the pattern- Specified by:
deleteAny
in interfaceDatasetGraph
-
clear
public void clear()Description copied from interface:DatasetGraph
Remove everything - remove all named graphs, clear the default graph- Specified by:
clear
in interfaceDatasetGraph
-
isEmpty
public boolean isEmpty()Description copied from interface:DatasetGraph
Test whether the dataset is empty- Specified by:
isEmpty
in interfaceDatasetGraph
-
prefixes
Description copied from interface:DatasetGraph
Prefixes for this DatasetGraph- Specified by:
prefixes
in interfaceDatasetGraph
-
find
Description copied from interface:DatasetGraph
Iterate over all quads in the dataset graph- Specified by:
find
in interfaceDatasetGraph
-
find
Description copied from interface:DatasetGraph
Find matching quads in the dataset - may include wildcards, Node.ANY or null- Specified by:
find
in interfaceDatasetGraph
- See Also:
-
find
Description copied from interface:DatasetGraph
Find matching quads in the dataset (including default graph) - may include wildcards, Node.ANY or null- Specified by:
find
in interfaceDatasetGraph
- See Also:
-
findNG
Description copied from interface:DatasetGraph
Find matching quads in the dataset in named graphs only - may include wildcards, Node.ANY or null- Specified by:
findNG
in interfaceDatasetGraph
- See Also:
-
contains
Description copied from interface:DatasetGraph
Test whether the dataset contains a quad (including default graph)- may include wildcards, Node.ANY or null- Specified by:
contains
in interfaceDatasetGraph
-
contains
Description copied from interface:DatasetGraph
Test whether the dataset (including default graph) contains a quad - may include wildcards, Node.ANY or null- Specified by:
contains
in interfaceDatasetGraph
-
getContext
Description copied from interface:DatasetGraph
Get the context associated with this object - may be null- Specified by:
getContext
in interfaceDatasetGraph
-
size
public long size()Description copied from interface:DatasetGraph
Get the size (number of named graphs) - may be -1 for unknown- Specified by:
size
in interfaceDatasetGraph
-
close
public void close()Description copied from interface:DatasetGraph
Close the dataset- Specified by:
close
in interfaceorg.apache.jena.atlas.lib.Closeable
- Specified by:
close
in interfaceDatasetGraph
-
toString
-
sync
public void sync()- Specified by:
sync
in interfaceorg.apache.jena.atlas.lib.Sync
-
begin
public void begin()Description copied from interface:Transactional
Start a transaction which is READ mode and which will switch to WRITE if an update is attempted but only if no intermediate transaction has performed an update.See
Transactional.begin(TxnType)
for more details an options.May not be implemented. See
Transactional.begin(ReadWrite)
is guaranteed to be provided.- Specified by:
begin
in interfaceTransactional
-
transactionMode
Description copied from interface:Transactional
Return the current mode of the transaction - "read" or "write". If the caller is not in a transaction, this method returns null.- Specified by:
transactionMode
in interfaceTransactional
-
transactionType
Description copied from interface:Transactional
Return the transaction type used inbegin(TxnType)
. If the caller is not in a transaction, this method returns null.- Specified by:
transactionType
in interfaceTransactional
-
begin
Description copied from interface:Transactional
Start a transaction.
READ or WRITE transactions start in that state and do not change for the lifetime of the transaction.WRITE
: this guarantees a WRITE will complete ifcommit()
is called. The same asbegin(ReadWrite.WRITE)
.READ
: the transaction can not promote to WRITE,ensuring read-only access to the data. The same asbegin(ReadWrite.READ)
.READ_PROMOTE
: the transaction will go from "read" to "write" if an update is attempted and if the dataset has not been changed by another write transaction. See alsoTransactional.promote()
.READ_COMMITTED_PROMOTE
: Use this with care. The promotion will succeed but changes from other transactions become visible.
begin
). IfREAD_PROMOTE
, the dataset must not have changed; ifREAD_COMMITTED_PROMOTE
any intermediate changes are visible but the application can not assume any data it has read in the transaction is the same as it was at the point the transaction started.This operation is optional and some implementations may throw a
JenaTransactionException
exception for some or allTxnType
values.See
Transactional.begin(ReadWrite)
for a form that is required of implementations.- Specified by:
begin
in interfaceTransactional
-
begin
Description copied from interface:Transactional
Start either a READ or WRITE transaction.- Specified by:
begin
in interfaceTransactional
-
promote
public boolean promote()Description copied from interface:Transactional
Attempt to promote a transaction from "read" to "write" when the transaction started with a "promote" mode (READ_PROMOTE
orREAD_COMMITTED_PROMOTE
).Returns "true" if the transaction is in write mode after the call. The method always succeeds of the transaction is already "write".
A
READ_COMMITTED_PROMOTE
can always be promoted, but the call may need to wait.This method returns true if a
READ_PROMOTE
orREAD_COMMITTED_PROMOTE
is promoted.This method returns false if a
READ_PROMOTE
can't be promoted - the transaction is still valid and in "read" mode. Any further calls topromote()
will also return false.This method returns false if there is an attempt to promote a "READ" transaction.
- Specified by:
promote
in interfaceTransactional
-
promote
Description copied from interface:Transactional
Attempt to promote a transaction from "read" mode to "write" and the transaction. This method allows the form of promotion to be specified. The transaction must not have been started withREAD
, which is read-only.An argument of
READ_PROMOTE
treats the promotion as if the transaction was started withREAD_PROMOTE
(any other writer commiting since the transaction started blocks promotion) andREAD_COMMITTED_PROMOTE
treats the promotion as if the transaction was started withREAD_COMMITTED_PROMOTE
(intemediate writer commits become visible).Returns "true" if the transaction is in write mode after the call. The method always succeeds of the transaction is already "write".
This method returns true if a
READ_PROMOTE
orREAD_COMMITTED_PROMOTE
is promoted.This method returns false if a
READ_PROMOTE
can't be promoted - the transaction is still valid and in "read" mode.This method throws an exception if there is an attempt to promote a
READ
transaction.- Specified by:
promote
in interfaceTransactional
-
commit
public void commit()Description copied from interface:Transactional
Commit a transaction - finish the transaction and make any changes permanent (if a "write" transaction)- Specified by:
commit
in interfaceTransactional
-
abort
public void abort()Description copied from interface:Transactional
Abort a transaction - finish the transaction and undo any changes (if a "write" transaction)- Specified by:
abort
in interfaceTransactional
-
end
public void end()Description copied from interface:Transactional
Finish the transaction - if a write transaction and commit() has not been called, then abort- Specified by:
end
in interfaceTransactional
-
isInTransaction
public boolean isInTransaction()Description copied from interface:Transactional
Say whether inside a transaction.- Specified by:
isInTransaction
in interfaceTransactional
-
supportsTransactions
public boolean supportsTransactions()Description copied from interface:DatasetGraph
ADatasetGraph
supports transactions if it providesTransactional.begin()
/Transactional.commit()
/Transactional.end()
. The core storageDatasetGraph
s provide fully serialized transactions. ADatasetGraph
that provides functionality across independent systems can not provide such strong guarantees. For example, it may use MRSW locking and some isolation control. Specifically, it would not necessarily provideTransactional.abort()
.See
DatasetGraph.supportsTransactionAbort()
forTransactional.abort()
. In addition, check details of a specific implementation.- Specified by:
supportsTransactions
in interfaceDatasetGraph
-
supportsTransactionAbort
public boolean supportsTransactionAbort()Description copied from interface:DatasetGraph
Declare whetherTransactional.abort()
is supported. This goes along with clearing up after exceptions inside application transaction code.- Specified by:
supportsTransactionAbort
in interfaceDatasetGraph
-