Package org.eclipse.rdf4j.query.algebra

Class AbstractQueryModelNode

java.lang.Object

org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode

All Implemented Interfaces:

Serializable, Cloneable, QueryModelNode, VariableScopeChange

Direct Known Subclasses:

Add, ArbitraryLengthPath, BinaryTupleOperator, BinaryValueOperator, BindingSetAssignment, BNodeGenerator, Bound, BoundFiltersNode, Clear, ConjunctiveFilterExpr, Copy, Create, DeleteData, EmptySet, ExclusiveGroup, ExtensionElem, FedXService, FilterExpr, FunctionCall, GroupElem, HolderNode, If, InsertData, Load, Modify, Move, NAryValueOperator, NTuple, OrderElem, PassThroughTupleExpr, ProjectionElem, ProjectionElemList, SingleSourceQuery, SingletonSet, StatementPattern, StatementSource, SubQueryValueOperator, TripleRef, TupleFunctionCall, UnaryTupleOperator, UnaryValueOperator, ValueConstant, ValueExprTripleRef, Var, ZeroLengthPath

public abstract class AbstractQueryModelNode
extends Object
implements QueryModelNode, VariableScopeChange

Base implementation of QueryModelNode.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractQueryModelNode()

Method Summary

Modifier and Type	Method	Description
AbstractQueryModelNode	clone()	Returns a (deep) clone of this query model node.
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 java.lang.Object

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

Methods inherited from interface org.eclipse.rdf4j.query.algebra.QueryModelNode

equals, replaceChildNode, visit, visitChildren

Constructor Details

AbstractQueryModelNode

public AbstractQueryModelNode()

Method Details

getParentNode

public QueryModelNode getParentNode()

Description copied from interface: QueryModelNode

Gets the node's parent.

Specified by:

getParentNode in interface QueryModelNode

Returns:

The parent node, if any.

setParentNode

public void setParentNode(QueryModelNode parent)

Description copied from interface: QueryModelNode

Sets the node's parent.

Specified by:

setParentNode in interface QueryModelNode

Parameters:

parent - The parent node for this node.

isVariableScopeChange

public boolean isVariableScopeChange()

Description copied from interface: VariableScopeChange

indicates if the node represents a variable scope change.

Specified by:

isVariableScopeChange in interface VariableScopeChange

Returns:

true iff the node represents a variable scope change.

setVariableScopeChange

public void setVariableScopeChange(boolean isVariableScopeChange)

Description copied from interface: VariableScopeChange

Set the value of VariableScopeChange.isVariableScopeChange() to true or false.

Specified by:

setVariableScopeChange in interface VariableScopeChange

replaceWith

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

Specified by:

replaceWith in interface QueryModelNode

Parameters:

replacement - The new node.

getSignature

public String getSignature()

Default implementation of QueryModelNode.getSignature() that prints the name of the node's class.

Specified by:

getSignature in interface QueryModelNode

Returns:

The node's signature, e.g. SLICE (offset=10, limit=10).

toString

public String toString()

Description copied from interface: QueryModelNode

Returns an indented print of the node tree, starting from this node.

Specified by:

toString in interface QueryModelNode

Overrides:

toString in class Object

clone

public AbstractQueryModelNode 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

Overrides:

clone in class Object

Returns:

A deep clone of this query model node.

replaceNodeInList

protected <T extends QueryModelNode> boolean replaceNodeInList(List<T> list,
 QueryModelNode current,
 QueryModelNode replacement)

nullEquals

protected boolean nullEquals(Object o1,
 Object o2)

getResultSizeEstimate

public double getResultSizeEstimate()

Description copied from interface: QueryModelNode

Returns the number of tuples that this QueryNode predicts will be outputted. For a StatementPattern this would be the estimated cardinality provided by the EvaluationStatistics. For a Join the would be the resulting number of joined tuples.

Specified by:

getResultSizeEstimate in interface QueryModelNode

Returns:

rows

setResultSizeEstimate

public void setResultSizeEstimate(double resultSizeEstimate)

Specified by:

setResultSizeEstimate in interface QueryModelNode

getResultSizeActual

public long getResultSizeActual()

Specified by:

getResultSizeActual in interface QueryModelNode

setResultSizeActual

public void setResultSizeActual(long resultSizeActual)

Specified by:

setResultSizeActual in interface QueryModelNode

getCostEstimate

public double getCostEstimate()

Specified by:

getCostEstimate in interface QueryModelNode

setCostEstimate

public void setCostEstimate(double costEstimate)

Specified by:

setCostEstimate in interface QueryModelNode

getTotalTimeNanosActual

public long getTotalTimeNanosActual()

Specified by:

getTotalTimeNanosActual in interface QueryModelNode

setTotalTimeNanosActual

public void setTotalTimeNanosActual(long totalTimeNanosActual)

Specified by:

setTotalTimeNanosActual in interface QueryModelNode

getHasNextCallCountActual

public long getHasNextCallCountActual()

Specified by:

getHasNextCallCountActual in interface QueryModelNode

setHasNextCallCountActual

public void setHasNextCallCountActual(long hasNextCallCountActual)

Specified by:

setHasNextCallCountActual in interface QueryModelNode

getHasNextTrueCountActual

public long getHasNextTrueCountActual()

Specified by:

getHasNextTrueCountActual in interface QueryModelNode

