Package org.eclipse.rdf4j.repository.sparql

Class SPARQLConnection

java.lang.Object

org.eclipse.rdf4j.repository.base.AbstractRepositoryConnection

org.eclipse.rdf4j.repository.sparql.SPARQLConnection

All Implemented Interfaces:

AutoCloseable, HttpClientDependent, RepositoryConnection

public class SPARQLConnection
extends AbstractRepositoryConnection
implements HttpClientDependent

Provides a RepositoryConnection interface to any SPARQL endpoint.

Author:

James Leigh

Field Summary

Fields inherited from class org.eclipse.rdf4j.repository.base.AbstractRepositoryConnection

logger

Constructor Summary

Constructors

Constructor	Description
SPARQLConnection(SPARQLRepository repository, SPARQLProtocolSession client)
SPARQLConnection(SPARQLRepository repository, SPARQLProtocolSession client, boolean quadMode)

Method Summary

Modifier and Type	Method	Description
void	add(File file, String baseURI, org.eclipse.rdf4j.rio.RDFFormat dataFormat, org.eclipse.rdf4j.model.Resource... contexts)
void	add(InputStream in, String baseURI, org.eclipse.rdf4j.rio.RDFFormat dataFormat, org.eclipse.rdf4j.model.Resource... contexts)
void	add(Reader reader, String baseURI, org.eclipse.rdf4j.rio.RDFFormat dataFormat, org.eclipse.rdf4j.model.Resource... contexts)
void	add(Iterable<? extends org.eclipse.rdf4j.model.Statement> statements, org.eclipse.rdf4j.model.Resource... contexts)
void	add(URL url, String baseURI, org.eclipse.rdf4j.rio.RDFFormat dataFormat, org.eclipse.rdf4j.model.Resource... contexts)
void	add(org.eclipse.rdf4j.model.Statement st, org.eclipse.rdf4j.model.Resource... contexts)
protected void	addWithoutCommit(org.eclipse.rdf4j.model.Resource subject, org.eclipse.rdf4j.model.IRI predicate, org.eclipse.rdf4j.model.Value object, org.eclipse.rdf4j.model.Resource... contexts)
protected void	addWithoutCommit(org.eclipse.rdf4j.model.Statement st, org.eclipse.rdf4j.model.Resource... contexts)
void	begin()
void	clear(org.eclipse.rdf4j.model.Resource... contexts)
void	clearNamespaces()
void	close()
void	commit()
void	enableSilentMode(boolean flag)	Deprecated. since 3.6.0 - use setSilentClear(boolean) instead.
void	exportStatements(org.eclipse.rdf4j.model.Resource subj, org.eclipse.rdf4j.model.IRI pred, org.eclipse.rdf4j.model.Value obj, boolean includeInferred, org.eclipse.rdf4j.rio.RDFHandler handler, org.eclipse.rdf4j.model.Resource... contexts)
RepositoryResult<org.eclipse.rdf4j.model.Resource>	getContextIDs()
org.apache.http.client.HttpClient	getHttpClient()
String	getNamespace(String prefix)
RepositoryResult<org.eclipse.rdf4j.model.Namespace>	getNamespaces()
SPARQLRepository	getRepository()
RepositoryResult<org.eclipse.rdf4j.model.Statement>	getStatements(org.eclipse.rdf4j.model.Resource subj, org.eclipse.rdf4j.model.IRI pred, org.eclipse.rdf4j.model.Value obj, boolean includeInferred, org.eclipse.rdf4j.model.Resource... contexts)
boolean	hasStatement(org.eclipse.rdf4j.model.Resource subj, org.eclipse.rdf4j.model.IRI pred, org.eclipse.rdf4j.model.Value obj, boolean includeInferred, org.eclipse.rdf4j.model.Resource... contexts)
boolean	isActive()
boolean	isEmpty()
protected boolean	isQuadMode()	Shall graph information also be retrieved, e.g.
protected boolean	isSilentClear()
void	prepare()
org.eclipse.rdf4j.query.BooleanQuery	prepareBooleanQuery(org.eclipse.rdf4j.query.QueryLanguage ql, String query, String base)
org.eclipse.rdf4j.query.GraphQuery	prepareGraphQuery(org.eclipse.rdf4j.query.QueryLanguage ql, String query, String base)
org.eclipse.rdf4j.query.Query	prepareQuery(org.eclipse.rdf4j.query.QueryLanguage ql, String query, String base)
org.eclipse.rdf4j.query.TupleQuery	prepareTupleQuery(org.eclipse.rdf4j.query.QueryLanguage ql, String query, String base)
org.eclipse.rdf4j.query.Update	prepareUpdate(org.eclipse.rdf4j.query.QueryLanguage ql, String update, String baseURI)
void	remove(Iterable<? extends org.eclipse.rdf4j.model.Statement> statements, org.eclipse.rdf4j.model.Resource... contexts)
void	remove(org.eclipse.rdf4j.model.Statement st, org.eclipse.rdf4j.model.Resource... contexts)
void	removeNamespace(String prefix)
protected void	removeWithoutCommit(org.eclipse.rdf4j.model.Resource subject, org.eclipse.rdf4j.model.IRI predicate, org.eclipse.rdf4j.model.Value object, org.eclipse.rdf4j.model.Resource... contexts)
protected void	removeWithoutCommit(org.eclipse.rdf4j.model.Statement st, org.eclipse.rdf4j.model.Resource... contexts)
void	rollback()
void	setHttpClient(org.apache.http.client.HttpClient httpClient)
void	setNamespace(String prefix, String name)
void	setParserConfig(org.eclipse.rdf4j.rio.ParserConfig parserConfig)
void	setSilentClear(boolean silent)	Configure the connection to execute clear(Resource...) operations silently: the remote endpoint will not respond with an error if the supplied named graph does not exist on the endpoint.
long	size(org.eclipse.rdf4j.model.Resource... contexts)
protected org.eclipse.rdf4j.common.iteration.Iteration<org.eclipse.rdf4j.model.Statement,org.eclipse.rdf4j.query.QueryEvaluationException>	toStatementIteration(org.eclipse.rdf4j.query.TupleQueryResult iter, org.eclipse.rdf4j.model.Resource subj, org.eclipse.rdf4j.model.IRI pred, org.eclipse.rdf4j.model.Value obj)	Converts a TupleQueryResult resulting from the EVERYTHING_WITH_GRAPH to a statement by using the respective values from the BindingSet or (if provided) the ones from the arguments.
String	toString()

