Class FedXStatementPattern

java.lang.Object

org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode

org.eclipse.rdf4j.query.algebra.StatementPattern

org.eclipse.rdf4j.federated.algebra.FedXStatementPattern

All Implemented Interfaces:

Serializable, Cloneable, BoundJoinTupleExpr, FedXTupleExpr, FilterTuple, QueryRef, StatementTupleExpr, VariableExpr, QueryModelNode, TupleExpr, VariableScopeChange

Direct Known Subclasses:

ExclusiveStatement, StatementSourcePattern

public abstract class FedXStatementPattern
extends StatementPattern
implements StatementTupleExpr, FilterTuple, BoundJoinTupleExpr

Base class providing all common functionality for FedX StatementPatterns

Author:

Andreas Schwarte

See Also:

• StatementSourcePattern
• ExclusiveStatement
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class StatementPattern

StatementPattern.Scope

Modifier and Type	Class	Description
static enum	StatementPattern.Scope	Indicates the scope of the statement pattern.

Field Summary

Fields

Modifier and Type	Field	Description
protected QueryBindingSet	boundFilters
protected FilterValueExpr	filterExpr
protected final List<String>	freeVars
protected final String	id
protected final QueryInfo	queryInfo
protected final List<StatementSource>	statementSources
protected long	upperLimit

Constructor Summary

Constructors

Constructor	Description
FedXStatementPattern(StatementPattern node, QueryInfo queryInfo)

Method Summary

Modifier and Type	Method	Description
void	addBoundFilter(String varName, Value value)	register a filter that can be directly expressed as a binding, e.g.
void	addFilterExpr(FilterExpr expr)	register a new filter expression.
BindingSet	getBoundFilters()	Returns bound filter bindings, that need to be added as additional bindings to the final result
FilterValueExpr	getFilterExpr()
int	getFreeVarCount()
List<String>	getFreeVars()
String	getId()
QueryInfo	getQueryInfo()	Retrieve the attached query information of the tuple expression
int	getSourceCount()
List<StatementSource>	getStatementSources()
long	getUpperLimit()
boolean	hasFilter()
boolean	hasFreeVarsFor(BindingSet bindings)	returns true iff this statement has free variables in the presence of the specified binding set
protected void	initFreeVars()
void	setUpperLimit(long upperLimit)	Set the upper limit for this statement expression (i.e. applied in the evaluation to individual subqueries of this expr)
<X extends Exception> void	visit(QueryModelVisitor<X> visitor)	Visits this node.
<X extends Exception> void	visitChildren(QueryModelVisitor<X> visitor)	Visits the children of this node.

Methods inherited from class StatementPattern

clone, equals, getAssuredBindingNames, getBindingNames, getContextVar, getIndexName, getObjectVar, getOrder, getPredicateVar, getScope, getSignature, getStatementOrder, getSubjectVar, getSupportedOrders, getVarList, getVars, hashCode, replaceChildNode, setIndexName, setOrder, shouldCacheCardinality

Modifier and Type	Method	Description
StatementPattern	clone()	Returns a (deep) clone of this query model node.
boolean	equals(Object other)	Returns true if this query model node and its children are recursively equal to o and its children.
Set<String>	getAssuredBindingNames()	Gets the names of the bindings that are guaranteed to be present in the results produced by this tuple expression.
Set<String>	getBindingNames()	Gets the names of the bindings that are, or can be, returned by this tuple expression when it is evaluated.
Var	getContextVar()	Returns the context variable, if available.
String	getIndexName()
Var	getObjectVar()
Var	getOrder()
Var	getPredicateVar()
StatementPattern.Scope	getScope()	Gets the context scope for the statement pattern.
String	getSignature()	Default implementation of QueryModelNode.getSignature() that prints the name of the node's class.
StatementOrder	getStatementOrder()
Var	getSubjectVar()
Set<Var>	getSupportedOrders(AvailableStatementOrder tripleSource)
List<Var>	getVarList()
<L extends Collection<Var>> L	getVars(L varCollection)	Adds the variables of this statement pattern to the supplied collection.
int	hashCode()
void	replaceChildNode(QueryModelNode current, QueryModelNode replacement)	Replaces one of the child nodes with a new node.
void	setIndexName(String indexName)
void	setOrder(Var var)
protected boolean	shouldCacheCardinality()

Methods inherited from class AbstractQueryModelNode

