Class SparqlFederationEvalStrategy

java.lang.Object

org.eclipse.rdf4j.query.algebra.evaluation.impl.DefaultEvaluationStrategy

org.eclipse.rdf4j.query.algebra.evaluation.impl.StrictEvaluationStrategy

org.eclipse.rdf4j.federated.evaluation.FederationEvalStrategy

org.eclipse.rdf4j.federated.evaluation.SparqlFederationEvalStrategy

All Implemented Interfaces:

EvaluationStrategy, FederatedServiceResolver, FederatedServiceResolverClient

@Deprecated(forRemoval=true)
public class SparqlFederationEvalStrategy
extends FederationEvalStrategy

Deprecated, for removal: This API element is subject to removal in a future version.

Implementation of a federation evaluation strategy which provides some special optimizations for SPARQL (remote) endpoints. The most important optimization is to used prepared SPARQL Queries that are already created using Strings.

Joins are executed using ControlledWorkerBindJoin.

This implementation uses the SPARQL 1.1 VALUES operator for the bound-join evaluation

s

Author:

Andreas Schwarte

Field Summary

Fields inherited from class FederationEvalStrategy

cache, executor, federationContext

Modifier and Type	Field	Description
protected SourceSelectionCache	cache
protected Executor	executor
protected FederationContext	federationContext

Fields inherited from class DefaultEvaluationStrategy

dataset, serviceResolver, tripleSource

Modifier and Type	Field	Description
protected final Dataset	dataset
protected FederatedServiceResolver	serviceResolver
protected final TripleSource	tripleSource

Constructor Summary

Constructors

Constructor	Description
SparqlFederationEvalStrategy(FederationContext federationContext)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
CloseableIteration<BindingSet>	evaluateBoundJoinStatementPattern(StatementTupleExpr stmt, List<BindingSet> bindings)	Deprecated, for removal: This API element is subject to removal in a future version. Evaluate a bound join at the relevant endpoint, i.e. i.e. for a group of bindings retrieve results for the bound statement from the relevant endpoints
protected CloseableIteration<BindingSet>	evaluateBoundJoinStatementPattern_UNION(StatementTupleExpr stmt, List<BindingSet> bindings)	Deprecated, for removal: This API element is subject to removal in a future version. no longer used
CloseableIteration<BindingSet>	evaluateExclusiveGroup(ExclusiveGroup group, BindingSet bindings)	Deprecated, for removal: This API element is subject to removal in a future version.
CloseableIteration<BindingSet>	evaluateGroupedCheck(CheckStatementPattern stmt, List<BindingSet> bindings)	Deprecated, for removal: This API element is subject to removal in a future version. Perform a grouped check at the relevant endpoints, i.e. for a group of bindings keep only those for which at least one endpoint provides a result to the bound statement.
CloseableIteration<BindingSet>	executeJoin(ControlledWorkerScheduler<BindingSet> joinScheduler, CloseableIteration<BindingSet> leftIter, TupleExpr rightArg, Set<String> joinVars, BindingSet bindings, QueryInfo queryInfo)	Deprecated, for removal: This API element is subject to removal in a future version. Execute the join in a separate thread using some join executor.
protected CloseableIteration<BindingSet>	executeLeftJoin(ControlledWorkerScheduler<BindingSet> joinScheduler, CloseableIteration<BindingSet> leftIter, LeftJoin leftJoin, BindingSet bindings, QueryInfo queryInfo)	Deprecated, for removal: This API element is subject to removal in a future version. Execute the left join in a separate thread using some join executor.

Methods inherited from class FederationEvalStrategy

evaluate, evaluate, evaluate, evaluate, evaluate, evaluateArbitrayLengthPath, evaluateAtStatementSources, evaluateAtStatementSources, evaluateAtStatementSources, evaluateExclusiveTupleExpr, evaluateLeftBoundJoinStatementPattern, evaluateLeftJoin, evaluateNaryUnion, evaluateNJoin, evaluateService, evaluateService, evaluateSingleSourceQuery, evaluateZeroLengthPath, getAccessibleFederationMembers, getMembersFromContext, getStatements, hasStatements, optimize, optimizeExclusiveExpressions, optimizeJoinOrder, performSourceSelection, performSourceSelection, precompile, precompile, prepare, prepare, prepare, prepare, prepare, prepareExclusiveTupleExpr, prepareLeftJoin, prepareNaryUnion, prepareNJoin, propagateServices