Methods inherited from class org.eclipse.rdf4j.repository.base.AbstractRepositoryConnection

add, add, begin, conditionalCommit, conditionalRollback, export, getIsolationLevel, getParserConfig, getValueFactory, hasStatement, isAutoCommit, isOpen, prepareBooleanQuery, prepareGraphQuery, prepareQuery, prepareTupleQuery, prepareUpdate, remove, remove, setAutoCommit, setIsolationLevel, startLocalTransaction

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.rdf4j.repository.RepositoryConnection

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

Constructor Detail

SPARQLConnection

public SPARQLConnection(SPARQLRepository repository,
                        SPARQLProtocolSession client)

SPARQLConnection

public SPARQLConnection(SPARQLRepository repository,
                        SPARQLProtocolSession client,
                        boolean quadMode)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

setSilentClear

public void setSilentClear(boolean silent)

Configure the connection to execute clear(Resource...) operations silently: the remote endpoint will not respond with an error if the supplied named graph does not exist on the endpoint.

By default, the SPARQL connection executes the clear(Resource...) API operation by converting it to a SPARQL `CLEAR GRAPH` update operation. This operation has an optional SILENT modifier, which can be enabled by setting this flag to true. The behavior of this modifier is speficied as follows in the SPARQL 1.1 Recommendation:

If the store records the existence of empty graphs, then the SPARQL 1.1 Update service, by default, SHOULD return failure if the specified graph does not exist. If SILENT is present, the result of the operation will always be success.

Stores that do not record empty graphs will always return success.

