Class TripleRefJoinGroup

java.lang.Object

org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode

org.eclipse.rdf4j.federated.algebra.TripleRefJoinGroup

All Implemented Interfaces:

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

public class TripleRefJoinGroup
extends AbstractQueryModelNode
implements FedXTupleExpr

A join group around a TripleRefStatementPattern: besides the TripleRefStatementPattern it contains the list of StatementPattern sharing the same subject (typically a blank node). TripleRefJoinGroup can be associated to multiple StatementSources, where on each it gets executed in a single expression.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TripleRefJoinGroup(TripleRefStatementPattern tripleRef, List<StatementPattern> stmts, List<StatementSource> statementSources, QueryInfo queryInfo)

Method Summary

Modifier and Type	Method	Description
TripleRefJoinGroup	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.
List<String>	getFreeVars()
QueryInfo	getQueryInfo()	Retrieve the attached query information of the tuple expression
List<StatementPattern>	getStatementPatterns()
List<StatementSource>	getStatementSources()
TripleRefStatementPattern	getTripleRefStatementPattern()
void	replaceChildNode(QueryModelNode current, QueryModelNode replacement)	Replaces one of the child nodes with a new node.
<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

clearQueryModelMetadata, getCardinality, getCostEstimate, getDoubleMetricActual, getDoubleMetricPlanned, getDoubleMetricsActual, getDoubleMetricsPlanned, getHasNextCallCountActual, getHasNextTimeNanosActual, getHasNextTrueCountActual, getJoinLeftBindingsConsumedActual, getJoinRightBindingsConsumedActual, getJoinRightIteratorsCreatedActual, getLongMetricActual, getLongMetricPlanned, getLongMetricsActual, getLongMetricsPlanned, getNextCallCountActual, getNextTimeNanosActual, getParentNode, getQueryModelMetadata, getResultSizeActual, getResultSizeEstimate, getSignature, getSourceRowsFilteredActual, getSourceRowsMatchedActual, getSourceRowsScannedActual, getStringMetricActual, getStringMetricPlanned, getStringMetricsActual, getStringMetricsPlanned, getTotalTimeNanosActual, isCardinalitySet, isRuntimeTelemetryEnabled, isVariableScopeChange, nullEquals, removeQueryModelMetadata, replaceNodeInList, replaceWith, resetCardinality, setCardinality, setCostEstimate, setDoubleMetricActual, setDoubleMetricPlanned, setHasNextCallCountActual, setHasNextTimeNanosActual, setHasNextTrueCountActual, setJoinLeftBindingsConsumedActual, setJoinRightBindingsConsumedActual, setJoinRightIteratorsCreatedActual, setLongMetricActual, setLongMetricPlanned, setNextCallCountActual, setNextTimeNanosActual, setParentNode, setQueryModelMetadata, setResultSizeActual, setResultSizeEstimate, setRuntimeTelemetryEnabled, setSourceRowsFilteredActual, setSourceRowsMatchedActual, setSourceRowsScannedActual, setStringMetricActual, setStringMetricPlanned, setTotalTimeNanosActual, setVariableScopeChange, shouldCacheCardinality, toString

Modifier and Type	Method	Description
void	clearQueryModelMetadata()	Clears all transient optimizer metadata attached to this query model node.
double	getCardinality()
double	getCostEstimate()
double	getDoubleMetricActual(String metricName)
double	getDoubleMetricPlanned(String metricName)
Map<String,Double>	getDoubleMetricsActual()
Map<String,Double>	getDoubleMetricsPlanned()
long	getHasNextCallCountActual()
long	getHasNextTimeNanosActual()
long	getHasNextTrueCountActual()
long	getJoinLeftBindingsConsumedActual()
long	getJoinRightBindingsConsumedActual()
long	getJoinRightIteratorsCreatedActual()
long	getLongMetricActual(String metricName)
long	getLongMetricPlanned(String metricName)
Map<String,Long>	getLongMetricsActual()
Map<String,Long>	getLongMetricsPlanned()
long	getNextCallCountActual()
long	getNextTimeNanosActual()
QueryModelNode	getParentNode()	Gets the node's parent.
Object	getQueryModelMetadata(Object key)	Returns transient optimizer metadata attached to this query model node for the supplied key.
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)
String	getStringMetricPlanned(String metricName)
Map<String,String>	getStringMetricsActual()
Map<String,String>	getStringMetricsPlanned()
long	getTotalTimeNanosActual()
boolean	isCardinalitySet()
boolean	isRuntimeTelemetryEnabled()
boolean	isVariableScopeChange()	indicates if the node represents a variable scope change.
protected boolean	nullEquals(Object o1, Object o2)
Object	removeQueryModelMetadata(Object key)	Removes transient optimizer metadata from this query model node.
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	setDoubleMetricPlanned(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	setLongMetricPlanned(String metricName, long metricValue)
void	setNextCallCountActual(long nextCallCountActual)
void	setNextTimeNanosActual(long nextTimeNanosActual)
void	setParentNode(QueryModelNode parent)	Sets the node's parent.
void	setQueryModelMetadata(Object key, Object value)	Attaches transient optimizer metadata to this query model node.
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	setStringMetricPlanned(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.

Methods inherited from interface TupleExpr

getOrder, getSupportedOrders, setOrder

Modifier and Type	Method	Description
default Var	getOrder()
default Set<Var>	getSupportedOrders(AvailableStatementOrder tripleSource)
default void	setOrder(Var var)

Constructor Details

TripleRefJoinGroup

public TripleRefJoinGroup(TripleRefStatementPattern tripleRef,
 List<StatementPattern> stmts,
 List<StatementSource> statementSources,
 QueryInfo queryInfo)

Method Details

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.

getStatementSources

public List<StatementSource> getStatementSources()

getTripleRefStatementPattern

public TripleRefStatementPattern getTripleRefStatementPattern()

getStatementPatterns

public List<StatementPattern> getStatementPatterns()

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

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.

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

clone

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