Class FedXRepositoryConnection

java.lang.Object

org.eclipse.rdf4j.repository.base.AbstractRepositoryConnection

org.eclipse.rdf4j.repository.sail.SailRepositoryConnection

org.eclipse.rdf4j.federated.repository.FedXRepositoryConnection

All Implemented Interfaces:

AutoCloseable, HttpClientDependent, SessionManagerDependent, FederatedServiceResolverClient, RepositoryConnection, RepositoryResolverClient

public class FedXRepositoryConnection
extends SailRepositoryConnection

A special SailRepositoryConnection which adds the original query string as binding to the returned query. The binding name is defined by BINDING_ORIGINAL_QUERY and is added to all query instances returned by the available prepare methods.

Author:

Andreas Schwarte

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BINDING_ORIGINAL_BASE_URI
static final String	BINDING_ORIGINAL_MAX_EXECUTION_TIME
static final String	BINDING_ORIGINAL_QUERY	We add a binding to each parsed query mapping the original query in order to send the original query to the endpoint if there is only a single federation member is relevant for this query.
static final String	BINDING_ORIGINAL_QUERY_TYPE
static final Set<String>	FEDX_BINDINGS	The number of bindings in the external binding set that are added by FedX.

Fields inherited from class AbstractRepositoryConnection

logger

Modifier and Type	Field	Description
protected final org.slf4j.Logger	logger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FedXRepositoryConnection(FedXRepository repository, SailConnection sailConnection)

Method Summary

Modifier and Type	Method	Description
SailBooleanQuery	prepareBooleanQuery(QueryLanguage ql, String queryString, String baseURI)	Prepares queries that return true or false.
FedXGraphQuery	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).
FedXTupleQuery	prepareTupleQuery(QueryLanguage ql, String queryString, String baseURI)	Prepares a query that produces sets of value tuples.
Update	prepareUpdate(QueryLanguage ql, String updateString, String baseURI)	Prepares an Update operation.

Methods inherited from class SailRepositoryConnection

addWithoutCommit, begin, begin, begin, clear, clearNamespaces, close, commit, createRepositoryResult, exportStatements, getContextIDs, getFederatedServiceResolver, getHttpClient, getHttpClientSessionManager, getNamespace, getNamespaces, getSailConnection, getStatements, hasStatement, isActive, isEmpty, isOpen, prepare, removeNamespace, removeWithoutCommit, rollback, setFederatedServiceResolver, setHttpClient, setHttpClientSessionManager, setNamespace, setRepositoryResolver, size, toString

Modifier and Type	Method	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	begin(TransactionSetting... settings)	Begins a new transaction with the supplied TransactionSetting, 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> 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 context identifiers.
FederatedServiceResolver	getFederatedServiceResolver()	Gets the FederatedServiceResolver used by this client.
RDF4JHttpClient	getHttpClient()	RDF4JHttpClient that has been assigned or has been used by this object.
HttpClientSessionManager	getHttpClientSessionManager()	HttpClientSessionManager 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.
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.
void	prepare()	Checks for an error state in the active transaction that would force the transaction to be rolled back.
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(RDF4JHttpClient client)	Assign an RDF4JHttpClient that this object should use.
void	setHttpClientSessionManager(HttpClientSessionManager client)	Assign an HttpClientSessionManager that this object should use.
void	setNamespace(String prefix, String name)	Sets the prefix for a namespace.
void	setRepositoryResolver(RepositoryResolver resolver)
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 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