Note that in most SPARQL endpoint implementations not recording empty graphs is the default behavior, and setting this flag to true will have no effect. Setting this flag will have no effect on any other errors or other API or SPARQL operations: only the behavior of the clear(Resource...) API operation is modified to respond with a success message when removing a non-existent named graph.

Parameters:

silent - the value to set this to.

enableSilentMode

@Deprecated
public void enableSilentMode(boolean flag)

Deprecated.

since 3.6.0 - use setSilentClear(boolean) instead.

Configure the connection to execute clear(Resource...) operations silently: the remote endpoint will not respond with an error if the supplied named graph does not exist on the endpoint.

By default, the SPARQL connection executes the clear(Resource...) API operation by converting it to a SPARQL `CLEAR GRAPH` update operation. This operation has an optional SILENT modifier, which can be enabled by setting this flag to true. The behavior of this modifier is speficied as follows in the SPARQL 1.1 Recommendation:

If the store records the existence of empty graphs, then the SPARQL 1.1 Update service, by default, SHOULD return failure if the specified graph does not exist. If SILENT is present, the result of the operation will always be success.

Stores that do not record empty graphs will always return success.

Note that in most SPARQL endpoint implementations not recording empty graphs is the default behavior, and setting this flag to true will have no effect. Setting this flag will have no effect on any other errors or other API or SPARQL operations: only the behavior of the clear(Resource...) API operation is modified to respond with a success message when removing a non-existent named graph.

Parameters:

silent - the value to set this to.

setParserConfig

public void setParserConfig(org.eclipse.rdf4j.rio.ParserConfig parserConfig)

Specified by:

setParserConfig in interface RepositoryConnection

Overrides:

setParserConfig in class AbstractRepositoryConnection

getHttpClient

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

Specified by:

getHttpClient in interface HttpClientDependent

setHttpClient

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

Specified by:

setHttpClient in interface HttpClientDependent

close

public void close()
           throws RepositoryException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface RepositoryConnection

Overrides:

close in class AbstractRepositoryConnection

Throws:

RepositoryException

exportStatements

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

Specified by:

exportStatements in interface RepositoryConnection

Throws:

RepositoryException

org.eclipse.rdf4j.rio.RDFHandlerException

getContextIDs

public RepositoryResult<org.eclipse.rdf4j.model.Resource> getContextIDs()
                                                                 throws RepositoryException

Specified by:

getContextIDs in interface RepositoryConnection

Throws:

RepositoryException

getNamespace

public String getNamespace(String prefix)
                    throws RepositoryException

Specified by:

getNamespace in interface RepositoryConnection

Throws:

RepositoryException

getNamespaces

public RepositoryResult<org.eclipse.rdf4j.model.Namespace> getNamespaces()
                                                                  throws RepositoryException

Specified by:

getNamespaces in interface RepositoryConnection

Throws:

RepositoryException

isEmpty

public boolean isEmpty()
                throws RepositoryException

Specified by:

isEmpty in interface RepositoryConnection

Overrides:

isEmpty in class AbstractRepositoryConnection

Throws:

RepositoryException

size

public long size(org.eclipse.rdf4j.model.Resource... contexts)
          throws RepositoryException

Specified by:

size in interface RepositoryConnection

Throws:

RepositoryException

getStatements

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

Specified by:

getStatements in interface RepositoryConnection

Throws:

RepositoryException

hasStatement

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

Specified by:

hasStatement in interface RepositoryConnection

Overrides:

hasStatement in class AbstractRepositoryConnection

Throws:

RepositoryException

getRepository

public SPARQLRepository getRepository()

Specified by:

getRepository in interface RepositoryConnection

Overrides:

getRepository in class AbstractRepositoryConnection

prepareQuery

public org.eclipse.rdf4j.query.Query prepareQuery(org.eclipse.rdf4j.query.QueryLanguage ql,
                                                  String query,
                                                  String base)
                                           throws RepositoryException,
                                                  org.eclipse.rdf4j.query.MalformedQueryException

Specified by:

prepareQuery in interface RepositoryConnection

Throws:

RepositoryException

org.eclipse.rdf4j.query.MalformedQueryException

prepareBooleanQuery