Modifier and Type	Method	Description
Value	evaluate(ConjunctiveFilterExpr node, BindingSet bindings)
Value	evaluate(FilterExpr node, BindingSet bindings)
CloseableIteration<BindingSet>	evaluate(DescribeOperator operator, BindingSet bindings)
CloseableIteration<BindingSet>	evaluate(TupleExpr expr, BindingSet bindings)	Deprecated, for removal: This API element is subject to removal in a future version.
Value	evaluate(ValueExpr expr, BindingSet bindings)	Deprecated, for removal: This API element is subject to removal in a future version.
protected CloseableIteration<BindingSet>	evaluateArbitrayLengthPath(FedXArbitraryLengthPath alp, BindingSet bindings)
protected CloseableIteration<BindingSet>	evaluateAtStatementSources(Object preparedQuery, List<StatementSource> statementSources, QueryInfo queryInfo)
protected CloseableIteration<BindingSet>	evaluateAtStatementSources(String preparedQuery, List<StatementSource> statementSources, QueryInfo queryInfo)
protected CloseableIteration<BindingSet>	evaluateAtStatementSources(TupleExpr preparedQuery, List<StatementSource> statementSources, QueryInfo queryInfo)
protected CloseableIteration<BindingSet>	evaluateExclusiveTupleExpr(ExclusiveTupleExpr expr, BindingSet bindings)	Evaluate an ExclusiveTupleExpr.
CloseableIteration<BindingSet>	evaluateLeftBoundJoinStatementPattern(StatementTupleExpr stmt, List<BindingSet> bindings)	Evaluate the left bind join for the given StatementTupleExpr and bindings at the relevant endpoints.
protected CloseableIteration<BindingSet>	evaluateLeftJoin(FedXLeftJoin leftJoin, BindingSet bindings)	Evaluate a FedXLeftJoin (i.e. an OPTIONAL clause)
CloseableIteration<BindingSet>	evaluateNaryUnion(NUnion union, BindingSet bindings)
CloseableIteration<BindingSet>	evaluateNJoin(NJoin join, BindingSet bindings)
CloseableIteration<BindingSet>	evaluateService(FedXService service, List<BindingSet> bindings)	Evaluate a SERVICE using vectored evaluation, taking the provided bindings as input.
CloseableIteration<BindingSet>	evaluateService(FedXService service, BindingSet bindings)
CloseableIteration<BindingSet>	evaluateSingleSourceQuery(SingleSourceQuery query, BindingSet bindings)
protected CloseableIteration<BindingSet>	evaluateZeroLengthPath(FedXZeroLengthPath zlp, BindingSet bindings)
protected List<Endpoint>	getAccessibleFederationMembers(QueryInfo queryInfo)	Returns the accessible federation members in the context of the query.
protected List<Endpoint>	getMembersFromContext(FederationEvaluationStatistics evaluationStatisticss)	Returns the federation members that are active in the current federation.
CloseableIteration<Statement>	getStatements(QueryInfo queryInfo, Resource subj, IRI pred, Value obj, Resource... contexts)	Retrieve the statements matching the provided subject, predicate and object value from the federation members.
boolean	hasStatements(QueryInfo queryInfo, Resource subj, IRI pred, Value obj, Resource... contexts)	Returns true if the federation has statements
TupleExpr	optimize(TupleExpr expr, EvaluationStatistics evaluationStatistics, BindingSet bindings)	Execute the QueryOptimizerPipeline on the given TupleExpr to optimize its execution plan.
protected void	optimizeExclusiveExpressions(TupleExpr query, QueryInfo queryInfo, GenericInfoOptimizer info)	Optimize ExclusiveTupleExpr, e.g. restructure the exclusive parts of the query AST.
protected void	optimizeJoinOrder(TupleExpr query, QueryInfo queryInfo, GenericInfoOptimizer info)
protected Set<Endpoint>	performSourceSelection(List<Endpoint> members, SourceSelectionCache cache, QueryInfo queryInfo, GenericInfoOptimizer info)	Perform source selection for all statements of the query.
protected Set<Endpoint>	performSourceSelection(FedXArbitraryLengthPath pathExpr, StatementPattern stmt, List<Endpoint> members, SourceSelectionCache cache, QueryInfo queryInfo)	Perform source selection on the statement pattern representing the path expression.
QueryEvaluationStep	precompile(TupleExpr expr, QueryEvaluationContext context)
QueryValueEvaluationStep	precompile(ValueExpr expr, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(ConjunctiveFilterExpr node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(FedXArbitraryLengthPath alp, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(FedXZeroLengthPath zlp, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(FilterExpr node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(DescribeOperator operator, QueryEvaluationContext context)
protected QueryEvaluationStep	prepareExclusiveTupleExpr(ExclusiveTupleExpr expr, QueryEvaluationContext context)
protected QueryEvaluationStep	prepareLeftJoin(FedXLeftJoin leftJoin, QueryEvaluationContext context)
QueryEvaluationStep	prepareNaryUnion(NUnion union, QueryEvaluationContext context)
protected QueryEvaluationStep	prepareNJoin(NJoin join, QueryEvaluationContext context)
protected boolean	propagateServices(List<Service> serviceNodes)	Whether to propagate a SingleSourceQuery containing SERVICE clauses.

Methods inherited from class DefaultEvaluationStrategy

evaluate, evaluate, evaluate, getCollectionFactory, getFederatedServiceResolver, getLimit, getQueryEvaluationMode, getService, getVarValue, isReducedOrDistinct, isTrackResultSize, isTrackTime, isTrue, isTrue, precompile, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, prepare, setCollectionFactory, setFederatedServiceResolver, setOptimizerPipeline, setQueryEvaluationMode, setTrackResultSize, setTrackTime, supplyBinaryValueEvaluation, supplyUnaryValueEvaluation

Modifier and Type	Method	Description
protected static CloseableIteration<BindingSet>	evaluate(TupleFunction func, List<Var> resultVars, BindingSet bindings, ValueFactory valueFactory, Value... argValues)
Value	evaluate(Regex node, BindingSet bindings)	Deprecated, for removal: This API element is subject to removal in a future version.
CloseableIteration<BindingSet>	evaluate(TripleRef ref, BindingSet bindings)	evaluates a TripleRef node returning bindingsets from the matched Triple nodes in the dataset (or explore standard reification)
Supplier<CollectionFactory>	getCollectionFactory()
FederatedServiceResolver	getFederatedServiceResolver()	Gets the FederatedServiceResolver used by this client.
protected long	getLimit(QueryModelNode node)	Returns the limit of the current variable bindings before any further projection.
QueryEvaluationMode	getQueryEvaluationMode()
FederatedService	getService(String serviceUrl)	Retrieve the FederatedService registered for serviceUrl.
static Value	getVarValue(Var var, BindingSet bindings)
protected boolean	isReducedOrDistinct(QueryModelNode node)
boolean	isTrackResultSize()	Enable or disable results size tracking for the query plan.
boolean	isTrackTime()	Enable or disable time tracking for the query plan.
boolean	isTrue(QueryValueEvaluationStep expr, BindingSet bindings)
boolean	isTrue(ValueExpr expr, BindingSet bindings)	Evaluates the boolean expression on the supplied TripleSource object.
QueryEvaluationStep	precompile(TupleExpr expr)	Prepare a QueryEvaluationStep that tries to do as much work once per query avoiding repeated calls to the same code as much as possible.
protected QueryEvaluationStep	prepare(ArbitraryLengthPath alp, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(BinaryTupleOperator expr, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(BindingSetAssignment node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(BNodeGenerator node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(Bound node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(Coalesce node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(CompareAll node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(CompareAny node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(Compare node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(Datatype node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(Difference node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(Distinct node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(EmptySet emptySet, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(Now node, QueryEvaluationContext context)	During the execution of a single query NOW() should always return the same result and is in practical terms a constant during evaluation.
protected QueryValueEvaluationStep	prepare(Exists node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(Extension node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(Filter node, QueryEvaluationContext context)
QueryValueEvaluationStep	prepare(FunctionCall node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(Group node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(If node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(In node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(Intersection node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(IRIFunction node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(IsBNode node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(IsLiteral node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(IsNumeric node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(IsResource node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(IsURI node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(Join node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(Label node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(LangMatches node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(Lang node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(LeftJoin node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(ListMemberOperator node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(LocalName node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(MathExpr node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(MultiProjection node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(Namespace node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(Not node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(Order node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(Or node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(Projection node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(QueryRoot node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(Reduced node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(Regex node, QueryEvaluationContext context)	Determines whether the two operands match according to the regex operator.
protected QueryValueEvaluationStep	prepare(SameTerm node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(Service service, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(SingletonSet singletonSet, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(Slice node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(StatementPattern node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(Str node, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(TripleRef ref, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(TupleFunctionCall expr, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(UnaryTupleOperator expr, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(Union node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(ValueConstant valueConstant, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(ValueExprTripleRef node, QueryEvaluationContext context)
protected QueryValueEvaluationStep	prepare(Var var, QueryEvaluationContext context)
protected QueryEvaluationStep	prepare(ZeroLengthPath zlp, QueryEvaluationContext context)
void	setCollectionFactory(Supplier<CollectionFactory> cf)	Set the collection factory that will create the collections to use during query evaluaton.
void	setFederatedServiceResolver(FederatedServiceResolver resolver)	Sets the FederatedServiceResolver to use for this client.
void	setOptimizerPipeline(QueryOptimizerPipeline pipeline)	Set the QueryOptimizerPipeline to use for optimizing any incoming queries.
void	setQueryEvaluationMode(QueryEvaluationMode queryEvaluationMode)
void	setTrackResultSize(boolean trackResultSize)	Enable or disable results size tracking for the query plan.
void	setTrackTime(boolean trackTime)	Enable or disable time tracking for the query plan.
protected QueryValueEvaluationStep	supplyBinaryValueEvaluation(BinaryValueOperator node, BiFunction<Value,Value,Value> operation, QueryEvaluationContext context)	Supply a QueryValueEvalationStep that will invoke the function (operator passed in).
protected QueryValueEvaluationStep	supplyUnaryValueEvaluation(UnaryValueOperator node, Function<Value,Value> operation, QueryEvaluationContext context)	Return a QueryEvaluationStep that applies constant propegation.

Methods inherited from class Object

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

Constructor Details

SparqlFederationEvalStrategy

public SparqlFederationEvalStrategy(FederationContext federationContext)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

evaluateBoundJoinStatementPattern

public CloseableIteration<BindingSet> evaluateBoundJoinStatementPattern(StatementTupleExpr stmt,
 List<BindingSet> bindings)
                                                                 throws QueryEvaluationException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FederationEvalStrategy

Evaluate a bound join at the relevant endpoint, i.e. i.e. for a group of bindings retrieve results for the bound statement from the relevant endpoints

Specified by:

evaluateBoundJoinStatementPattern in class FederationEvalStrategy

Parameters:

stmt -

bindings -

Returns:

the result iteration

Throws:

QueryEvaluationException

evaluateBoundJoinStatementPattern_UNION

@Deprecated(forRemoval=true)
protected CloseableIteration<BindingSet> evaluateBoundJoinStatementPattern_UNION(StatementTupleExpr stmt,
 List<BindingSet> bindings)
                                                                          throws QueryEvaluationException

Deprecated, for removal: This API element is subject to removal in a future version.

no longer used

Alternative evaluation implementation using UNION. Nowadays we use a VALUES clause based implementation

Throws:

QueryEvaluationException

evaluateGroupedCheck

public CloseableIteration<BindingSet> evaluateGroupedCheck(CheckStatementPattern stmt,
 List<BindingSet> bindings)
                                                    throws QueryEvaluationException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FederationEvalStrategy

Perform a grouped check at the relevant endpoints, i.e. for a group of bindings keep only those for which at least one endpoint provides a result to the bound statement.

Specified by:

evaluateGroupedCheck in class FederationEvalStrategy

Parameters:

stmt -

bindings -

Returns:

the result iteration

Throws:

QueryEvaluationException

executeJoin

public CloseableIteration<BindingSet> executeJoin(ControlledWorkerScheduler<BindingSet> joinScheduler,
 CloseableIteration<BindingSet> leftIter,
 TupleExpr rightArg,
 Set<String> joinVars,
 BindingSet bindings,
 QueryInfo queryInfo)
                                           throws QueryEvaluationException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FederationEvalStrategy

Execute the join in a separate thread using some join executor. Join executors are for instance:

• ControlledWorkerJoin
• ControlledWorkerBindJoin

For endpoint federation use controlled worker bound join, for local federation use controlled worker join. The other operators are there for completeness. Use FederationEvalStrategy.executor to execute the join (it is a runnable).

Specified by:

executeJoin in class FederationEvalStrategy

Parameters:

joinScheduler -

leftIter -

rightArg -

joinVars -

bindings -

Returns:

the result

Throws:

QueryEvaluationException

executeLeftJoin

protected CloseableIteration<BindingSet> executeLeftJoin(ControlledWorkerScheduler<BindingSet> joinScheduler,
 CloseableIteration<BindingSet> leftIter,
 LeftJoin leftJoin,
 BindingSet bindings,
 QueryInfo queryInfo)
                                                  throws QueryEvaluationException

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: FederationEvalStrategy

Execute the left join in a separate thread using some join executor.

Specified by:

executeLeftJoin in class FederationEvalStrategy

Parameters:

joinScheduler -

leftIter -

leftJoin -

bindings -

Returns:

the result

Throws:

QueryEvaluationException

evaluateExclusiveGroup

public CloseableIteration<BindingSet> evaluateExclusiveGroup(ExclusiveGroup group,
 BindingSet bindings)
                                                      throws RepositoryException,
MalformedQueryException,
QueryEvaluationException

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

evaluateExclusiveGroup in class FederationEvalStrategy

Throws:

RepositoryException

MalformedQueryException

QueryEvaluationException