Class BinaryTupleOperator

java.lang.Object

org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode

org.eclipse.rdf4j.query.algebra.BinaryTupleOperator

All Implemented Interfaces:

Serializable, Cloneable, QueryModelNode, TupleExpr, VariableScopeChange

Direct Known Subclasses:

Difference, Intersection, Join, LeftJoin, Union

public abstract class BinaryTupleOperator
extends AbstractQueryModelNode
implements TupleExpr

An abstract superclass for binary tuple operators which, by definition, has two arguments.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected TupleExpr	leftArg	The operator's left argument.
protected TupleExpr	rightArg	The operator's right argument.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BinaryTupleOperator()
protected	BinaryTupleOperator(TupleExpr leftArg, TupleExpr rightArg)	Creates a new binary tuple operator.

Method Summary

Modifier and Type	Method	Description
BinaryTupleOperator	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.
String	getAlgorithmName()
TupleExpr	getLeftArg()	Gets the left argument of this binary tuple operator.
Var	getOrder()
TupleExpr	getRightArg()	Gets the right argument of this binary tuple operator.
Set<Var>	getSupportedOrders(AvailableStatementOrder tripleSource)
int	hashCode()
void	replaceChildNode(QueryModelNode current, QueryModelNode replacement)	Replaces one of the child nodes with a new node.
void	setAlgorithm(String classSimpleName)
void	setAlgorithm(CloseableIteration<?> iteration)
void	setLeftArg(TupleExpr leftArg)	Sets the left argument of this binary tuple operator.
void	setOrder(Var var)
void	setRightArg(TupleExpr rightArg)	Sets the right argument of this binary tuple operator.
<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

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

Methods inherited from interface QueryModelNode

visit

Modifier and Type	Method	Description
<X extends Exception> void	visit(QueryModelVisitor<X> visitor)	Visits this node.

Methods inherited from interface TupleExpr

getAssuredBindingNames, getBindingNames

Modifier and Type	Method	Description
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.

Field Details

leftArg

protected TupleExpr leftArg

The operator's left argument.

rightArg

protected TupleExpr rightArg

The operator's right argument.

Constructor Details

BinaryTupleOperator

protected BinaryTupleOperator()

BinaryTupleOperator

protected BinaryTupleOperator(TupleExpr leftArg,
 TupleExpr rightArg)

Creates a new binary tuple operator.

Parameters:

leftArg - The operator's left argument, must not be null.

rightArg - The operator's right argument, must not be null.

Method Details

getLeftArg

public TupleExpr getLeftArg()

Gets the left argument of this binary tuple operator.

Returns:

The operator's left argument.

setLeftArg

public void setLeftArg(TupleExpr leftArg)

Sets the left argument of this binary tuple operator.

Parameters:

leftArg - The (new) left argument for this operator, must not be null.

getRightArg

public TupleExpr getRightArg()

Gets the right argument of this binary tuple operator.

Returns:

The operator's right argument.

setRightArg

public void setRightArg(TupleExpr rightArg)

Sets the right argument of this binary tuple operator.

Parameters:

rightArg - The (new) right argument for this operator, must not be null.

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.

equals

public boolean equals(Object other)

Description copied from interface: QueryModelNode

Returns true if this query model node and its children are recursively equal to o and its children.

Specified by:

equals in interface QueryModelNode

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public BinaryTupleOperator 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.

setAlgorithm

@Experimental
public void setAlgorithm(CloseableIteration<?> iteration)

setAlgorithm

@Experimental
public void setAlgorithm(String classSimpleName)

getAlgorithmName

@Experimental
public String getAlgorithmName()

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