getCardinality, getCostEstimate, getDoubleMetricActual, getDoubleMetricsActual, getHasNextCallCountActual, getHasNextTimeNanosActual, getHasNextTrueCountActual, getJoinLeftBindingsConsumedActual, getJoinRightBindingsConsumedActual, getJoinRightIteratorsCreatedActual, getLongMetricActual, getLongMetricsActual, getNextCallCountActual, getNextTimeNanosActual, getParentNode, getResultSizeActual, getResultSizeEstimate, getSourceRowsFilteredActual, getSourceRowsMatchedActual, getSourceRowsScannedActual, getStringMetricActual, getStringMetricsActual, getTotalTimeNanosActual, isCardinalitySet, isRuntimeTelemetryEnabled, isVariableScopeChange, nullEquals, replaceNodeInList, replaceWith, resetCardinality, setCardinality, setCostEstimate, setDoubleMetricActual, setHasNextCallCountActual, setHasNextTimeNanosActual, setHasNextTrueCountActual, setJoinLeftBindingsConsumedActual, setJoinRightBindingsConsumedActual, setJoinRightIteratorsCreatedActual, setLongMetricActual, setNextCallCountActual, setNextTimeNanosActual, setParentNode, setResultSizeActual, setResultSizeEstimate, setRuntimeTelemetryEnabled, setSourceRowsFilteredActual, setSourceRowsMatchedActual, setSourceRowsScannedActual, setStringMetricActual, setTotalTimeNanosActual, setVariableScopeChange, toString

Modifier and Type	Method	Description
double	getCardinality()
double	getCostEstimate()
double	getDoubleMetricActual(String metricName)
Map<String,Double>	getDoubleMetricsActual()
long	getHasNextCallCountActual()
long	getHasNextTimeNanosActual()
long	getHasNextTrueCountActual()
long	getJoinLeftBindingsConsumedActual()
long	getJoinRightBindingsConsumedActual()
long	getJoinRightIteratorsCreatedActual()
long	getLongMetricActual(String metricName)
Map<String,Long>	getLongMetricsActual()
long	getNextCallCountActual()
long	getNextTimeNanosActual()
QueryModelNode	getParentNode()	Gets the node's parent.
long	getResultSizeActual()
double	getResultSizeEstimate()	Returns the number of tuples that this QueryNode predicts will be outputted.
long	getSourceRowsFilteredActual()
long	getSourceRowsMatchedActual()
long	getSourceRowsScannedActual()
String	getStringMetricActual(String metricName)
Map<String,String>	getStringMetricsActual()
long	getTotalTimeNanosActual()
boolean	isCardinalitySet()
boolean	isRuntimeTelemetryEnabled()
boolean	isVariableScopeChange()	indicates if the node represents a variable scope change.
protected boolean	nullEquals(Object o1, Object o2)
protected <T extends QueryModelNode> boolean	replaceNodeInList(List<T> list, QueryModelNode current, QueryModelNode replacement)
void	replaceWith(QueryModelNode replacement)	Default implementation of QueryModelNode.replaceWith(QueryModelNode) that throws an IllegalArgumentException indicating that current is not a child node of this node.
void	resetCardinality()
void	setCardinality(double cardinality)
void	setCostEstimate(double costEstimate)
void	setDoubleMetricActual(String metricName, double metricValue)
void	setHasNextCallCountActual(long hasNextCallCountActual)
void	setHasNextTimeNanosActual(long hasNextTimeNanosActual)
void	setHasNextTrueCountActual(long hasNextTrueCountActual)
void	setJoinLeftBindingsConsumedActual(long joinLeftBindingsConsumedActual)
void	setJoinRightBindingsConsumedActual(long joinRightBindingsConsumedActual)
void	setJoinRightIteratorsCreatedActual(long joinRightIteratorsCreatedActual)
void	setLongMetricActual(String metricName, long metricValue)
void	setNextCallCountActual(long nextCallCountActual)
void	setNextTimeNanosActual(long nextTimeNanosActual)
void	setParentNode(QueryModelNode parent)	Sets the node's parent.
void	setResultSizeActual(long resultSizeActual)
void	setResultSizeEstimate(double resultSizeEstimate)
void	setRuntimeTelemetryEnabled(boolean runtimeTelemetryEnabled)
void	setSourceRowsFilteredActual(long sourceRowsFilteredActual)
void	setSourceRowsMatchedActual(long sourceRowsMatchedActual)
void	setSourceRowsScannedActual(long sourceRowsScannedActual)
void	setStringMetricActual(String metricName, String metricValue)
void	setTotalTimeNanosActual(long totalTimeNanosActual)
void	setVariableScopeChange(boolean isVariableScopeChange)	Set the value of VariableScopeChange.isVariableScopeChange() to true or false.
String	toString()	Returns an indented print of the node tree, starting from this node.

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface StatementTupleExpr

