Package org.eclipse.rdf4j.sail.helpers
Class AbstractSailConnection
java.lang.Object
org.eclipse.rdf4j.sail.helpers.AbstractSailConnection
- All Implemented Interfaces:
AutoCloseable
,SailConnection
- Direct Known Subclasses:
AbstractNotifyingSailConnection
,FedXConnection
Abstract Class offering base functionality for SailConnection implementations.
- Author:
- Arjohn Kampman, Jeen Broekstra
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
addStatement
(Resource subj, IRI pred, Value obj, Resource... contexts) Adds a statement to the store.void
addStatement
(UpdateContext op, Resource subj, IRI pred, Value obj, Resource... contexts) The default implementation buffers added statements until the update operation is complete.protected abstract void
addStatementInternal
(Resource subj, IRI pred, Value obj, Resource... contexts) protected void
Deprecated.void
begin()
Begins a transaction requiringSailConnection.commit()
orSailConnection.rollback()
to be called to close the transaction.void
begin
(IsolationLevel isolationLevel) Begins a transaction with the specifiedIsolationLevel
level, requiringSailConnection.commit()
orSailConnection.rollback()
to be called to close the transaction.final void
Removes all statements from the specified/all contexts.protected abstract void
clearInternal
(Resource... contexts) final void
Removes all namespace declarations from the repository.protected abstract void
final void
close()
Closes the connection.protected abstract void
final void
commit()
Commits any updates that have been performed since the last timeSailConnection.commit()
orSailConnection.rollback()
was called.protected abstract void
final void
Indicates that the givenop
will not be used in any call again.protected void
final CloseableIteration
<? extends BindingSet> evaluate
(TupleExpr tupleExpr, Dataset dataset, BindingSet bindings, boolean includeInferred) Evaluates the supplied TupleExpr on the data contained in this Sail object, using the (optional) dataset and supplied bindings as input parameters.protected abstract CloseableIteration
<? extends BindingSet> evaluateInternal
(TupleExpr tupleExpr, Dataset dataset, BindingSet bindings, boolean includeInferred) void
flush()
Flushes any pending updates and notify changes to listeners as appropriate.final CloseableIteration
<? extends Resource> Returns the set of all unique context identifiers that are used to store statements.protected abstract CloseableIteration
<? extends Resource> final String
getNamespace
(String prefix) Gets the namespace that is associated with the specified prefix, if any.protected abstract String
getNamespaceInternal
(String prefix) final CloseableIteration
<? extends Namespace> Gets the namespaces relevant to the data contained in this Sail object.protected abstract CloseableIteration
<? extends Namespace> getOwner()
This is for internal use only.protected AbstractSail
final CloseableIteration
<? extends Statement> getStatements
(StatementOrder order, Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) Gets all statements from the specified contexts that have a specific subject, predicate and/or object.final CloseableIteration
<? extends Statement> getStatements
(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) Gets all statements from the specified contexts that have a specific subject, predicate and/or object.protected CloseableIteration
<? extends Statement> getStatementsInternal
(StatementOrder order, Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) protected abstract CloseableIteration
<? extends Statement> getStatementsInternal
(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) protected IsolationLevel
Retrieve the currently setIsolationLevel
.final boolean
hasStatement
(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) Determines if the store contains any statements from the specified contexts that have a specific subject, predicate and/or object.protected boolean
hasStatementInternal
(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource[] contexts) boolean
isActive()
Indicates if a transaction is currently active on the connection.protected boolean
final boolean
isOpen()
Checks whether this SailConnection is open.protected void
iterationClosed
(org.eclipse.rdf4j.sail.helpers.SailBaseIteration<?, ?> iter) Called bySailBaseIteration
to indicate that it has been closed.protected boolean
final void
prepare()
Checks for an error state in the active transaction that would force the transaction to be rolled back.protected void
protected <T,
E extends Exception>
CloseableIteration<T> registerIteration
(CloseableIteration<T> iter) Registers an iteration as active by wrapping it in aSailBaseIteration
object and adding it to the list of active iterations.final void
removeNamespace
(String prefix) Removes a namespace declaration by removing the association between a prefix and a namespace name.protected abstract void
removeNamespaceInternal
(String prefix) void
removeStatement
(UpdateContext op, Resource subj, IRI pred, Value obj, Resource... contexts) The default implementation buffers removed statements until the update operation is complete.final void
removeStatements
(Resource subj, IRI pred, Value obj, Resource... contexts) Removes all statements matching the specified subject, predicate and object from the repository.protected abstract void
removeStatementsInternal
(Resource subj, IRI pred, Value obj, Resource... contexts) final void
rollback()
Rolls back the transaction, discarding any uncommitted changes that have been made in this SailConnection.protected abstract void
final void
setNamespace
(String prefix, String name) Sets the prefix for a namespace.protected abstract void
setNamespaceInternal
(String prefix, String name) protected void
protected void
final long
Returns the number of (explicit) statements in the store, or in specific contexts.protected abstract long
sizeInternal
(Resource... contexts) protected abstract void
void
Signals the start of an update operation.protected final boolean
protected void
Verifies if a transaction is currently active.protected void
void
waitForOtherOperations
(boolean interrupt) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.eclipse.rdf4j.sail.SailConnection
explain, getComparator, getSupportedOrders, prepareQuery, setTransactionSettings
-
Constructor Details
-
AbstractSailConnection
-
-
Method Details
-
isOpen
Description copied from interface:SailConnection
Checks whether this SailConnection is open. A SailConnection is open from the moment it is created until it is closed.- Specified by:
isOpen
in interfaceSailConnection
- Throws:
SailException
- See Also:
-
verifyIsOpen
- Throws:
SailException
-
verifyIsActive
Verifies if a transaction is currently active. Throws aSailException
if no transaction is active.- Throws:
SailException
- if no transaction is active.
-
begin
Description copied from interface:SailConnection
Begins a transaction requiringSailConnection.commit()
orSailConnection.rollback()
to be called to close the transaction. The transaction will use the defaultIsolationLevel
level for the SAIL, as returned bySail.getDefaultIsolationLevel()
.- Specified by:
begin
in interfaceSailConnection
- Throws:
SailException
- If the connection could not start a transaction or if a transaction is already active on this connection.
-
begin
Description copied from interface:SailConnection
Begins a transaction with the specifiedIsolationLevel
level, requiringSailConnection.commit()
orSailConnection.rollback()
to be called to close the transaction.- Specified by:
begin
in interfaceSailConnection
- Parameters:
isolationLevel
- the transaction isolation level on which this transaction operates.- Throws:
SailException
- If the connection could not start a transaction, if the supplied transaction isolation level is not supported, or if a transaction is already active on this connection.
-
getTransactionIsolation
Retrieve the currently setIsolationLevel
.- Returns:
- the current
IsolationLevel
. If no transaction is active, this may benull
.
-
isActive
Description copied from interface:SailConnection
Indicates if a transaction is currently active on the connection. A transaction is active ifSailConnection.begin()
has been called, and becomes inactive afterSailConnection.commit()
orSailConnection.rollback()
has been called.- Specified by:
isActive
in interfaceSailConnection
- Returns:
true
iff a transaction is active,false
iff no transaction is active.- Throws:
UnknownSailTransactionStateException
- if the transaction state can not be determined (this can happen for instance when communication between client and server fails or times out).
-
close
Description copied from interface:SailConnection
Closes the connection. Any updates that haven't been committed yet will be rolled back. The connection can no longer be used once it is closed.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceSailConnection
- Throws:
SailException
-
waitForOtherOperations
-
evaluate
public final CloseableIteration<? extends BindingSet> evaluate(TupleExpr tupleExpr, Dataset dataset, BindingSet bindings, boolean includeInferred) throws SailException Description copied from interface:SailConnection
Evaluates the supplied TupleExpr on the data contained in this Sail object, using the (optional) dataset and supplied bindings as input parameters.- Specified by:
evaluate
in interfaceSailConnection
- Parameters:
tupleExpr
- The tuple expression to evaluate.dataset
- The dataset to use for evaluating the query, null to use the Sail's default dataset.bindings
- A set of input parameters for the query evaluation. The keys reference variable names that should be bound to the value they map to.includeInferred
- Indicates whether inferred triples are to be considered in the query result. If false, no inferred statements are returned; if true, inferred statements are returned if available- Returns:
- The TupleQueryResult.
- Throws:
SailException
- If the Sail object encountered an error or unexpected situation internally.
-
getContextIDs
Description copied from interface:SailConnection
Returns the set of all unique context identifiers that are used to store statements.- Specified by:
getContextIDs
in interfaceSailConnection
- Returns:
- An iterator over the context identifiers, should not contain any duplicates.
- Throws:
SailException
-
getStatements
public final CloseableIteration<? extends Statement> getStatements(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) throws SailException Description copied from interface:SailConnection
Gets all statements from the specified contexts that have a specific subject, predicate and/or object. All three parameters may be null to indicate wildcards. The includeInferred parameter can be used to control which statements are fetched: all statements or only the statements that have been added explicitly.- Specified by:
getStatements
in interfaceSailConnection
- Parameters:
subj
- A Resource specifying the subject, or null for a wildcard.pred
- A URI specifying the predicate, or null for a wildcard.obj
- A Value specifying the object, or null for a wildcard.includeInferred
- if false, no inferred statements are returned; if true, inferred statements are returned if availablecontexts
- The context(s) to get the data from. Note that this parameter is a vararg and as such is optional. If no contexts are specified the method operates on the entire repository. A null value can be used to match context-less statements.- Returns:
- The statements matching the specified pattern.
- Throws:
SailException
- If the Sail object encountered an error or unexpected situation internally.
-
getStatements
public final CloseableIteration<? extends Statement> getStatements(StatementOrder order, Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) throws SailException Description copied from interface:SailConnection
Gets all statements from the specified contexts that have a specific subject, predicate and/or object. All three parameters may be null to indicate wildcards. The includeInferred parameter can be used to control which statements are fetched: all statements or only the statements that have been added explicitly.Statements are returned in the order specified by the statementOrder parameter. Use
SailConnection.getSupportedOrders(Resource, IRI, Value, Resource...)
to first retrieve the statement orders supported by this store for this statement pattern.Note that this method is experimental and may be changed or removed without notice.
- Specified by:
getStatements
in interfaceSailConnection
- Parameters:
order
- The order that the statements should be returned in.subj
- A Resource specifying the subject, or null for a wildcard.pred
- A URI specifying the predicate, or null for a wildcard.obj
- A Value specifying the object, or null for a wildcard.includeInferred
- if false, no inferred statements are returned; if true, inferred statements are returned if availablecontexts
- The context(s) to get the data from. Note that this parameter is a vararg and as such is optional. If no contexts are specified the method operates on the entire repository. A null value can be used to match context-less statements.- Returns:
- The statements matching the specified pattern.
- Throws:
SailException
- If the Sail object encountered an error or unexpected situation internally.
-
hasStatement
public final boolean hasStatement(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) throws SailException Description copied from interface:SailConnection
Determines if the store contains any statements from the specified contexts that have a specific subject, predicate and/or object. All three parameters may be null to indicate wildcards. The includeInferred parameter can be used to control which statements are checked: all statements or only the statements that have been added explicitly.- Specified by:
hasStatement
in interfaceSailConnection
- Parameters:
subj
- A Resource specifying the subject, or null for a wildcard.pred
- An IRI specifying the predicate, or null for a wildcard.obj
- A Value specifying the object, or null for a wildcard.includeInferred
- if false, no inferred statements are returned; if true, inferred statements are returned if availablecontexts
- The context(s) to get the data from. Note that this parameter is a vararg and as such is optional. If no contexts are specified the method operates on the entire repository. A null value can be used to match context-less statements.- Returns:
true
iff the store contains any statements matching the supplied criteria,false
otherwise.- Throws:
SailException
- If the Sail object encountered an error or unexpected situation internally.
-
hasStatementInternal
-
size
Description copied from interface:SailConnection
Returns the number of (explicit) statements in the store, or in specific contexts.- Specified by:
size
in interfaceSailConnection
- Parameters:
contexts
- The context(s) to determine the size of. Note that this parameter is a vararg and as such is optional. If no contexts are specified the method operates on the entire repository. A null value can be used to match context-less statements.- Returns:
- The number of explicit statements in this store, or in the specified context(s).
- Throws:
SailException
-
transactionActive
protected final boolean transactionActive() -
autoStartTransaction
Deprecated.UseverifyIsActive()
instead. We should not automatically start a transaction at the sail level. Instead, an exception should be thrown when an update is executed without first starting a transaction.IMPORTANT Since Sesame 2.7.0. this method no longer automatically starts a transaction, but instead verifies if a transaction is active and if not throws an exception. The method is left in for transitional purposes only. Sail implementors are advised that by contract, any update operation on the Sail should check if a transaction has been started viaSailConnection.isActive()
and throw a SailException if not. Implementors can useverifyIsActive()
as a convenience method for this check.- Throws:
SailException
- if no transaction is active.
-
flush
Description copied from interface:SailConnection
Flushes any pending updates and notify changes to listeners as appropriate. This is an optional call; calling or not calling this method should have no effect on the outcome of other calls. This method exists to give the caller more control over the efficiency when callingSailConnection.prepare()
. This method may be called multiple times within the same transaction.- Specified by:
flush
in interfaceSailConnection
- Throws:
SailException
- If the updates could not be processed, for example because no transaction is active.
-
prepare
Description copied from interface:SailConnection
Checks for an error state in the active transaction that would force the transaction to be rolled back. This is an optional call; calling or not calling this method should have no effect on the outcome ofSailConnection.commit()
orSailConnection.rollback()
. A call to this method must be followed by (in the same thread) with a call toSailConnection.prepare()
,SailConnection.commit()
,SailConnection.rollback()
, orSailConnection.close()
. This method may be called multiple times within the same transaction by the same thread. If this method returns normally, the caller can reasonably expect that a subsequent call toSailConnection.commit()
will also return normally. If this method returns with an exception the caller should treat the exception as if it came from a call toSailConnection.commit()
.- Specified by:
prepare
in interfaceSailConnection
- Throws:
SailException
- If there is an active transaction and it cannot be committed.
-
commit
Description copied from interface:SailConnection
Commits any updates that have been performed since the last timeSailConnection.commit()
orSailConnection.rollback()
was called.- Specified by:
commit
in interfaceSailConnection
- Throws:
SailException
- If the SailConnection could not be committed.
-
rollback
Description copied from interface:SailConnection
Rolls back the transaction, discarding any uncommitted changes that have been made in this SailConnection.- Specified by:
rollback
in interfaceSailConnection
- Throws:
SailException
- If the SailConnection could not be rolled back.
-
addStatement
public final void addStatement(Resource subj, IRI pred, Value obj, Resource... contexts) throws SailException Description copied from interface:SailConnection
Adds a statement to the store.- Specified by:
addStatement
in interfaceSailConnection
- Parameters:
subj
- The subject of the statement to add.pred
- The predicate of the statement to add.obj
- The object of the statement to add.contexts
- The context(s) to add the statement to. Note that this parameter is a vararg and as such is optional. If no contexts are specified, a context-less statement will be added.- Throws:
SailException
- If the statement could not be added, for example because no transaction is active.
-
removeStatements
public final void removeStatements(Resource subj, IRI pred, Value obj, Resource... contexts) throws SailException Description copied from interface:SailConnection
Removes all statements matching the specified subject, predicate and object from the repository. All three parameters may be null to indicate wildcards.- Specified by:
removeStatements
in interfaceSailConnection
- Parameters:
subj
- The subject of the statement that should be removed, or null to indicate a wildcard.pred
- The predicate of the statement that should be removed, or null to indicate a wildcard.obj
- The object of the statement that should be removed , or null to indicate a wildcard. *contexts
- The context(s) from which to remove the statement. Note that this parameter is a vararg and as such is optional. If no contexts are specified the method operates on the entire repository. A null value can be used to match context-less statements.- Throws:
SailException
- If the statement could not be removed, for example because no transaction is active.
-
startUpdate
Description copied from interface:SailConnection
Signals the start of an update operation. The givenop
maybe passed to subsequentSailConnection.addStatement(UpdateContext, Resource, IRI, Value, Resource...)
orSailConnection.removeStatement(UpdateContext, Resource, IRI, Value, Resource...)
calls beforeSailConnection.endUpdate(UpdateContext)
is called.- Specified by:
startUpdate
in interfaceSailConnection
- Throws:
SailException
-
addStatement
public void addStatement(UpdateContext op, Resource subj, IRI pred, Value obj, Resource... contexts) throws SailException The default implementation buffers added statements until the update operation is complete.- Specified by:
addStatement
in interfaceSailConnection
- Parameters:
op
- operation properties of theUpdateExpr
operation producing these statements.subj
- The subject of the statement to add.pred
- The predicate of the statement to add.obj
- The object of the statement to add.contexts
- The context(s) to add the statement to. Note that this parameter is a vararg and as such is optional. If no contexts are specified, a context-less statement will be added.- Throws:
SailException
- If the statement could not be added, for example because no transaction is active.
-
removeStatement
public void removeStatement(UpdateContext op, Resource subj, IRI pred, Value obj, Resource... contexts) throws SailException The default implementation buffers removed statements until the update operation is complete.- Specified by:
removeStatement
in interfaceSailConnection
- Parameters:
op
- operation properties of theUpdateExpr
operation removing these statements.subj
- The subject of the statement that should be removed.pred
- The predicate of the statement that should be removed.obj
- The object of the statement that should be removed.contexts
- The context(s) from which to remove the statement. Note that this parameter is a vararg and as such is optional. If no contexts are specified the method operates on the entire repository. A null value can be used to match context-less statements.- Throws:
SailException
- If the statement could not be removed, for example because no transaction is active.
-
endUpdate
Description copied from interface:SailConnection
Indicates that the givenop
will not be used in any call again. Implementations should use this to flush of any temporary operation states that may have occurred.- Specified by:
endUpdate
in interfaceSailConnection
- Parameters:
op
-- Throws:
SailException
-
endUpdateInternal
- Throws:
SailException
-
clear
Description copied from interface:SailConnection
Removes all statements from the specified/all contexts. If no contexts are specified the method operates on the entire repository.- Specified by:
clear
in interfaceSailConnection
- Parameters:
contexts
- The context(s) from which to remove the statements. Note that this parameter is a vararg and as such is optional. If no contexts are specified the method operates on the entire repository. A null value can be used to match context-less statements.- Throws:
SailException
- If the statements could not be removed.
-
getNamespaces
Description copied from interface:SailConnection
Gets the namespaces relevant to the data contained in this Sail object.- Specified by:
getNamespaces
in interfaceSailConnection
- Returns:
- An iterator over the relevant namespaces, should not contain any duplicates.
- Throws:
SailException
- If the Sail object encountered an error or unexpected situation internally.
-
getNamespace
Description copied from interface:SailConnection
Gets the namespace that is associated with the specified prefix, if any.- Specified by:
getNamespace
in interfaceSailConnection
- Parameters:
prefix
- A namespace prefix, or an empty string in case of the default namespace.- Returns:
- The namespace name that is associated with the specified prefix, or null if there is no such namespace.
- Throws:
SailException
- If the Sail object encountered an error or unexpected situation internally.
-
setNamespace
Description copied from interface:SailConnection
Sets the prefix for a namespace.- Specified by:
setNamespace
in interfaceSailConnection
- Parameters:
prefix
- The new prefix, or an empty string in case of the default namespace.name
- The namespace name that the prefix maps to.- Throws:
SailException
- If the Sail object encountered an error or unexpected situation internally.
-
removeNamespace
Description copied from interface:SailConnection
Removes a namespace declaration by removing the association between a prefix and a namespace name.- Specified by:
removeNamespace
in interfaceSailConnection
- Parameters:
prefix
- The namespace prefix, or an empty string in case of the default namespace.- Throws:
SailException
- If the Sail object encountered an error or unexpected situation internally.
-
clearNamespaces
Description copied from interface:SailConnection
Removes all namespace declarations from the repository.- Specified by:
clearNamespaces
in interfaceSailConnection
- Throws:
SailException
- If the Sail object encountered an error or unexpected situation internally.
-
pendingAdds
protected boolean pendingAdds() -
setStatementsAdded
protected void setStatementsAdded() -
setStatementsRemoved
protected void setStatementsRemoved() -
getOwner
This is for internal use only. It returns the thread that opened this connection.- Returns:
- the thread that opened this connection.
-
registerIteration
protected <T,E extends Exception> CloseableIteration<T> registerIteration(CloseableIteration<T> iter) Registers an iteration as active by wrapping it in aSailBaseIteration
object and adding it to the list of active iterations. -
iterationClosed
protected void iterationClosed(org.eclipse.rdf4j.sail.helpers.SailBaseIteration<?, ?> iter) Called bySailBaseIteration
to indicate that it has been closed. -
closeInternal
- Throws:
SailException
-
evaluateInternal
protected abstract CloseableIteration<? extends BindingSet> evaluateInternal(TupleExpr tupleExpr, Dataset dataset, BindingSet bindings, boolean includeInferred) throws SailException - Throws:
SailException
-
getContextIDsInternal
protected abstract CloseableIteration<? extends Resource> getContextIDsInternal() throws SailException- Throws:
SailException
-
getStatementsInternal
protected abstract CloseableIteration<? extends Statement> getStatementsInternal(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) throws SailException - Throws:
SailException
-
getStatementsInternal
protected CloseableIteration<? extends Statement> getStatementsInternal(StatementOrder order, Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) throws SailException - Throws:
SailException
-
sizeInternal
- Throws:
SailException
-
startTransactionInternal
- Throws:
SailException
-
prepareInternal
- Throws:
SailException
-
commitInternal
- Throws:
SailException
-
rollbackInternal
- Throws:
SailException
-
addStatementInternal
protected abstract void addStatementInternal(Resource subj, IRI pred, Value obj, Resource... contexts) throws SailException - Throws:
SailException
-
removeStatementsInternal
protected abstract void removeStatementsInternal(Resource subj, IRI pred, Value obj, Resource... contexts) throws SailException - Throws:
SailException
-
clearInternal
- Throws:
SailException
-
getNamespacesInternal
protected abstract CloseableIteration<? extends Namespace> getNamespacesInternal() throws SailException- Throws:
SailException
-
getNamespaceInternal
- Throws:
SailException
-
setNamespaceInternal
- Throws:
SailException
-
removeNamespaceInternal
- Throws:
SailException
-
clearNamespacesInternal
- Throws:
SailException
-
isActiveOperation
protected boolean isActiveOperation() -
getSailBase
-
verifyIsActive()
instead.