Class PassThroughTupleExpr

java.lang.Object

org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode

org.eclipse.rdf4j.federated.algebra.PassThroughTupleExpr

All Implemented Interfaces:

Serializable, Cloneable, FedXTupleExpr, QueryRef, VariableExpr, QueryModelNode, TupleExpr, VariableScopeChange

public class PassThroughTupleExpr
extends AbstractQueryModelNode
implements FedXTupleExpr

Marker TupleExpr that is used from FedXTupleQuery.evaluate(TupleQueryResultHandler) to allow for passing through of results to the handler.

Passing through of results to the handler is supported for SingleSourceQuerys, i.e. if the original query is sent as is to the single relevant source. In this case no materialization and in-memory handling through FedX is done, if a TupleQueryResultHandler is supplied.

Author:

Andreas Schwarte

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PassThroughTupleExpr(TupleExpr parsedQuery, TupleQueryResultHandler resultHandler)

Method Summary

Modifier and Type	Method	Description
PassThroughTupleExpr	clone()	Returns a (deep) clone of this query model node.
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.
TupleExpr	getExpr()
List<String>	getFreeVars()
Var	getOrder()
QueryInfo	getQueryInfo()	Retrieve the attached query information of the tuple expression
TupleQueryResultHandler	getResultHandler()
Set<Var>	getSupportedOrders(AvailableStatementOrder tripleSource)
boolean	isPassedThrough()
void	replaceChildNode(QueryModelNode current, QueryModelNode replacement)	Replaces one of the child nodes with a new node.
void	setOrder(Var var)
void	setPassedThrough(boolean flag)
<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 AbstractQueryModelNode

getCardinality, getCostEstimate, getDoubleMetricActual, getDoubleMetricsActual, getHasNextCallCountActual, getHasNextTimeNanosActual, getHasNextTrueCountActual, getJoinLeftBindingsConsumedActual, getJoinRightBindingsConsumedActual, getJoinRightIteratorsCreatedActual, getLongMetricActual, getLongMetricsActual, getNextCallCountActual, getNextTimeNanosActual, getParentNode, getResultSizeActual, getResultSizeEstimate, getSignature, 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, shouldCacheCardinality, 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.
String	getSignature()	Default implementation of QueryModelNode.getSignature() that prints the name of the node's class.
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.
protected boolean	shouldCacheCardinality()
String	toString()	Returns an indented print of the node tree, starting from this node.

Methods inherited from class Object

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

Methods inherited from interface FedXTupleExpr

getFreeVarCount

Modifier and Type	Method	Description
default int	getFreeVarCount()

Methods inherited from interface QueryModelNode

equals

Modifier and Type	Method	Description
boolean	equals(Object o)	Returns true if this query model node and its children are recursively equal to o and its children.

Constructor Details

PassThroughTupleExpr

public PassThroughTupleExpr(TupleExpr parsedQuery,
 TupleQueryResultHandler resultHandler)

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

Throws:

X

replaceChildNode

public void replaceChildNode(QueryModelNode current,
 QueryModelNode replacement)

Description copied from interface: QueryModelNode

Replaces one of the child nodes with a new node.

Specified by:

replaceChildNode in interface QueryModelNode

Parameters:

current - The current child node.

replacement - The new child node.

getResultHandler

public TupleQueryResultHandler getResultHandler()

getExpr

public TupleExpr getExpr()

isPassedThrough

public boolean isPassedThrough()

Returns:

if the query result has already been passed through to the supplied TupleQueryResultHandler

setPassedThrough

public void setPassedThrough(boolean flag)

getBindingNames

public Set<String> getBindingNames()

Description copied from interface: TupleExpr

Gets the names of the bindings that are, or can be, returned by this tuple expression when it is evaluated.

Specified by:

getBindingNames in interface TupleExpr

Returns:

A set of binding names.

getAssuredBindingNames

public Set<String> getAssuredBindingNames()

Description copied from interface: TupleExpr

Gets the names of the bindings that are guaranteed to be present in the results produced by this tuple expression.

Specified by:

getAssuredBindingNames in interface TupleExpr

Returns:

A set of binding names.

clone

public PassThroughTupleExpr clone()

Description copied from interface: QueryModelNode

Returns a (deep) clone of this query model node. This method recursively clones the entire node tree, starting from this nodes.

Specified by:

clone in interface QueryModelNode

Specified by:

clone in interface TupleExpr

Overrides:

clone in class AbstractQueryModelNode

Returns:

A deep clone of this query model node.

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

Throws:

X

getFreeVars

public List<String> getFreeVars()

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

getSupportedOrders

public Set<Var> getSupportedOrders(AvailableStatementOrder tripleSource)

Specified by:

getSupportedOrders in interface TupleExpr

setOrder

public void setOrder(Var var)

Specified by:

setOrder in interface TupleExpr

getOrder

public Var getOrder()

Specified by:

getOrder in interface TupleExpr