Class ExclusiveArbitraryLengthPath

java.lang.Object

org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode

org.eclipse.rdf4j.query.algebra.ArbitraryLengthPath

org.eclipse.rdf4j.federated.algebra.ExclusiveArbitraryLengthPath

All Implemented Interfaces:

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

public class ExclusiveArbitraryLengthPath
extends ArbitraryLengthPath
implements ExclusiveTupleExprRenderer

An ArbitraryLengthPath node which can be evaluated at a single node.

Author:

Andreas Schwarte

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExclusiveArbitraryLengthPath(ArbitraryLengthPath path, StatementSource owner, QueryInfo queryInfo)

Method Summary

Modifier and Type	Method	Description
ExclusiveArbitraryLengthPath	clone()	Returns a (deep) clone of this query model node.
List<String>	getFreeVars()
StatementSource	getOwner()
QueryInfo	getQueryInfo()	Retrieve the attached query information of the tuple expression
TupleExpr	toQueryAlgebra(Set<String> varNames, BindingSet bindings)	Returns a SPARQL algebra representation of this expression that can be inserted into a SELECT TupleExpr
String	toQueryString(Set<String> varNames, BindingSet bindings)	Returns a SPARQL string representation of this expression that can be inserted into a SELECT query.

Methods inherited from class ArbitraryLengthPath

equals, getAssuredBindingNames, getBindingNames, getContextVar, getMinLength, getObjectVar, getOrder, getPathExpression, getScope, getSignature, getSubjectVar, getSupportedOrders, hashCode, replaceChildNode, setContextVar, setMinLength, setObjectVar, setOrder, setPathExpression, setScope, setSubjectVar, visit, visitChildren

Modifier and Type	Method	Description
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.
long	getMinLength()
Var	getObjectVar()
Var	getOrder()
TupleExpr	getPathExpression()
StatementPattern.Scope	getScope()	Gets the context scope for the arbitrary-length path.
String	getSignature()	Default implementation of QueryModelNode.getSignature() that prints the name of the node's class.
Var	getSubjectVar()
Set<Var>	getSupportedOrders(AvailableStatementOrder tripleSource)
int	hashCode()
void	replaceChildNode(QueryModelNode current, QueryModelNode replacement)	Replaces one of the child nodes with a new node.
void	setContextVar(Var context)
void	setMinLength(long minLength)
void	setObjectVar(Var object)
void	setOrder(Var var)
void	setPathExpression(TupleExpr pathExpression)
void	setScope(StatementPattern.Scope scope)	Sets the context scope for the arbitrary-length path
void	setSubjectVar(Var subject)
<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, 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.
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 FedXTupleExpr

getFreeVarCount

Modifier and Type	Method	Description
default int	getFreeVarCount()

Constructor Details

ExclusiveArbitraryLengthPath

public ExclusiveArbitraryLengthPath(ArbitraryLengthPath path,
 StatementSource owner,
 QueryInfo queryInfo)

Method Details

getOwner

public StatementSource getOwner()

Specified by:

getOwner in interface ExclusiveTupleExpr

Returns:

the owner for this expression

clone

public ExclusiveArbitraryLengthPath 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 ArbitraryLengthPath

Returns:

A deep clone of this query model node.

toQueryString

public String toQueryString(Set<String> varNames,
 BindingSet bindings)

Description copied from interface: ExclusiveTupleExprRenderer

Returns a SPARQL string representation of this expression that can be inserted into a SELECT query.

Implementations are required to create a valid query string for this expression where the given bindings are inserted.

Specified by:

toQueryString in interface ExclusiveTupleExprRenderer

Parameters:

varNames - the set of resulting (unbound) variables from this expression

bindings - the optional input bindings

Returns:

the query string part

toQueryAlgebra

public TupleExpr toQueryAlgebra(Set<String> varNames,
 BindingSet bindings)

Description copied from interface: ExclusiveTupleExprRenderer

Returns a SPARQL algebra representation of this expression that can be inserted into a SELECT TupleExpr

Implementations are required to create a new equivalent expression or clone, where any provided input bindings are inserted. The free variable names after insertion need to be added to the provided set.

Specified by:

toQueryAlgebra in interface ExclusiveTupleExprRenderer

Parameters:

varNames - the set of resulting (unbound) variables from this expression

bindings - the input bindings that need to be inserted

Returns:

the algebra expression

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