evaluate

Modifier and Type	Method	Description
CloseableIteration<BindingSet>	evaluate(BindingSet bindings)	Evaluate this expression using the provided bindings

Field Details

statementSources

protected final List<StatementSource> statementSources

id

protected final String id

queryInfo

protected final QueryInfo queryInfo

freeVars

protected final List<String> freeVars

filterExpr

protected FilterValueExpr filterExpr

boundFilters

protected QueryBindingSet boundFilters

upperLimit

protected long upperLimit

Constructor Details

FedXStatementPattern

public FedXStatementPattern(StatementPattern node,
 QueryInfo queryInfo)

Method Details

visitChildren

public <X extends Exception> void visitChildren(QueryModelVisitor<X> visitor)
                                         throws X

Description copied from interface: QueryModelNode

Visits the children of this node. The node calls QueryModelNode.visit(QueryModelVisitor) on all of its child nodes.

Specified by:

visitChildren in interface QueryModelNode

Overrides:

visitChildren in class StatementPattern

Throws:

X

visit

public <X extends Exception> void visit(QueryModelVisitor<X> visitor)
                                 throws X

Description copied from interface: QueryModelNode

Visits this node. The node reports itself to the visitor with the proper runtime type.

Specified by:

visit in interface QueryModelNode

Overrides:

visit in class StatementPattern

Throws:

X

initFreeVars

protected void initFreeVars()

getFreeVarCount

public int getFreeVarCount()

Specified by:

getFreeVarCount in interface FedXTupleExpr

Returns:

the number of free (i.e. unbound) variables in this expression

getFreeVars

public List<String> getFreeVars()

Specified by:

getFreeVars in interface FilterTuple

Specified by:

getFreeVars in interface VariableExpr

Returns:

a list of free (i.e. unbound) variables in this expression

getQueryInfo

public QueryInfo getQueryInfo()

Description copied from interface: QueryRef

Retrieve the attached query information of the tuple expression

Specified by:

getQueryInfo in interface QueryRef

Returns:

the QueryInfo

getId

public String getId()

Specified by:

getId in interface StatementTupleExpr

Returns:

the id of this expr

hasFreeVarsFor

public boolean hasFreeVarsFor(BindingSet bindings)

Description copied from interface: StatementTupleExpr

returns true iff this statement has free variables in the presence of the specified binding set

Specified by:

hasFreeVarsFor in interface StatementTupleExpr

Parameters:

bindings -

Returns:

whether the statement has free vars

getStatementSources

public List<StatementSource> getStatementSources()

Specified by:

getStatementSources in interface StatementTupleExpr

Returns:

a list of sources that are relevant for evaluation of this expression

getSourceCount

public int getSourceCount()

getFilterExpr

public FilterValueExpr getFilterExpr()

Specified by:

getFilterExpr in interface FilterTuple

Returns:

the currently registered filter expressions, usually of type FilterExpr or ConjunctiveFilterExpr

getBoundFilters

public BindingSet getBoundFilters()

Description copied from interface: FilterTuple

Returns bound filter bindings, that need to be added as additional bindings to the final result

Specified by:

getBoundFilters in interface FilterTuple

Returns:

the bound filters, or null

hasFilter

public boolean hasFilter()

Specified by:

hasFilter in interface FilterTuple

Returns:

true if this expression has a filter to apply

addFilterExpr

public void addFilterExpr(FilterExpr expr)

Description copied from interface: FilterTuple

register a new filter expression. If the expr has already a filter registered, the new expression is added to a ConjunctiveFilterExpr.

Specified by:

addFilterExpr in interface FilterTuple

Parameters:

expr -

addBoundFilter

public void addBoundFilter(String varName,
 Value value)

Description copied from interface: FilterTuple

register a filter that can be directly expressed as a binding, e.g. SELECT * WHERE { ?s p o . FILTER (?s = X) } is equivalent to SELECT * WHERE { X p o . }

Specified by:

addBoundFilter in interface FilterTuple

Parameters:

varName -

value -

setUpperLimit

public void setUpperLimit(long upperLimit)

Set the upper limit for this statement expression (i.e. applied in the evaluation to individual subqueries of this expr)

Parameters:

upperLimit - the upper limit, a negative number means unlimited

getUpperLimit

public long getUpperLimit()

Returns:

the upper limit or a negative number (meaning no LIMIT)