org.openrdf.repository.sail

Class SailRepositoryConnection

java.lang.Object

org.openrdf.repository.base.AbstractRepositoryConnection

org.openrdf.repository.sail.SailRepositoryConnection

All Implemented Interfaces:

AutoCloseable, HttpClientDependent, SesameClientDependent, FederatedServiceResolverClient, RepositoryConnection, RepositoryResolverClient

public class SailRepositoryConnection
extends AbstractRepositoryConnection
implements FederatedServiceResolverClient, RepositoryResolverClient, HttpClientDependent, SesameClientDependent

An implementation of the RepositoryConnection interface that wraps a SailConnection.

Author:

Jeen Broekstra, Arjohn Kampman

Field Summary

Fields inherited from class org.openrdf.repository.base.AbstractRepositoryConnection

logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SailRepositoryConnection(SailRepository repository, SailConnection sailConnection) Creates a new repository connection that will wrap the supplied SailConnection.

Method Summary

Modifier and Type	Method and Description
protected void	addWithoutCommit(Resource subject, IRI predicate, Value object, Resource... contexts)
void	begin() Begins a new transaction, requiring RepositoryConnection.commit() or RepositoryConnection.rollback() to be called to end the transaction.
void	begin(IsolationLevel level) Begins a new transaction with the supplied IsolationLevel, requiring RepositoryConnection.commit() or RepositoryConnection.rollback() to be called to end the transaction.
void	clear(Resource... contexts) Removes all statements from a specific contexts in the repository.
void	clearNamespaces() Removes all namespace declarations from the repository.
void	close() Closes the connection, freeing resources.
void	commit() Commits the active transaction.
protected <E> RepositoryResult<E>	createRepositoryResult(CloseableIteration<? extends E,SailException> sailIter) Wraps a CloseableIteration coming from a Sail in a RepositoryResult object, applying the required conversions
void	exportStatements(Resource subj, IRI pred, Value obj, boolean includeInferred, RDFHandler handler, Resource... contexts) Exports all statements with a specific subject, predicate and/or object from the repository, optionally from the specified contexts.
RepositoryResult<Resource>	getContextIDs() Gets all resources that are used as content identifiers.
org.apache.http.client.HttpClient	getHttpClient() HttpClient that has been assigned or has been used by this object.
String	getNamespace(String prefix) Gets the namespace that is associated with the specified prefix, if any.
RepositoryResult<Namespace>	getNamespaces() Gets all declared namespaces as a RepositoryResult of Namespace objects.
SailConnection	getSailConnection() Returns the underlying SailConnection.
SesameClient	getSesameClient() SesameClient that has been assigned or has been used by this object.
RepositoryResult<Statement>	getStatements(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) Gets all statements with a specific subject, predicate and/or object from the repository.
boolean	hasStatement(Resource subj, IRI pred, Value obj, boolean includeInferred, Resource... contexts) Checks whether the repository contains statements with a specific subject, predicate and/or object, optionally in the specified contexts.
boolean	isActive() Indicates if a transaction is currently active on the connection.
boolean	isEmpty() Returns true if this repository does not contain any (explicit) statements.
boolean	isOpen() Checks whether this connection is open.
SailBooleanQuery	prepareBooleanQuery(QueryLanguage ql, String queryString, String baseURI) Prepares queries that return true or false.
SailGraphQuery	prepareGraphQuery(QueryLanguage ql, String queryString, String baseURI) Prepares queries that produce RDF graphs.
SailQuery	prepareQuery(QueryLanguage ql, String queryString, String baseURI) Prepares a query for evaluation on this repository (optional operation).
SailTupleQuery	prepareTupleQuery(QueryLanguage ql, String queryString, String baseURI) Prepares a query that produces sets of value tuples.
Update	prepareUpdate(QueryLanguage ql, String update, String baseURI) Prepares an Update operation.
void	removeNamespace(String prefix) Removes a namespace declaration by removing the association between a prefix and a namespace name.
protected void	removeWithoutCommit(Resource subject, IRI predicate, Value object, Resource... contexts)
void	rollback() Rolls back all updates in the active transaction.
void	setFederatedServiceResolver(FederatedServiceResolver resolver) Sets the FederatedServiceResolver to use for this client.
void	setHttpClient(org.apache.http.client.HttpClient client) Assign an HttpClient that this object should use.
void	setNamespace(String prefix, String name) Sets the prefix for a namespace.
void	setRepositoryResolver(RepositoryResolver resolver)
void	setSesameClient(SesameClient client) Assign an SesameClient that this object should use.
long	size(Resource... contexts) Returns the number of (explicit) statements that are in the specified contexts in this repository.
String	toString()