public org.eclipse.rdf4j.query.BooleanQuery prepareBooleanQuery(org.eclipse.rdf4j.query.QueryLanguage ql,
                                                                String query,
                                                                String base)
                                                         throws RepositoryException,
                                                                org.eclipse.rdf4j.query.MalformedQueryException

Specified by:

prepareBooleanQuery in interface RepositoryConnection

Throws:

RepositoryException

org.eclipse.rdf4j.query.MalformedQueryException

prepareGraphQuery

public org.eclipse.rdf4j.query.GraphQuery prepareGraphQuery(org.eclipse.rdf4j.query.QueryLanguage ql,
                                                            String query,
                                                            String base)
                                                     throws RepositoryException,
                                                            org.eclipse.rdf4j.query.MalformedQueryException

Specified by:

prepareGraphQuery in interface RepositoryConnection

Throws:

RepositoryException

org.eclipse.rdf4j.query.MalformedQueryException

prepareTupleQuery

public org.eclipse.rdf4j.query.TupleQuery prepareTupleQuery(org.eclipse.rdf4j.query.QueryLanguage ql,
                                                            String query,
                                                            String base)
                                                     throws RepositoryException,
                                                            org.eclipse.rdf4j.query.MalformedQueryException

Specified by:

prepareTupleQuery in interface RepositoryConnection

Throws:

RepositoryException

org.eclipse.rdf4j.query.MalformedQueryException

prepare

public void prepare()
             throws RepositoryException

Specified by:

prepare in interface RepositoryConnection

Throws:

RepositoryException

commit

public void commit()
            throws RepositoryException

Specified by:

commit in interface RepositoryConnection

Throws:

RepositoryException

rollback

public void rollback()
              throws RepositoryException

Specified by:

rollback in interface RepositoryConnection

Throws:

RepositoryException

begin

public void begin()
           throws RepositoryException

Specified by:

begin in interface RepositoryConnection

Throws:

RepositoryException

add

public void add(File file,
                String baseURI,
                org.eclipse.rdf4j.rio.RDFFormat dataFormat,
                org.eclipse.rdf4j.model.Resource... contexts)
         throws IOException,
                org.eclipse.rdf4j.rio.RDFParseException,
                RepositoryException

Specified by:

add in interface RepositoryConnection

Overrides:

add in class AbstractRepositoryConnection

Throws:

IOException

org.eclipse.rdf4j.rio.RDFParseException

RepositoryException

add

public void add(URL url,
                String baseURI,
                org.eclipse.rdf4j.rio.RDFFormat dataFormat,
                org.eclipse.rdf4j.model.Resource... contexts)
         throws IOException,
                org.eclipse.rdf4j.rio.RDFParseException,
                RepositoryException

Specified by:

add in interface RepositoryConnection

Overrides:

add in class AbstractRepositoryConnection

Throws:

IOException

org.eclipse.rdf4j.rio.RDFParseException

RepositoryException

add

public void add(InputStream in,
                String baseURI,
                org.eclipse.rdf4j.rio.RDFFormat dataFormat,
                org.eclipse.rdf4j.model.Resource... contexts)
         throws IOException,
                org.eclipse.rdf4j.rio.RDFParseException,
                RepositoryException

Specified by:

add in interface RepositoryConnection

Overrides:

add in class AbstractRepositoryConnection

Throws:

IOException

org.eclipse.rdf4j.rio.RDFParseException

RepositoryException

add

public void add(Reader reader,
                String baseURI,
                org.eclipse.rdf4j.rio.RDFFormat dataFormat,
                org.eclipse.rdf4j.model.Resource... contexts)
         throws IOException,
                org.eclipse.rdf4j.rio.RDFParseException,
                RepositoryException

Specified by:

add in interface RepositoryConnection

Overrides:

add in class AbstractRepositoryConnection

Throws:

IOException

org.eclipse.rdf4j.rio.RDFParseException

RepositoryException

add

public void add(org.eclipse.rdf4j.model.Statement st,
                org.eclipse.rdf4j.model.Resource... contexts)
         throws RepositoryException

Specified by:

add in interface RepositoryConnection

Overrides:

