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
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final ReentrantReadWriteLockDeprecated, for removal: This API element is subject to removal in a future version.protected final ReentrantLockDeprecated.Will be made private.protected boolean -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal voidaddStatement(Resource subj, IRI pred, Value obj, Resource... contexts) Adds a statement to the store.voidaddStatement(UpdateContext op, Resource subj, IRI pred, Value obj, Resource... contexts) The default implementation buffers added statements until the update operation is complete.protected abstract voidaddStatementInternal(Resource subj, IRI pred, Value obj, Resource... contexts) protected voidDeprecated.UseverifyIsActive()instead.voidbegin()Begins a transaction requiringSailConnection.commit()orSailConnection.rollback()to be called to close the transaction.voidbegin(IsolationLevel isolationLevel) Begins a transaction with the specifiedIsolationLevellevel, requiringSailConnection.commit()orSailConnection.rollback()to be called to close the transaction.final voidRemoves all statements from the specified/all contexts.protected abstract voidclearInternal(Resource... contexts) final voidRemoves all namespace declarations from the repository.protected abstract voidfinal voidclose()Closes the connection.protected abstract voidfinal voidcommit()Commits any updates that have been performed since the last timeSailConnection.commit()orSailConnection.rollback()was called.protected abstract voidfinal voidIndicates that the givenopwill not be used in any call again.protected voidfinal CloseableIteration<? extends BindingSet,QueryEvaluationException> 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,QueryEvaluationException> evaluateInternal(TupleExpr tupleExpr, Dataset dataset, BindingSet bindings, boolean includeInferred) voidflush()Flushes any pending updates and notify changes to listeners as appropriate.final CloseableIteration<? extends Resource,SailException> Returns the set of all unique context identifiers that are used to store statements.protected abstract CloseableIteration<? extends Resource,SailException> protected LockDeprecated, for removal: This API element is subject to removal in a future version.final StringgetNamespace(String prefix) Gets the namespace that is associated with the specified prefix, if any.protected abstract StringgetNamespaceInternal(String prefix) final CloseableIteration<? extends Namespace,SailException> Gets the namespaces relevant to the data contained in this Sail object.protected abstract CloseableIteration<? extends Namespace,SailException> getOwner()This is for internal use only.protected AbstractSailprotected LockDeprecated, for removal: This API element is subject to removal in a future version.final CloseableIteration<? extends Statement,SailException> 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 abstract CloseableIteration<? extends Statement,SailException> getStatementsInternal(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) protected IsolationLevelRetrieve the currently setIsolationLevel.protected LockDeprecated, for removal: This API element is subject to removal in a future version.final booleanhasStatement(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 booleanhasStatementInternal(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource[] contexts) booleanisActive()Indicates if a transaction is currently active on the connection.protected booleanfinal booleanisOpen()Checks whether this SailConnection is open.protected voiditerationClosed(org.eclipse.rdf4j.sail.helpers.SailBaseIteration<?, ?> iter) Called bySailBaseIterationto indicate that it has been closed.protected booleanbooleanIndicates if the Sail has any statement removal operations pending (not yetflushed) for the current transaction.final voidprepare()Checks for an error state in the active transaction that would force the transaction to be rolled back.protected voidprotected <T,E extends Exception>
CloseableIteration<T,E> registerIteration(CloseableIteration<T, E> iter) Registers an iteration as active by wrapping it in aSailBaseIterationobject and adding it to the list of active iterations.final voidremoveNamespace(String prefix) Removes a namespace declaration by removing the association between a prefix and a namespace name.protected abstract voidremoveNamespaceInternal(String prefix) voidremoveStatement(UpdateContext op, Resource subj, IRI pred, Value obj, Resource... contexts) The default implementation buffers removed statements until the update operation is complete.final voidremoveStatements(Resource subj, IRI pred, Value obj, Resource... contexts) Removes all statements matching the specified subject, predicate and object from the repository.protected abstract voidremoveStatementsInternal(Resource subj, IRI pred, Value obj, Resource... contexts) final voidrollback()Rolls back the transaction, discarding any uncommitted changes that have been made in this SailConnection.protected abstract voidfinal voidsetNamespace(String prefix, String name) Sets the prefix for a namespace.protected abstract voidsetNamespaceInternal(String prefix, String name) protected voidprotected voidfinal longReturns the number of (explicit) statements in the store, or in specific contexts.protected abstract longsizeInternal(Resource... contexts) protected abstract voidvoidSignals the start of an update operation.protected final booleanprotected voidVerifies if a transaction is currently active.protected voidvoidwaitForOtherOperations(boolean interrupt) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.rdf4j.sail.SailConnection
explain, prepareQuery, setTransactionSettings
-
Field Details
-
updateLock
Deprecated.Will be made private.Lock used to prevent concurrent calls to update methods like addStatement, clear, commit, etc. within a transaction. -
connectionLock
Deprecated, for removal: This API element is subject to removal in a future version. -
useConnectionLock
-
-
Constructor Details
-
AbstractSailConnection
-
-
Method Details
-
isOpen
Description copied from interface:SailConnectionChecks whether this SailConnection is open. A SailConnection is open from the moment it is created until it is closed.- Specified by:
isOpenin interfaceSailConnection- Throws:
SailException- See Also:
-
verifyIsOpen
- Throws:
SailException
-
verifyIsActive
Verifies if a transaction is currently active. Throws aSailExceptionif no transaction is active.- Throws:
SailException- if no transaction is active.
-
begin
Description copied from interface:SailConnectionBegins a transaction requiringSailConnection.commit()orSailConnection.rollback()to be called to close the transaction. The transaction will use the defaultIsolationLevellevel for the SAIL, as returned bySail.getDefaultIsolationLevel().- Specified by:
beginin 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:SailConnectionBegins a transaction with the specifiedIsolationLevellevel, requiringSailConnection.commit()orSailConnection.rollback()to be called to close the transaction.- Specified by:
beginin interfaceSailConnection- Parameters:
isolationLevel- the transaction isolation level on which this transaction operates.- Throws:
UnknownSailTransactionStateException- If the IsolationLevel is not supported by this implementationSailException- 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:SailConnectionIndicates 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:
isActivein interfaceSailConnection- Returns:
trueiff a transaction is active,falseiff 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:SailConnectionCloses 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:
closein interfaceAutoCloseable- Specified by:
closein interfaceSailConnection- Throws:
SailException
-
waitForOtherOperations
-
evaluate
public final CloseableIteration<? extends BindingSet,QueryEvaluationException> evaluate(TupleExpr tupleExpr, Dataset dataset, BindingSet bindings, boolean includeInferred) throws SailException Description copied from interface:SailConnectionEvaluates the supplied TupleExpr on the data contained in this Sail object, using the (optional) dataset and supplied bindings as input parameters.- Specified by:
evaluatein 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
public final CloseableIteration<? extends Resource,SailException> getContextIDs() throws SailExceptionDescription copied from interface:SailConnectionReturns the set of all unique context identifiers that are used to store statements.- Specified by:
getContextIDsin interfaceSailConnection- Returns:
- An iterator over the context identifiers, should not contain any duplicates.
- Throws:
SailException
-
getStatements
public final CloseableIteration<? extends Statement,SailException> getStatements(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) throws SailException Description copied from interface:SailConnectionGets 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:
getStatementsin 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.
-
hasStatement
public final boolean hasStatement(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) throws SailException Description copied from interface:SailConnectionDetermines 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:
hasStatementin 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:
trueiff the store contains any statements matching the supplied criteria,falseotherwise.- Throws:
SailException- If the Sail object encountered an error or unexpected situation internally.
-
hasStatementInternal
-
size
Description copied from interface:SailConnectionReturns the number of (explicit) statements in the store, or in specific contexts.- Specified by:
sizein 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:SailConnectionFlushes 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:
flushin interfaceSailConnection- Throws:
SailException- If the updates could not be processed, for example because no transaction is active.
-
prepare
Description copied from interface:SailConnectionChecks 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:
preparein interfaceSailConnection- 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). It does not indicate a problem with the integrity of the store.SailException- If there is an active transaction and it cannot be committed.
-
commit
Description copied from interface:SailConnectionCommits any updates that have been performed since the last timeSailConnection.commit()orSailConnection.rollback()was called.- Specified by:
commitin interfaceSailConnection- 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). It does not indicate a problem with the integrity of the store.SailException- If the SailConnection could not be committed.
-
rollback
Description copied from interface:SailConnectionRolls back the transaction, discarding any uncommitted changes that have been made in this SailConnection.- Specified by:
rollbackin interfaceSailConnection- 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). It does not indicate a problem with the integrity of the store.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:SailConnectionAdds a statement to the store.- Specified by:
addStatementin 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:SailConnectionRemoves all statements matching the specified subject, predicate and object from the repository. All three parameters may be null to indicate wildcards.- Specified by:
removeStatementsin 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:SailConnectionSignals the start of an update operation. The givenopmaybe passed to subsequentSailConnection.addStatement(UpdateContext, Resource, IRI, Value, Resource...)orSailConnection.removeStatement(UpdateContext, Resource, IRI, Value, Resource...)calls beforeSailConnection.endUpdate(UpdateContext)is called.- Specified by:
startUpdatein 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:
addStatementin interfaceSailConnection- Parameters:
op- operation properties of theUpdateExproperation 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:
removeStatementin interfaceSailConnection- Parameters:
op- operation properties of theUpdateExproperation 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:SailConnectionIndicates that the givenopwill not be used in any call again. Implementations should use this to flush of any temporary operation states that may have occurred.- Specified by:
endUpdatein interfaceSailConnection- Throws:
SailException
-
endUpdateInternal
- Throws:
SailException
-
clear
Description copied from interface:SailConnectionRemoves all statements from the specified/all contexts. If no contexts are specified the method operates on the entire repository.- Specified by:
clearin 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
public final CloseableIteration<? extends Namespace,SailException> getNamespaces() throws SailExceptionDescription copied from interface:SailConnectionGets the namespaces relevant to the data contained in this Sail object.- Specified by:
getNamespacesin 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:SailConnectionGets the namespace that is associated with the specified prefix, if any.- Specified by:
getNamespacein 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:SailConnectionSets the prefix for a namespace.- Specified by:
setNamespacein 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:SailConnectionRemoves a namespace declaration by removing the association between a prefix and a namespace name.- Specified by:
removeNamespacein 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:SailConnectionRemoves all namespace declarations from the repository.- Specified by:
clearNamespacesin interfaceSailConnection- Throws:
SailException- If the Sail object encountered an error or unexpected situation internally.
-
pendingRemovals
public boolean pendingRemovals()Description copied from interface:SailConnectionIndicates if the Sail has any statement removal operations pending (not yetflushed) for the current transaction.- Specified by:
pendingRemovalsin interfaceSailConnection- Returns:
- true if any statement removal operations have not yet been flushed, false otherwise.
- See Also:
-
pendingAdds
protected boolean pendingAdds() -
setStatementsAdded
protected void setStatementsAdded() -
setStatementsRemoved
protected void setStatementsRemoved() -
getExclusiveConnectionLock
Deprecated, for removal: This API element is subject to removal in a future version.- Throws:
SailException
-
getTransactionLock
Deprecated, for removal: This API element is subject to removal in a future version.- Throws:
SailException
-
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,E> registerIteration(CloseableIteration<T, E> iter) Registers an iteration as active by wrapping it in aSailBaseIterationobject and adding it to the list of active iterations. -
iterationClosed
protected void iterationClosed(org.eclipse.rdf4j.sail.helpers.SailBaseIteration<?, ?> iter) Called bySailBaseIterationto indicate that it has been closed. -
closeInternal
- Throws:
SailException
-
evaluateInternal
protected abstract CloseableIteration<? extends BindingSet,QueryEvaluationException> evaluateInternal(TupleExpr tupleExpr, Dataset dataset, BindingSet bindings, boolean includeInferred) throws SailException - Throws:
SailException
-
getContextIDsInternal
protected abstract CloseableIteration<? extends Resource,SailException> getContextIDsInternal() throws SailException- Throws:
SailException
-
getStatementsInternal
protected abstract CloseableIteration<? extends Statement,SailException> getStatementsInternal(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,SailException> getNamespacesInternal() throws SailException- Throws:
SailException
-
getNamespaceInternal
- Throws:
SailException
-
setNamespaceInternal
- Throws:
SailException
-
removeNamespaceInternal
- Throws:
SailException
-
clearNamespacesInternal
- Throws:
SailException
-
isActiveOperation
protected boolean isActiveOperation() -
getSailBase
-