org.openrdf.repository.sparql

Class SPARQLConnection

java.lang.Object

org.openrdf.repository.base.RepositoryConnectionBase

org.openrdf.repository.sparql.SPARQLConnection

All Implemented Interfaces:

RepositoryConnection

public class SPARQLConnection
extends RepositoryConnectionBase

Provides a RepositoryConnection interface to any SPARQL endpoint.

Author:

James Leigh

Field Summary

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

logger

Constructor Summary

Constructors

Constructor and Description
SPARQLConnection(SPARQLRepository repository)

Method Summary

Modifier and Type	Method and Description
void	add(File file, String baseURI, RDFFormat dataFormat, Resource... contexts) Adds RDF data from the specified file to a specific contexts in the repository.
void	add(InputStream in, String baseURI, RDFFormat dataFormat, Resource... contexts) Adds RDF data from an InputStream to the repository, optionally to one or more named contexts.
void	add(Iterable<? extends Statement> statements, Resource... contexts) Adds the supplied statements to this repository, optionally to one or more named contexts.
void	add(Reader reader, String baseURI, RDFFormat dataFormat, Resource... contexts) Adds RDF data from a Reader to the repository, optionally to one or more named contexts.
void	add(Statement st, Resource... contexts) Adds the supplied statement to this repository, optionally to one or more named contexts.
void	add(URL url, String baseURI, RDFFormat dataFormat, Resource... contexts) Adds the RDF data that can be found at the specified URL to the repository, optionally to one or more named contexts.
protected void	addWithoutCommit(Resource subject, URI predicate, Value object, Resource... contexts)
void	begin() Begins a transaction 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	commit() Commits the active transaction.
void	exportStatements(Resource subj, URI 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.
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.
SPARQLRepository	getRepository() Returns the Repository object to which this connection belongs.
RepositoryResult<Statement>	getStatements(Resource subj, URI 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, URI 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.
BooleanQuery	prepareBooleanQuery(QueryLanguage ql, String query, String base) Prepares true/false queries.
GraphQuery	prepareGraphQuery(QueryLanguage ql, String query, String base) Prepares queries that produce RDF graphs.
Query	prepareQuery(QueryLanguage ql, String query, String base) Prepares a query for evaluation on this repository (optional operation).
TupleQuery	prepareTupleQuery(QueryLanguage ql, String query, String base) Prepares a query that produces sets of value tuples.
Update	prepareUpdate(QueryLanguage ql, String update, String baseURI) Prepares an Update operation.
void	remove(Iterable<? extends Statement> statements, Resource... contexts) Removes the supplied statements from the specified contexts in this repository.
void	remove(Statement st, Resource... contexts) Removes the supplied statement from the specified contexts in the repository.
void	removeNamespace(String prefix) Removes a namespace declaration by removing the association between a prefix and a namespace name.
protected void	removeWithoutCommit(Resource subject, URI predicate, Value object, Resource... contexts)
void	rollback() Rolls back all updates in the active transaction.
void	setNamespace(String prefix, String name) Sets the prefix for a namespace.
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.RepositoryConnectionBase

add, add, addWithoutCommit, close, conditionalCommit, conditionalRollback, export, getParserConfig, getValueFactory, hasStatement, isAutoCommit, isEmpty, isOpen, prepareBooleanQuery, prepareGraphQuery, prepareQuery, prepareTupleQuery, prepareUpdate, remove, remove, removeWithoutCommit, setAutoCommit, setParserConfig, startLocalTransaction

Methods inherited from class java.lang.Object

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

Constructor Detail

SPARQLConnection

public SPARQLConnection(SPARQLRepository repository)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

exportStatements

public void exportStatements(Resource subj,
                             URI 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.

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

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.

Returns:

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

Throws:

RepositoryException

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.

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.

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.

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.

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.

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

getStatements

public RepositoryResult<Statement> getStatements(Resource subj,
                                                 URI 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.

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. 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

hasStatement

public boolean hasStatement(Resource subj,
                            URI 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 RepositoryConnectionBase

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

getRepository

public SPARQLRepository getRepository()

Description copied from interface: RepositoryConnection

Returns the Repository object to which this connection belongs.

Specified by:

getRepository in interface RepositoryConnection

Overrides:

getRepository in class RepositoryConnectionBase

prepareQuery

public Query prepareQuery(QueryLanguage ql,
                          String query,
                          String base)
                   throws RepositoryException,
                          MalformedQueryException

Description copied from interface: RepositoryConnection

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

Parameters:

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

query - The query string.

base - 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.

RepositoryException

prepareBooleanQuery

public BooleanQuery prepareBooleanQuery(QueryLanguage ql,
                                        String query,
                                        String base)
                                 throws RepositoryException,
                                        MalformedQueryException

Description copied from interface: RepositoryConnection

Prepares true/false queries.

Parameters:

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

query - The query string.

base - 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.

Throws:

MalformedQueryException - If the supplied query is malformed.

RepositoryException

prepareGraphQuery

public GraphQuery prepareGraphQuery(QueryLanguage ql,
                                    String query,
                                    String base)
                             throws RepositoryException,
                                    MalformedQueryException

Description copied from interface: RepositoryConnection

Prepares queries that produce RDF graphs.

Parameters:

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

query - The query string.

base - 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.

Throws:

MalformedQueryException - If the supplied query is malformed.

RepositoryException

prepareTupleQuery

public TupleQuery prepareTupleQuery(QueryLanguage ql,
                                    String query,
                                    String base)
                             throws RepositoryException,
                                    MalformedQueryException

Description copied from interface: RepositoryConnection

Prepares a query that produces sets of value tuples.

Parameters:

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

query - The query string.

base - 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.

Throws:

MalformedQueryException - If the supplied query is malformed.

RepositoryException

commit

public void commit()
            throws RepositoryException

Description copied from interface: RepositoryConnection

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

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 connection.

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.

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()

begin

public void begin()
           throws RepositoryException

Description copied from interface: RepositoryConnection

Begins a transaction requiring RepositoryConnection.commit() or RepositoryConnection.rollback() to be called to end the transaction.

Throws:

RepositoryException - If the connection could not start a transaction.

See Also:

RepositoryConnection.isActive(), RepositoryConnection.commit(), RepositoryConnection.rollback()

add

public void add(File file,
                String baseURI,
                RDFFormat dataFormat,
                Resource... contexts)
         throws IOException,
                RDFParseException,
                RepositoryException

Description copied from interface: RepositoryConnection

Adds RDF data from the specified file to a specific contexts in the repository.

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionBase

Parameters:

file - A file containing RDF data.

baseURI - The base URI to resolve any relative URIs that are in the data against. This defaults to the value of file.toURI() if the value is set to null.

dataFormat - The serialization format of the data.

contexts - The contexts to add the data to. Note that this parameter is a vararg and as such is optional. If no contexts are specified, the data is added to any context specified in the actual data file, or if the data contains no context, it is added without context. If one or more contexts are specified the data is added to these contexts, ignoring any context information in the data itself.

Throws:

IOException - If an I/O error occurred while reading from the file.

RDFParseException - If an error was found while parsing the RDF data.

RepositoryException - If the data could not be added to the repository, for example because the repository is not writable.

add

public void add(URL url,
                String baseURI,
                RDFFormat dataFormat,
                Resource... contexts)
         throws IOException,
                RDFParseException,
                RepositoryException

Description copied from interface: RepositoryConnection

Adds the RDF data that can be found at the specified URL to the repository, optionally to one or more named contexts.

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionBase

Parameters:

url - The URL of the RDF data.

baseURI - The base URI to resolve any relative URIs that are in the data against. This defaults to the value of url.toExternalForm() if the value is set to null.

dataFormat - The serialization format of the data. If set to null, the format will be automatically determined by examining the content type in the HTTP response header, and failing that, the file name extension of the supplied URL.

contexts - The contexts to add the data to. If one or more contexts are specified the data is added to these contexts, ignoring any context information in the data itself.

Throws:

IOException - If an I/O error occurred while reading from the URL.

RDFParseException - If an error was found while parsing the RDF data.

RepositoryException - If the data could not be added to the repository, for example because the repository is not writable.

add

public void add(InputStream in,
                String baseURI,
                RDFFormat dataFormat,
                Resource... contexts)
         throws IOException,
                RDFParseException,
                RepositoryException

Description copied from interface: RepositoryConnection

Adds RDF data from an InputStream to the repository, optionally to one or more named contexts.

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionBase

Parameters:

in - An InputStream from which RDF data can be read.

baseURI - The base URI to resolve any relative URIs that are in the data against.

dataFormat - The serialization format of the data.

contexts - The contexts to add the data to. If one or more contexts are supplied the method ignores contextual information in the actual data. If no contexts are supplied the contextual information in the input stream is used, if no context information is available the data is added without any context.

Throws:

IOException - If an I/O error occurred while reading from the input stream.

RDFParseException - If an error was found while parsing the RDF data.

RepositoryException - If the data could not be added to the repository, for example because the repository is not writable.

add

public void add(Reader reader,
                String baseURI,
                RDFFormat dataFormat,
                Resource... contexts)
         throws IOException,
                RDFParseException,
                RepositoryException

Description copied from interface: RepositoryConnection

Adds RDF data from a Reader to the repository, optionally to one or more named contexts. Note: using a Reader to upload byte-based data means that you have to be careful not to destroy the data's character encoding by enforcing a default character encoding upon the bytes. If possible, adding such data using an InputStream is to be preferred.

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionBase

Parameters:

reader - A Reader from which RDF data can be read.

baseURI - The base URI to resolve any relative URIs that are in the data against.

dataFormat - The serialization format of the data.

contexts - The contexts to add the data to. If one or more contexts are specified the data is added to these contexts, ignoring any context information in the data itself.

Throws:

IOException - If an I/O error occurred while reading from the reader.

RDFParseException - If an error was found while parsing the RDF data.

RepositoryException - If the data could not be added to the repository, for example because the repository is not writable.

add

public void add(Statement st,
                Resource... contexts)
         throws RepositoryException

Description copied from interface: RepositoryConnection

Adds the supplied statement to this repository, optionally to one or more named contexts.

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionBase

Parameters:

st - The statement to add.

contexts - The contexts to add the statements to. Note that this parameter is a vararg and as such is optional. If no contexts are specified, the statement is added to any context specified in each statement, or if the statement contains no context, it is added without context. If one or more contexts are specified the statement is added to these contexts, ignoring any context information in the statement itself.

Throws:

RepositoryException - If the statement could not be added to the repository, for example because the repository is not writable.

add

public void add(Iterable<? extends Statement> statements,
                Resource... contexts)
         throws RepositoryException

Description copied from interface: RepositoryConnection

Adds the supplied statements to this repository, optionally to one or more named contexts.

Specified by:

add in interface RepositoryConnection

Overrides:

add in class RepositoryConnectionBase

Parameters:

statements - The statements that should be added.

contexts - The contexts to add the statements to. Note that this parameter is a vararg and as such is optional. If no contexts are specified, each statement is added to any context specified in the statement, or if the statement contains no context, it is added without context. If one or more contexts are specified each statement is added to these contexts, ignoring any context information in the statement itself. ignored.

Throws:

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

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 RepositoryConnectionBase

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.

clearNamespaces

public void clearNamespaces()
                     throws RepositoryException

Description copied from interface: RepositoryConnection

Removes all namespace declarations from the repository.

Throws:

RepositoryException - If the namespace declarations could not be removed.

remove

public void remove(Statement st,
                   Resource... contexts)
            throws RepositoryException

Description copied from interface: RepositoryConnection

Removes the supplied statement from the specified contexts in the repository.

Specified by:

remove in interface RepositoryConnection

Overrides:

remove in class RepositoryConnectionBase

Parameters:

st - The statement to remove.

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 contexts associated with the statement itself, and if no context is associated with the statement, on the entire repository.

Throws:

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

remove

public void remove(Iterable<? extends Statement> statements,
                   Resource... contexts)
            throws RepositoryException

Description copied from interface: RepositoryConnection

Removes the supplied statements from the specified contexts in this repository.

Specified by:

remove in interface RepositoryConnection

Overrides:

remove in class RepositoryConnectionBase

Parameters:

statements - The statements that should be added.

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 contexts associated with the statement itself, and if no context is associated with the statement, on the entire repository.

Throws:

RepositoryException - If the statements could not be added to 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.

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.

setNamespace

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

Description copied from interface: RepositoryConnection

Sets the prefix for a namespace.

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.

prepareUpdate

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

Description copied from interface: RepositoryConnection

Prepares an Update operation.

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.

Throws:

MalformedQueryException - If the supplied update operation string is malformed.

RepositoryException

isActive

public boolean isActive()
                 throws UnknownTransactionStateException,
                        RepositoryException

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.

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.

RepositoryException

addWithoutCommit

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

Specified by:

addWithoutCommit in class RepositoryConnectionBase

Throws:

RepositoryException

removeWithoutCommit

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

Specified by:

removeWithoutCommit in class RepositoryConnectionBase

Throws:

RepositoryException