Package org.eclipse.rdf4j.query.algebra

Class TupleFunctionCall

java.lang.Object

org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode

org.eclipse.rdf4j.query.algebra.QueryModelNodeBase

org.eclipse.rdf4j.query.algebra.TupleFunctionCall

All Implemented Interfaces:

Serializable, Cloneable, GraphPatternGroupable, QueryModelNode, TupleExpr, VariableScopeChange

public class TupleFunctionCall
extends QueryModelNodeBase
implements TupleExpr

A call to a TupleFunction. This is an optional extension to the query model.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TupleFunctionCall()

Method Summary

Modifier and Type	Method	Description
void	addArg(ValueExpr arg)
void	addArgs(Iterable<ValueExpr> args)
void	addArgs(ValueExpr... args)
void	addResultVar(Var resultVar)
void	addResultVars(Iterable<Var> resultVars)
void	addResultVars(Var... resultVars)
TupleFunctionCall	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.
List<ValueExpr>	getArgs()
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<Var>	getResultVars()
String	getSignature()	Default implementation of QueryModelNode.getSignature() that prints the name of the node's class.
String	getURI()
int	hashCode()
void	replaceChildNode(QueryModelNode current, QueryModelNode replacement)	Default implementation of QueryModelNode.replaceChildNode(QueryModelNode, QueryModelNode) that throws an IllegalArgumentException indicating that current is not a child node of this node.
void	setArgs(Iterable<ValueExpr> args)
void	setResultVars(Iterable<Var> resultVars)
void	setURI(String uri)
<X extends Exception> void	visit(QueryModelVisitor<X> visitor)	Visits this node.
<X extends Exception> void	visitChildren(QueryModelVisitor<X> visitor)	Dummy implementation of QueryModelNode.visitChildren(org.eclipse.rdf4j.query.algebra.QueryModelVisitor<X>) that does nothing.

Methods inherited from class org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode

getCardinality, getCostEstimate, getParentNode, getResultSizeActual, getResultSizeEstimate, getTotalTimeNanosActual, isCardinalitySet, isGraphPatternGroup, isVariableScopeChange, nullEquals, replaceNodeInList, replaceWith, resetCardinality, setCardinality, setCostEstimate, setGraphPatternGroup, setParentNode, setResultSizeActual, setResultSizeEstimate, setTotalTimeNanosActual, setVariableScopeChange, shouldCacheCardinality, 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

TupleFunctionCall

public TupleFunctionCall()

Method Detail

getURI

public String getURI()

setURI

public void setURI(String uri)

getArgs

public List<ValueExpr> getArgs()

setArgs

public void setArgs(Iterable<ValueExpr> args)

addArgs

public void addArgs(ValueExpr... args)

addArgs

public void addArgs(Iterable<ValueExpr> args)

addArg

public void addArg(ValueExpr arg)

getResultVars

public List<Var> getResultVars()

setResultVars

public void setResultVars(Iterable<Var> resultVars)

addResultVars

public void addResultVars(Var... resultVars)

addResultVars

public void addResultVars(Iterable<Var> resultVars)

addResultVar

public void addResultVar(Var resultVar)

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.

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 interface QueryModelNode

Throws:

X extends Exception

visitChildren

public <X extends Exception> void visitChildren(QueryModelVisitor<X> visitor)
                                         throws X extends Exception

Description copied from class: AbstractQueryModelNode

Dummy implementation of QueryModelNode.visitChildren(org.eclipse.rdf4j.query.algebra.QueryModelVisitor<X>) that does nothing. Subclasses should override this method when they have child nodes.

Specified by:

visitChildren in interface QueryModelNode

Overrides:

visitChildren in class AbstractQueryModelNode

Throws:

X extends Exception

replaceChildNode

public void replaceChildNode(QueryModelNode current,
                             QueryModelNode replacement)

Description copied from class: AbstractQueryModelNode

Default implementation of QueryModelNode.replaceChildNode(QueryModelNode, QueryModelNode) that throws an IllegalArgumentException indicating that current is not a child node of this node.

Specified by:

replaceChildNode in interface QueryModelNode

Overrides:

replaceChildNode in class AbstractQueryModelNode

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