Modifier and Type	Method	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(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(Iterable<? extends Statement> statements, Resource... contexts)	Adds the supplied statements 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.
void	add(CloseableIteration<? extends Statement> statements, Resource... contexts)	Adds the supplied statements to this repository, optionally to one or more named contexts.
void	add(Resource subject, IRI predicate, Value object, Resource... contexts)	Adds a statement with the specified subject, predicate and object to this 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.
protected void	addWithoutCommit(Statement st, Resource... contexts)
protected final void	conditionalCommit(boolean condition)	Invokes RepositoryConnection.commit() if supplied boolean condition is true.
protected final void	conditionalRollback(boolean condition)	Invokes RepositoryConnection.rollback() if supplied boolean condition is true.
void	export(RDFHandler handler, Resource... contexts)	Exports all explicit statements in the specified contexts to the supplied RDFHandler.
IsolationLevel	getIsolationLevel()	Retrieves the current transaction isolation level of the connection.
ParserConfig	getParserConfig()	Returns the parser configuration this connection uses for Rio-based operations.
Repository	getRepository()	Returns the Repository object to which this connection belongs.
ValueFactory	getValueFactory()	Gets a ValueFactory for this RepositoryConnection.
boolean	hasStatement(Statement st, boolean includeInferred, Resource... contexts)	Checks whether the repository contains the specified statement, optionally in the specified contexts.
boolean	isAutoCommit()	Deprecated. Use RepositoryConnection.isActive() instead.
BooleanQuery	prepareBooleanQuery(QueryLanguage ql, String query)	Prepares queries that return true or false.
GraphQuery	prepareGraphQuery(QueryLanguage ql, String query)	Prepares queries that produce RDF graphs.
Query	prepareQuery(QueryLanguage ql, String query)	Prepares a query for evaluation on this repository (optional operation).
TupleQuery	prepareTupleQuery(QueryLanguage ql, String query)	Prepares a query that produces sets of value tuples.
Update	prepareUpdate(QueryLanguage ql, String update)	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(CloseableIteration<? extends Statement> statements, Resource... contexts)	Removes the supplied statements from a specific context in this repository, ignoring any context information carried by the statements themselves.
void	remove(Resource subject, IRI predicate, Value object, Resource... contexts)	Removes the statement(s) with the specified subject, predicate and object from the repository, optionally restricted to the specified contexts.
void	remove(Statement st, Resource... contexts)	Removes the supplied statement from the specified contexts in the repository.
protected void	removeWithoutCommit(Statement st, Resource... contexts)
void	setAutoCommit(boolean autoCommit)	Deprecated. Use RepositoryConnection.begin() instead.
void	setIsolationLevel(IsolationLevel level)	Sets the transaction isolation level for the next transaction(s) on this connection.
void	setParserConfig(ParserConfig parserConfig)	Set the parser configuration this connection should use for RDFParser-based operations.
protected final boolean	startLocalTransaction()	Starts a new transaction if one is not already active.

Methods inherited from class Object

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

Methods inherited from interface RepositoryConnection

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

Modifier and Type	Method	Description
default void	add(File file, Resource... contexts)	Adds RDF data from the specified file to a specific contexts in the repository.
default void	add(File file, RDFFormat dataFormat, Resource... contexts)	Adds RDF data from the specified file to a specific contexts in the repository.
default void	add(InputStream in, RDFFormat dataFormat, Resource... contexts)	Adds RDF data from an InputStream to the repository, optionally to one or more named contexts.
default void	add(Reader reader, RDFFormat dataFormat, Resource... contexts)	Adds RDF data from a Reader to the repository, optionally to one or more named contexts.
default void	add(URL url, Resource... contexts)	Adds the RDF data that can be found at the specified URL to the repository, optionally to one or more named contexts.
default void	add(URL url, 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.
default void	add(RepositoryResult<Statement> statements, Resource... contexts)	Adds the supplied statements to this repository, optionally to one or more named contexts.
default RepositoryResult<Statement>	getStatements(Resource subj, IRI pred, Value obj, Resource... contexts)	Gets all statements with a specific subject, predicate and/or object from the repository.
default BooleanQuery	prepareBooleanQuery(String query)	Prepares SPARQL queries that return true or false, that is, SPARQL ASK queries.
default GraphQuery	prepareGraphQuery(String query)	Prepares SPARQL queries that produce RDF graphs, that is, SPARQL CONSTRUCT or DESCRIBE queries.
default Query	prepareQuery(String query)	Prepares a SPARQL query for evaluation on this repository (optional operation).
default TupleQuery	prepareTupleQuery(String query)	Prepares a SPARQL query that produces sets of value tuples, that is a SPARQL SELECT query.
default Update	prepareUpdate(String update)	Prepares a SPARQL Update operation.
default void	remove(RepositoryResult<Statement> statements, Resource... contexts)	Removes the supplied statements from a specific context in this repository, ignoring any context information carried by the statements themselves.

Field Details

BINDING_ORIGINAL_QUERY

public static final String BINDING_ORIGINAL_QUERY

We add a binding to each parsed query mapping the original query in order to send the original query to the endpoint if there is only a single federation member is relevant for this query.

See Also:

• Constant Field Values

BINDING_ORIGINAL_BASE_URI

public static final String BINDING_ORIGINAL_BASE_URI

See Also:

• Constant Field Values

BINDING_ORIGINAL_QUERY_TYPE

public static final String BINDING_ORIGINAL_QUERY_TYPE

See Also:

• Constant Field Values

BINDING_ORIGINAL_MAX_EXECUTION_TIME

public static final String BINDING_ORIGINAL_MAX_EXECUTION_TIME

See Also:

• Constant Field Values

FEDX_BINDINGS

public static final Set<String> FEDX_BINDINGS

The number of bindings in the external binding set that are added by FedX.

See Also:

• BINDING_ORIGINAL_QUERY
• BINDING_ORIGINAL_QUERY_TYPE
• BINDING_ORIGINAL_MAX_EXECUTION_TIME

Constructor Details

FedXRepositoryConnection

protected FedXRepositoryConnection(FedXRepository repository,
 SailConnection sailConnection)

Method Details

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

If you already know the type of query, using the more specific RepositoryConnection.prepareTupleQuery(String), RepositoryConnection.prepareGraphQuery(String) or RepositoryConnection.prepareBooleanQuery(String) is likely to be more efficient.

Specified by:

prepareQuery in interface RepositoryConnection

Overrides:

prepareQuery in class SailRepositoryConnection

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

Overrides:

prepareTupleQuery in class SailRepositoryConnection

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

Overrides:

prepareGraphQuery in class SailRepositoryConnection

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

Overrides:

prepareBooleanQuery in class SailRepositoryConnection

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 updateString,
 String baseURI)
                     throws RepositoryException,
MalformedQueryException

Description copied from interface: RepositoryConnection

Prepares an Update operation.

Specified by:

prepareUpdate in interface RepositoryConnection

Overrides:

prepareUpdate in class SailRepositoryConnection

Parameters:

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

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