Methods inherited from class org.openrdf.repository.base.AbstractRepositoryConnection

add, add, add, add, add, add, add, add, addWithoutCommit, conditionalCommit, conditionalRollback, export, getIsolationLevel, getParserConfig, getRepository, getValueFactory, hasStatement, isAutoCommit, prepareBooleanQuery, prepareGraphQuery, prepareQuery, prepareTupleQuery, prepareUpdate, remove, remove, remove, remove, removeWithoutCommit, setAutoCommit, setIsolationLevel, setParserConfig, startLocalTransaction

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openrdf.repository.RepositoryConnection

add, getStatements, getStatements, hasStatement, prepareBooleanQuery, prepareGraphQuery, prepareQuery, prepareTupleQuery, prepareUpdate, remove

Constructor Detail

SailRepositoryConnection

protected SailRepositoryConnection(SailRepository repository,
                                   SailConnection sailConnection)

Creates a new repository connection that will wrap the supplied SailConnection. SailRepositoryConnection objects are created by SailRepository.getConnection().

Method Detail

getSailConnection

public SailConnection getSailConnection()

Returns the underlying SailConnection.

setFederatedServiceResolver

public void setFederatedServiceResolver(FederatedServiceResolver resolver)

Description copied from interface: FederatedServiceResolverClient

Sets the FederatedServiceResolver to use for this client.

Specified by:

setFederatedServiceResolver in interface FederatedServiceResolverClient

Parameters:

resolver - The resolver to use.

setRepositoryResolver

public void setRepositoryResolver(RepositoryResolver resolver)

Specified by:

setRepositoryResolver in interface RepositoryResolverClient

getSesameClient

public SesameClient getSesameClient()

Description copied from interface: SesameClientDependent

SesameClient that has been assigned or has been used by this object. The life cycle might not be or might be tied to this object, depending on whether SesameClient was passed to or created by this object respectively.

Specified by:

getSesameClient in interface SesameClientDependent

Returns:

a SesameClient instance or null

setSesameClient

public void setSesameClient(SesameClient client)

Description copied from interface: SesameClientDependent

Assign an SesameClient that this object should use. The life cycle of the given SesameClient is independent of this object. Closing or shutting down this object does not have any impact on the given client. Callers must ensure that the given client is properly closed elsewhere.

Specified by:

setSesameClient in interface SesameClientDependent

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

Description copied from interface: HttpClientDependent

HttpClient that has been assigned or has been used by this object. The life cycle might not be or might be tied to this object, depending on whether HttpClient was passed to or created by this object respectively.

Specified by:

getHttpClient in interface HttpClientDependent

Returns:

an HttpClient instance or null

setHttpClient

public void setHttpClient(org.apache.http.client.HttpClient client)

Description copied from interface: HttpClientDependent

Assign an HttpClient that this object should use. The life cycle of the given HttpClient is independent of this object. Closing or shutting down this object does not have any impact on the given client. Callers must ensure that the given client is properly closed elsewhere.

Specified by:

setHttpClient in interface HttpClientDependent

begin

public void begin()
           throws RepositoryException

Description copied from interface: RepositoryConnection

Begins a new transaction, requiring RepositoryConnection.commit() or RepositoryConnection.rollback() to be called to end the transaction. The transaction will use the currently set isolation level for this connection.

Specified by:

begin in interface RepositoryConnection

Throws:

RepositoryException - If the connection could not start the transaction. One possible reason this may happen is if a transaction is already active on the current connection.

See Also:

RepositoryConnection.begin(IsolationLevel), RepositoryConnection.isActive(), RepositoryConnection.commit(), RepositoryConnection.rollback(), RepositoryConnection.setIsolationLevel(IsolationLevel)

begin

public void begin(IsolationLevel level)
           throws RepositoryException

Description copied from interface: RepositoryConnection