add in class AbstractRepositoryConnection

Throws:

RepositoryException

add

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

Specified by:

add in interface RepositoryConnection

Overrides:

add in class AbstractRepositoryConnection

Throws:

RepositoryException

clear

public void clear(org.eclipse.rdf4j.model.Resource... contexts)
           throws RepositoryException

Specified by:

clear in interface RepositoryConnection

Overrides:

clear in class AbstractRepositoryConnection

Throws:

RepositoryException

clearNamespaces

public void clearNamespaces()
                     throws RepositoryException

Specified by:

clearNamespaces in interface RepositoryConnection

Throws:

RepositoryException

remove

public void remove(org.eclipse.rdf4j.model.Statement st,
                   org.eclipse.rdf4j.model.Resource... contexts)
            throws RepositoryException

Specified by:

remove in interface RepositoryConnection

Overrides:

remove in class AbstractRepositoryConnection

Throws:

RepositoryException

remove

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

Specified by:

remove in interface RepositoryConnection

Overrides:

remove in class AbstractRepositoryConnection

Throws:

RepositoryException

removeNamespace

public void removeNamespace(String prefix)
                     throws RepositoryException

Specified by:

removeNamespace in interface RepositoryConnection

Throws:

RepositoryException

setNamespace

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

Specified by:

setNamespace in interface RepositoryConnection

Throws:

RepositoryException

prepareUpdate

public org.eclipse.rdf4j.query.Update prepareUpdate(org.eclipse.rdf4j.query.QueryLanguage ql,
                                                    String update,
                                                    String baseURI)
                                             throws RepositoryException,
                                                    org.eclipse.rdf4j.query.MalformedQueryException

Specified by:

prepareUpdate in interface RepositoryConnection

Throws:

RepositoryException

org.eclipse.rdf4j.query.MalformedQueryException

isActive

public boolean isActive()
                 throws UnknownTransactionStateException,
                        RepositoryException

Specified by:

isActive in interface RepositoryConnection

Throws:

UnknownTransactionStateException

RepositoryException

addWithoutCommit

protected void addWithoutCommit(org.eclipse.rdf4j.model.Statement st,
                                org.eclipse.rdf4j.model.Resource... contexts)
                         throws RepositoryException

Overrides:

addWithoutCommit in class AbstractRepositoryConnection

Throws:

RepositoryException

addWithoutCommit

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

Specified by:

addWithoutCommit in class AbstractRepositoryConnection

Throws:

RepositoryException

removeWithoutCommit

protected void removeWithoutCommit(org.eclipse.rdf4j.model.Statement st,
                                   org.eclipse.rdf4j.model.Resource... contexts)
                            throws RepositoryException

Overrides:

removeWithoutCommit in class AbstractRepositoryConnection

Throws:

RepositoryException

removeWithoutCommit

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

Specified by:

removeWithoutCommit in class AbstractRepositoryConnection

Throws:

RepositoryException

isQuadMode

protected boolean isQuadMode()

Shall graph information also be retrieved, e.g. for getStatements(Resource, IRI, Value, boolean, Resource...)

Returns:

true if in quad mode

isSilentClear

protected boolean isSilentClear()

toStatementIteration

protected org.eclipse.rdf4j.common.iteration.Iteration<org.eclipse.rdf4j.model.Statement,org.eclipse.rdf4j.query.QueryEvaluationException> toStatementIteration(org.eclipse.rdf4j.query.TupleQueryResult iter,
                                                                                                                                                                      org.eclipse.rdf4j.model.Resource subj,
                                                                                                                                                                      org.eclipse.rdf4j.model.IRI pred,
                                                                                                                                                                      org.eclipse.rdf4j.model.Value obj)

Converts a TupleQueryResult resulting from the EVERYTHING_WITH_GRAPH to a statement by using the respective values from the BindingSet or (if provided) the ones from the arguments.

Parameters:

iter - the TupleQueryResult

subj - the subject Resource used as input or null if wildcard was used

pred - the predicate IRI used as input or null if wildcard was used

obj - the object Value used as input or null if wildcard was used

Returns:

the converted iteration