Package org.eclipse.rdf4j.query.algebra
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 class
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
All Methods Instance Methods Concrete Methods 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 ofQueryModelNode.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>>
LgetVars(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>
voidvisit(QueryModelVisitor<X> visitor)
Visits this node.<X extends Exception>
voidvisitChildren(QueryModelVisitor<X> visitor)
Visits the children of this node.-
Methods inherited from class org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode
getCardinality, getCostEstimate, getParentNode, getResultSizeActual, getResultSizeEstimate, getTotalTimeNanosActual, isCardinalitySet, isVariableScopeChange, nullEquals, replaceNodeInList, replaceWith, resetCardinality, setCardinality, setCostEstimate, setParentNode, setResultSizeActual, setResultSizeEstimate, setTotalTimeNanosActual, setVariableScopeChange, toString
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.rdf4j.query.algebra.QueryModelNode
getCostEstimate, getParentNode, getResultSizeActual, getResultSizeEstimate, getTotalTimeNanosActual, replaceWith, setCostEstimate, setParentNode, setResultSizeActual, setResultSizeEstimate, setTotalTimeNanosActual, toString
-
-
-
-
Constructor Detail
-
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 Detail
-
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 interfaceTupleExpr
- 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 interfaceTupleExpr
- Returns:
- A set of binding names.
-
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 extends Exception
Description copied from interface:QueryModelNode
Visits this node. The node reports itself to the visitor with the proper runtime type.- Specified by:
visit
in interfaceQueryModelNode
- Throws:
X extends Exception
-
visitChildren
public <X extends Exception> void visitChildren(QueryModelVisitor<X> visitor) throws X extends Exception
Description copied from interface:QueryModelNode
Visits the children of this node. The node callsQueryModelNode.visit(QueryModelVisitor)
on all of its child nodes.- Specified by:
visitChildren
in interfaceQueryModelNode
- Throws:
X extends Exception
-
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 interfaceQueryModelNode
- Parameters:
current
- The current child node.replacement
- The new child node.
-
getSignature
public String getSignature()
Description copied from class:AbstractQueryModelNode
Default implementation ofQueryModelNode.getSignature()
that prints the name of the node's class.- Specified by:
getSignature
in interfaceQueryModelNode
- Overrides:
getSignature
in classAbstractQueryModelNode
- 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 interfaceQueryModelNode
- Overrides:
equals
in classObject
-
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 interfaceQueryModelNode
- Specified by:
clone
in interfaceTupleExpr
- Overrides:
clone
in classAbstractQueryModelNode
- Returns:
- A deep clone of this query model node.
-
getSupportedOrders
public Set<Var> getSupportedOrders(AvailableStatementOrder tripleSource)
- Specified by:
getSupportedOrders
in interfaceTupleExpr
-
shouldCacheCardinality
protected boolean shouldCacheCardinality()
- Overrides:
shouldCacheCardinality
in classAbstractQueryModelNode
-
getStatementOrder
public StatementOrder getStatementOrder()
-
getIndexName
@Experimental public String getIndexName()
-
setIndexName
@Experimental public void setIndexName(String indexName)
-
-