Begins a new transaction with the supplied IsolationLevel, requiring RepositoryConnection.commit() or RepositoryConnection.rollback() to be called to end the transaction.

Specified by:

begin in interface RepositoryConnection

Overrides:

begin in class AbstractRepositoryConnection

Parameters:

level - The IsolationLevel at which this transaction will operate. If set to null the default isolation level of the underlying store will be used. If the specified isolation level is not supported by the underlying store, it will attempt to use a supported compatible level instead.

Throws:

RepositoryException - If the connection could not start the transaction. Possible reasons this may happen are:

• a transaction is already active on the current connection.
• the specified IsolationLevel is not supported by the store, and no compatible level could be found.

See Also:

RepositoryConnection.begin(), RepositoryConnection.isActive(), RepositoryConnection.commit(), RepositoryConnection.rollback(), #setIsolationLevel()

commit

public void commit()
            throws RepositoryException

Description copied from interface: RepositoryConnection

Commits the active transaction. This operation ends the active transaction.

Specified by:

commit in interface RepositoryConnection

Throws:

UnknownTransactionStateException - if the transaction state can not be determined. This can happen for instance when communication with a repository fails or times out.

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

See Also:

RepositoryConnection.isActive(), RepositoryConnection.begin(), RepositoryConnection.rollback()

rollback

public void rollback()
              throws RepositoryException

Description copied from interface: RepositoryConnection

Rolls back all updates in the active transaction. This operation ends the active transaction.

Specified by:

rollback in interface RepositoryConnection

Throws:

UnknownTransactionStateException - if the transaction state can not be determined. This can happen for instance when communication with a repository fails or times out.

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

See Also:

RepositoryConnection.isActive(), RepositoryConnection.begin(), RepositoryConnection.commit()

close

public void close()
           throws RepositoryException

Description copied from interface: RepositoryConnection

Closes the connection, freeing resources. If a transaction is active on the connection, all non-committed operations will be lost by actively calling RepositoryConnection.rollback() on any active transactions.

Implementation note: All implementations must override this method if they have any resources that they need to free.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface RepositoryConnection

Overrides:

close in class AbstractRepositoryConnection

Throws:

RepositoryException - If the connection could not be closed.

isOpen

public boolean isOpen()
               throws RepositoryException

Description copied from interface: RepositoryConnection

Checks whether this connection is open. A connection is open from the moment it is created until it is closed.

Specified by:

isOpen in interface RepositoryConnection

Overrides:

isOpen in class AbstractRepositoryConnection

Throws:

RepositoryException

See Also:

RepositoryConnection.close()

prepareQuery

public SailQuery prepareQuery(QueryLanguage ql,
                              String queryString,
                              String baseURI)
                       throws MalformedQueryException

Description copied from interface: RepositoryConnection

Prepares a query for evaluation on this repository (optional operation).

Specified by:

prepareQuery in interface RepositoryConnection

Parameters:

ql - The query language in which the query is formulated.

queryString - The query string.

baseURI - The base URI to resolve any relative URIs that are in the query against, can be null if the query does not contain any relative URIs.

Returns:

A query ready to be evaluated on this repository.

Throws:

MalformedQueryException - If the supplied query is malformed.

prepareTupleQuery

public SailTupleQuery prepareTupleQuery(QueryLanguage ql,
                                        String queryString,
                                        String baseURI)
                                 throws MalformedQueryException

Description copied from interface: RepositoryConnection

Prepares a query that produces sets of value tuples.

Specified by:

prepareTupleQuery in interface RepositoryConnection

Parameters:

ql - The query language in which the query is formulated.

queryString - The query string.

baseURI - The base URI to resolve any relative URIs that are in the query against, can be null if the query does not contain any relative URIs.

Returns:

a TupleQuery ready to be evaluated on this RepositoryConnection.

Throws:

MalformedQueryException - If the supplied query is malformed.

prepareGraphQuery

public SailGraphQuery prepareGraphQuery(QueryLanguage ql,
                                        String queryString,
                                        String baseURI)
                                 throws MalformedQueryException

Description copied from interface: RepositoryConnection

Prepares queries that produce RDF graphs.

Specified by:

prepareGraphQuery in interface RepositoryConnection