setHasNextTrueCountActual

public void setHasNextTrueCountActual(long hasNextTrueCountActual)

Specified by:

setHasNextTrueCountActual in interface QueryModelNode

getHasNextTimeNanosActual

public long getHasNextTimeNanosActual()

Specified by:

getHasNextTimeNanosActual in interface QueryModelNode

setHasNextTimeNanosActual

public void setHasNextTimeNanosActual(long hasNextTimeNanosActual)

Specified by:

setHasNextTimeNanosActual in interface QueryModelNode

getNextCallCountActual

public long getNextCallCountActual()

Specified by:

getNextCallCountActual in interface QueryModelNode

setNextCallCountActual

public void setNextCallCountActual(long nextCallCountActual)

Specified by:

setNextCallCountActual in interface QueryModelNode

getNextTimeNanosActual

public long getNextTimeNanosActual()

Specified by:

getNextTimeNanosActual in interface QueryModelNode

setNextTimeNanosActual

public void setNextTimeNanosActual(long nextTimeNanosActual)

Specified by:

setNextTimeNanosActual in interface QueryModelNode

getJoinRightIteratorsCreatedActual

public long getJoinRightIteratorsCreatedActual()

Specified by:

getJoinRightIteratorsCreatedActual in interface QueryModelNode

setJoinRightIteratorsCreatedActual

public void setJoinRightIteratorsCreatedActual(long joinRightIteratorsCreatedActual)

Specified by:

setJoinRightIteratorsCreatedActual in interface QueryModelNode

getJoinLeftBindingsConsumedActual

public long getJoinLeftBindingsConsumedActual()

Specified by:

getJoinLeftBindingsConsumedActual in interface QueryModelNode

setJoinLeftBindingsConsumedActual

public void setJoinLeftBindingsConsumedActual(long joinLeftBindingsConsumedActual)

Specified by:

setJoinLeftBindingsConsumedActual in interface QueryModelNode

getJoinRightBindingsConsumedActual

public long getJoinRightBindingsConsumedActual()

Specified by:

getJoinRightBindingsConsumedActual in interface QueryModelNode

setJoinRightBindingsConsumedActual

public void setJoinRightBindingsConsumedActual(long joinRightBindingsConsumedActual)

Specified by:

setJoinRightBindingsConsumedActual in interface QueryModelNode

getSourceRowsScannedActual

public long getSourceRowsScannedActual()

Specified by:

getSourceRowsScannedActual in interface QueryModelNode

setSourceRowsScannedActual

public void setSourceRowsScannedActual(long sourceRowsScannedActual)

Specified by:

setSourceRowsScannedActual in interface QueryModelNode

getSourceRowsMatchedActual

public long getSourceRowsMatchedActual()

Specified by:

getSourceRowsMatchedActual in interface QueryModelNode

setSourceRowsMatchedActual

public void setSourceRowsMatchedActual(long sourceRowsMatchedActual)

Specified by:

setSourceRowsMatchedActual in interface QueryModelNode

getSourceRowsFilteredActual

public long getSourceRowsFilteredActual()

Specified by:

getSourceRowsFilteredActual in interface QueryModelNode

setSourceRowsFilteredActual

public void setSourceRowsFilteredActual(long sourceRowsFilteredActual)

Specified by:

setSourceRowsFilteredActual in interface QueryModelNode

getLongMetricsActual

public Map<String,Long> getLongMetricsActual()

Specified by:

getLongMetricsActual in interface QueryModelNode

getLongMetricActual

public long getLongMetricActual(String metricName)

Specified by:

getLongMetricActual in interface QueryModelNode

setLongMetricActual

public void setLongMetricActual(String metricName,
 long metricValue)

Specified by:

setLongMetricActual in interface QueryModelNode

getDoubleMetricsActual

public Map<String,Double> getDoubleMetricsActual()

Specified by:

getDoubleMetricsActual in interface QueryModelNode

getDoubleMetricActual

public double getDoubleMetricActual(String metricName)

Specified by:

getDoubleMetricActual in interface QueryModelNode

setDoubleMetricActual

public void setDoubleMetricActual(String metricName,
 double metricValue)

Specified by:

setDoubleMetricActual in interface QueryModelNode

getStringMetricsActual

public Map<String,String> getStringMetricsActual()

Specified by:

getStringMetricsActual in interface QueryModelNode

getStringMetricActual

public String getStringMetricActual(String metricName)

Specified by:

getStringMetricActual in interface QueryModelNode

setStringMetricActual

public void setStringMetricActual(String metricName,
 String metricValue)

Specified by:

setStringMetricActual in interface QueryModelNode

isRuntimeTelemetryEnabled

public boolean isRuntimeTelemetryEnabled()

Specified by:

isRuntimeTelemetryEnabled in interface QueryModelNode

setRuntimeTelemetryEnabled

public void setRuntimeTelemetryEnabled(boolean runtimeTelemetryEnabled)

Specified by:

setRuntimeTelemetryEnabled in interface QueryModelNode

getCardinality

@Experimental
public double getCardinality()

setCardinality

@Experimental
public void setCardinality(double cardinality)

resetCardinality

@Experimental
public void resetCardinality()

isCardinalitySet

@Experimental
public boolean isCardinalitySet()

shouldCacheCardinality

@Experimental
protected boolean shouldCacheCardinality()