Class StatementPattern

java.lang.Object

org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode

org.eclipse.rdf4j.query.algebra.StatementPattern

All Implemented Interfaces:

Serializable, Cloneable, QueryModelNode, TupleExpr, VariableScopeChange

Direct Known Subclasses:

EmptyStatementPattern, FedXStatementPattern, TrueStatementPattern

public class StatementPattern
extends AbstractQueryModelNode
implements TupleExpr

A tuple expression that matches a statement pattern against an RDF graph. Statement patterns can be targeted at one of three context scopes: all contexts, null context only, or named contexts only.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	StatementPattern.Scope	Indicates the scope of the statement pattern.

Constructor Summary

Constructors

Constructor	Description
StatementPattern(StatementPattern.Scope scope, Var subject, Var predicate, Var object)	Creates a statement pattern that matches a subject-, predicate- and object variable against statements from the specified context scope.
StatementPattern(StatementPattern.Scope scope, Var subjVar, Var predVar, Var objVar, Var conVar)	Creates a statement pattern that matches a subject-, predicate-, object- and context variable against statements from the specified context scope.
StatementPattern(Var subject, Var predicate, Var object)	Creates a statement pattern that matches a subject-, predicate- and object variable against statements from all contexts.
StatementPattern(Var subject, Var predicate, Var object, Var context)	Creates a statement pattern that matches a subject-, predicate-, object- and context variable against statements from all contexts.

Method Summary

Modifier and Type	Method	Description
StatementPattern	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.
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.
String	getIndexName()
Var	getObjectVar()
Var	getOrder()
Var	getPredicateVar()
StatementPattern.Scope	getScope()	Gets the context scope for the statement pattern.
String	getSignature()	Default implementation of QueryModelNode.getSignature() that prints the name of the node's class.
StatementOrder	getStatementOrder()
Var	getSubjectVar()
Set<Var>	getSupportedOrders(AvailableStatementOrder tripleSource)
List<Var>	getVarList()
<L extends Collection<Var>> L	getVars(L varCollection)	Adds the variables of this statement pattern to the supplied collection.
int	hashCode()
void	replaceChildNode(QueryModelNode current, QueryModelNode replacement)	Replaces one of the child nodes with a new node.
void	setIndexName(String indexName)
void	setOrder(Var var)
protected boolean	shouldCacheCardinality()
<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, 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.
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

Constructor Details

StatementPattern

public StatementPattern(Var subject,
 Var predicate,
 Var object)

Creates a statement pattern that matches a subject-, predicate- and object variable against statements from all contexts.

StatementPattern

public StatementPattern(StatementPattern.Scope scope,
 Var subject,
 Var predicate,
 Var object)

Creates a statement pattern that matches a subject-, predicate- and object variable against statements from the specified context scope.

StatementPattern

public StatementPattern(Var subject,
 Var predicate,
 Var object,
 Var context)

Creates a statement pattern that matches a subject-, predicate-, object- and context variable against statements from all contexts.

StatementPattern

public StatementPattern(StatementPattern.Scope scope,
 Var subjVar,
 Var predVar,
 Var objVar,
 Var conVar)

Creates a statement pattern that matches a subject-, predicate-, object- and context variable against statements from the specified context scope.

Method Details

getScope

public StatementPattern.Scope getScope()

Gets the context scope for the statement pattern.

getSubjectVar

public Var getSubjectVar()

getPredicateVar

public Var getPredicateVar()

getObjectVar

public Var getObjectVar()

getContextVar

public Var getContextVar()

Returns the context variable, if available.

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.

getVarList

public List<Var> getVarList()

getVars

public <L extends Collection<Var>> L getVars(L varCollection)

Adds the variables of this statement pattern to the supplied collection.

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.

getSignature

public String getSignature()

Description copied from class: AbstractQueryModelNode

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

Specified by:

getSignature in interface QueryModelNode

Overrides:

getSignature in class AbstractQueryModelNode

Returns:

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

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

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

shouldCacheCardinality

protected boolean shouldCacheCardinality()

Overrides:

shouldCacheCardinality in class AbstractQueryModelNode

getStatementOrder

public StatementOrder getStatementOrder()

getOrder

public Var getOrder()

Specified by:

getOrder in interface TupleExpr

getIndexName

@Experimental
public String getIndexName()

setIndexName

@Experimental
public void setIndexName(String indexName)