Parameters:

ql - The query language in which the query is formulated.

queryString - The query string.

baseURI - The base URI to resolve any relative URIs that are in the query against, can be null if the query does not contain any relative URIs.

Returns:

a GraphQuery ready to be evaluated on this RepositoryConnection.

Throws:

MalformedQueryException - If the supplied query is malformed.

prepareBooleanQuery

public SailBooleanQuery prepareBooleanQuery(QueryLanguage ql,
                                            String queryString,
                                            String baseURI)
                                     throws MalformedQueryException

Description copied from interface: RepositoryConnection

Prepares queries that return true or false.

Specified by:

prepareBooleanQuery in interface RepositoryConnection

Parameters:

ql - The query language in which the query is formulated.

queryString - The query string.

baseURI - The base URI to resolve any relative URIs that are in the query against, can be null if the query does not contain any relative URIs.

Returns:

a BooleanQuery ready to be evaluated on this RepositoryConnection.

Throws:

MalformedQueryException - If the supplied query is malformed.

prepareUpdate

public Update prepareUpdate(QueryLanguage ql,
                            String update,
                            String baseURI)
                     throws RepositoryException,
                            MalformedQueryException

Description copied from interface: RepositoryConnection

Prepares an Update operation.

Specified by:

prepareUpdate in interface RepositoryConnection

Parameters:

ql - The query language in which the update operation is formulated.

update - The update operation string.

baseURI - The base URI to resolve any relative URIs that are in the update against, can be null if the update does not contain any relative URIs.

Returns:

a Update ready to be executed on this RepositoryConnection.

Throws:

MalformedQueryException - If the supplied update operation string is malformed.

RepositoryException

hasStatement

public boolean hasStatement(Resource subj,
                            IRI pred,
                            Value obj,
                            boolean includeInferred,
                            Resource... contexts)
                     throws RepositoryException

Description copied from interface: RepositoryConnection

Checks whether the repository contains statements with a specific subject, predicate and/or object, optionally in the specified contexts.

Specified by:

hasStatement in interface RepositoryConnection

Overrides:

hasStatement in class AbstractRepositoryConnection

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 considered; if true, inferred statements are considered if available

contexts - The context(s) the need to be searched. 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:

true If a matching statement is in the repository in the specified context, false otherwise.

Throws:

RepositoryException

getContextIDs

public RepositoryResult<Resource> getContextIDs()
                                         throws RepositoryException

Description copied from interface: RepositoryConnection

Gets all resources that are used as content identifiers. Care should be taken that the returned RepositoryResult is closed to free any resources that it keeps hold of.

Specified by:

getContextIDs in interface RepositoryConnection

Returns:

a RepositoryResult object containing Resources that are used as context identifiers.

Throws:

RepositoryException

getStatements

public RepositoryResult<Statement> getStatements(Resource subj,
                                                 IRI pred,
                                                 Value obj,
                                                 boolean includeInferred,
                                                 Resource... contexts)
                                          throws RepositoryException

Description copied from interface: RepositoryConnection

Gets all statements with a specific subject, predicate and/or object from the repository. The result is optionally restricted to the specified set of named contexts.

Specified by:

getStatements in interface RepositoryConnection

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 available. The default is true.

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. The result object is a RepositoryResult object, a lazy Iterator-like object containing Statements and optionally throwing a RepositoryException when an error when a problem occurs during retrieval.

Throws:

RepositoryException

isEmpty

public boolean isEmpty()
                throws RepositoryException

Description copied from interface: RepositoryConnection

Returns true if this repository does not contain any (explicit) statements.

Specified by:

isEmpty in interface RepositoryConnection

Overrides:

isEmpty in class AbstractRepositoryConnection

Returns:

true if this repository is empty, false otherwise.

Throws:

RepositoryException - If the repository could not be checked to be empty.

exportStatements

public void exportStatements(Resource subj,
                             IRI pred,
                             Value obj,
                             boolean includeInferred,
                             RDFHandler handler,
                             Resource... contexts)
                      throws RepositoryException,
                             RDFHandlerException

Description copied from interface: RepositoryConnection

Exports all statements with a specific subject, predicate and/or object from the repository, optionally from the specified contexts.

Specified by:

exportStatements in interface RepositoryConnection

