org.openrdf.sail.helpers
Class SynchronizedSailConnection

java.lang.Object
  org.openrdf.sail.helpers.SailConnectionWrapper
      org.openrdf.sail.helpers.SynchronizedSailConnection

All Implemented Interfaces:

SailConnection

Direct Known Subclasses:

SynchronizedInferencerConnection

public class SynchronizedSailConnection
extends SailConnectionWrapper

Wrapper class offering synchronization functionality for SailConnection implementations. This wrapper enforces two things:

• Calls to close() are exclusive. No other thread can call this method, nor any other method at the same time.
• Calls to update-related methods (add, remove, commit, etc.) are exclusive. These methods cannot be called simultaneously by multiple threads.

  Author:

  Arjohn Kampman, jeen, James Leigh

  Constructor Summary

  SynchronizedSailConnection(SailConnection wrappedCon)
  

  Method Summary

  void	addStatement(Resource subj, URI pred, Value obj, Resource... contexts) Adds a statement to each context in the specified contexts.
  void	clearNamespaces() Removes all namespace declarations from the repository.
  void	close() Closes the connection.
  void	commit() Commits any updates that have been performed since the last time SailConnection.commit() or SailConnection.rollback() was called.
  Cursor<? extends BindingSet>	evaluate(QueryModel query, 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.
  Cursor<? extends Resource>	getContextIDs() Returns the set of all unique context identifiers that are used to store statements.
  protected Lock	getExclusiveConnectionLock()
  String	getNamespace(String prefix) Gets the namespace that is mapped to the specified prefix.
  Cursor<? extends Namespace>	getNamespaces() Gets the namespaces relevant to the data contained in this Sail object.
  protected Lock	getSharedConnectionLock()
  Cursor<? extends Statement>	getStatements(Resource subj, URI pred, Value obj, boolean includeInferred, Resource... contexts) Gets all statements from the specified contexts that have a specific subject, predicate and/or object.
  protected Lock	getTransactionLock()
  void	removeNamespace(String prefix) Removes a namespace declaration by removing the association between a prefix and a namespace name.
  void	removeStatements(Resource subj, URI pred, Value obj, Resource... contexts) Removes all statements matching the specified subject, predicate and object from the repository.
  void	rollback() Rolls back the SailConnection, discarding any uncommitted changes that have been made in this SailConnection.
  void	setNamespace(String prefix, String name) Sets the prefix of a namespace.
  long	size(Resource subj, URI pred, Value obj, boolean includeInferred, Resource... contexts) Returns the number of statements matching the specified pattern.

  Methods inherited from class org.openrdf.sail.helpers.SailConnectionWrapper

  begin, getDelegate, getTransactionIsolation, getValueFactory, isAutoCommit, isOpen, isReadOnly, setReadOnly, setTransactionIsolation

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Constructor Detail

  SynchronizedSailConnection

  public SynchronizedSailConnection(SailConnection wrappedCon)

  Method Detail

  close

  public void close()
             throws StoreException

  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 interface SailConnection

  Overrides:

  close in class SailConnectionWrapper

  Throws:

  StoreException

  evaluate

  public Cursor<? extends BindingSet> evaluate(QueryModel query,
                                               BindingSet bindings,
                                               boolean includeInferred)
                                        throws StoreException

  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 interface SailConnection

  Overrides:

  evaluate in class SailConnectionWrapper

  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:

  StoreException - If the Sail object encountered an error or unexpected situation internally.

  getContextIDs

  public Cursor<? extends Resource> getContextIDs()
                                           throws StoreException

  Description copied from interface: SailConnection

  Returns the set of all unique context identifiers that are used to store statements.

  Specified by:

  getContextIDs in interface SailConnection

  Overrides:

  getContextIDs in class SailConnectionWrapper

  Returns:

  An iterator over the context identifiers, should not contain any duplicates.

  Throws:

  StoreException

  getStatements

  public Cursor<? extends Statement> getStatements(Resource subj,
                                                   URI pred,
                                                   Value obj,
                                                   boolean includeInferred,
                                                   Resource... contexts)
                                            throws StoreException

  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 interface SailConnection

  Overrides:

  getStatements in class SailConnectionWrapper

  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 available

  contexts - The context(s) to get the data from. Note that this parameter is a vararg and as such is optional. If no contexts are supplied the method operates on the entire repository.

  Returns:

  The statements matching the specified pattern.

  Throws:

  StoreException - If the Sail object encountered an error or unexpected situation internally.

  size

  public long size(Resource subj,
                   URI pred,
                   Value obj,
                   boolean includeInferred,
                   Resource... contexts)
            throws StoreException

  Description copied from interface: SailConnection

  Returns the number of statements matching the specified pattern.

  Specified by:

  size in interface SailConnection

  Overrides:

  size in class SailConnectionWrapper

  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 - Indicates whether inferred statements should be counted.

  contexts - The context(s) to get the data from. Note that this parameter is a vararg and as such is optional. If no contexts are supplied the method operates on the entire repository.

  Returns:

  The number of explicit statements in this Sail.

  Throws:

  StoreException

  commit

  public void commit()
              throws StoreException

  Description copied from interface: SailConnection

  Commits any updates that have been performed since the last time SailConnection.commit() or SailConnection.rollback() was called.

  Specified by:

  commit in interface SailConnection

  Overrides:

  commit in class SailConnectionWrapper

  Throws:

  StoreException - If the SailConnection could not be committed, or if the connection does not have an active connection.

  rollback

  public void rollback()
                throws StoreException

  Description copied from interface: SailConnection

  Rolls back the SailConnection, discarding any uncommitted changes that have been made in this SailConnection.

  Specified by:

  rollback in interface SailConnection

  Overrides:

  rollback in class SailConnectionWrapper

  Throws:

  StoreException - If the SailConnection could not be rolled back, or if the connection does not have an active connection.

  addStatement

  public void addStatement(Resource subj,
                           URI pred,
                           Value obj,
                           Resource... contexts)
                    throws StoreException

  Description copied from interface: SailConnection

  Adds a statement to each context in the specified contexts.

  Specified by:

  addStatement in interface SailConnection

  Overrides:

  addStatement in class SailConnectionWrapper

  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 supplied the method operates on the entire repository.

  Throws:

  StoreException - If the statement could not be added.

  removeStatements

  public void removeStatements(Resource subj,
                               URI pred,
                               Value obj,
                               Resource... contexts)
                        throws StoreException

  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 interface SailConnection

  Overrides:

  removeStatements in class SailConnectionWrapper

  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 supplied the method operates on the entire repository.

  Throws:

  StoreException - If the statement could not be removed.

  getNamespaces

  public Cursor<? extends Namespace> getNamespaces()
                                            throws StoreException

  Description copied from interface: SailConnection

  Gets the namespaces relevant to the data contained in this Sail object.

  Specified by:

  getNamespaces in interface SailConnection

  Overrides:

  getNamespaces in class SailConnectionWrapper

  Returns:

  An iterator over the relevant namespaces, should not contain any duplicates.

  Throws:

  StoreException - If the Sail object encountered an error or unexpected situation internally.

  getNamespace

  public String getNamespace(String prefix)
                      throws StoreException

  Description copied from interface: SailConnection

  Gets the namespace that is mapped to the specified prefix.

  Specified by:

  getNamespace in interface SailConnection

  Overrides:

  getNamespace in class SailConnectionWrapper

  Parameters:

  prefix - A namespace prefix.

  Returns:

  The namespace name that the specified prefix maps to.

  Throws:

  StoreException

  setNamespace

  public void setNamespace(String prefix,
                           String name)
                    throws StoreException

  Description copied from interface: SailConnection

  Sets the prefix of a namespace.

  Specified by:

  setNamespace in interface SailConnection

  Overrides:

  setNamespace in class SailConnectionWrapper

  Parameters:

  prefix - The new prefix.

  name - The namespace name that the prefix maps to.

  Throws:

  StoreException

  removeNamespace

  public void removeNamespace(String prefix)
                       throws StoreException

  Description copied from interface: SailConnection

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

  Specified by:

  removeNamespace in interface SailConnection

  Overrides:

  removeNamespace in class SailConnectionWrapper

  Parameters:

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

  Throws:

  StoreException - If the namespace prefix could not be removed.

  clearNamespaces

  public void clearNamespaces()
                       throws StoreException

  Description copied from interface: SailConnection

  Removes all namespace declarations from the repository.

  Specified by:

  clearNamespaces in interface SailConnection

  Overrides:

  clearNamespaces in class SailConnectionWrapper

  Throws:

  StoreException - If the namespaces could not be removed.

  getSharedConnectionLock

  protected Lock getSharedConnectionLock()
                                  throws StoreException

  Throws:

  StoreException

  getExclusiveConnectionLock

  protected Lock getExclusiveConnectionLock()
                                     throws StoreException

  Throws:

  StoreException

  getTransactionLock

  protected Lock getTransactionLock()
                             throws StoreException

  Throws:

  StoreException