Parameters:

subj - The subject, or null if the subject doesn't matter.

pred - The predicate, or null if the predicate doesn't matter.

obj - The object, or null if the object doesn't matter.

includeInferred - if false, no inferred statements are returned; if true, inferred statements are returned if available

handler - The handler that will handle the RDF data.

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.

Throws:

RDFHandlerException - If the handler encounters an unrecoverable error.

RepositoryException

size

public long size(Resource... contexts)
          throws RepositoryException

Description copied from interface: RepositoryConnection

Returns the number of (explicit) statements that are in the specified contexts in this repository.

Specified by:

size in interface RepositoryConnection

Parameters:

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 from the specified contexts in this repository.

Throws:

RepositoryException

addWithoutCommit

protected void addWithoutCommit(Resource subject,
                                IRI predicate,
                                Value object,
                                Resource... contexts)
                         throws RepositoryException

Specified by:

addWithoutCommit in class AbstractRepositoryConnection

Throws:

RepositoryException

removeWithoutCommit

protected void removeWithoutCommit(Resource subject,
                                   IRI predicate,
                                   Value object,
                                   Resource... contexts)
                            throws RepositoryException

Specified by:

removeWithoutCommit in class AbstractRepositoryConnection

Throws:

RepositoryException

clear

public void clear(Resource... contexts)
           throws RepositoryException

Description copied from interface: RepositoryConnection

Removes all statements from a specific contexts in the repository.

Specified by:

clear in interface RepositoryConnection

Overrides:

clear in class AbstractRepositoryConnection

Parameters:

contexts - The context(s) to remove 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.

Throws:

RepositoryException - If the statements could not be removed from the repository, for example because the repository is not writable.

setNamespace

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

Description copied from interface: RepositoryConnection

Sets the prefix for a namespace.

Specified by:

setNamespace in interface RepositoryConnection

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:

RepositoryException - If the namespace could not be set in the repository, for example because the repository is not writable.

removeNamespace

public void removeNamespace(String prefix)
                     throws RepositoryException

Description copied from interface: RepositoryConnection

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

Specified by:

removeNamespace in interface RepositoryConnection

Parameters:

prefix - The namespace prefix, or an empty string in case of the default namespace.

Throws:

RepositoryException - If the namespace prefix could not be removed.

clearNamespaces

public void clearNamespaces()
                     throws RepositoryException

Description copied from interface: RepositoryConnection

Removes all namespace declarations from the repository.

Specified by:

clearNamespaces in interface RepositoryConnection

Throws:

RepositoryException - If the namespace declarations could not be removed.

getNamespaces

public RepositoryResult<Namespace> getNamespaces()
                                          throws RepositoryException

Description copied from interface: RepositoryConnection

Gets all declared namespaces as a RepositoryResult of Namespace objects. Each Namespace object consists of a prefix and a namespace name.

Specified by:

getNamespaces in interface RepositoryConnection

Returns:

A RepositoryResult containing Namespace objects. Care should be taken to close the RepositoryResult after use.

Throws:

RepositoryException - If the namespaces could not be read from the repository.

getNamespace

public String getNamespace(String prefix)
                    throws RepositoryException

Description copied from interface: RepositoryConnection

Gets the namespace that is associated with the specified prefix, if any.

Specified by:

getNamespace in interface RepositoryConnection

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:

RepositoryException - If the namespace could not be read from the repository.

createRepositoryResult

protected <E> RepositoryResult<E> createRepositoryResult(CloseableIteration<? extends E,SailException> sailIter)

Wraps a CloseableIteration coming from a Sail in a RepositoryResult object, applying the required conversions

isActive

public boolean isActive()
                 throws UnknownTransactionStateException

Description copied from interface: RepositoryConnection

Indicates if a transaction is currently active on the connection. A transaction is active if RepositoryConnection.begin() has been called, and becomes inactive after RepositoryConnection.commit() or RepositoryConnection.rollback() has been called.

Specified by:

isActive in interface RepositoryConnection

Returns:

true iff a transaction is active, false iff no transaction is active.

Throws:

UnknownTransactionStateException - if the transaction state can not be determined. This can happen for instance when communication with a repository fails or times out.

toString

public String toString()

Overrides:

toString in class Object