Package org.eclipse.rdf4j.query.algebra

Class FunctionCall

java.lang.Object

org.eclipse.rdf4j.query.algebra.AbstractQueryModelNode

org.eclipse.rdf4j.query.algebra.FunctionCall

All Implemented Interfaces:

Serializable, Cloneable, GraphPatternGroupable, QueryModelNode, ValueExpr, VariableScopeChange

public class FunctionCall
extends AbstractQueryModelNode
implements ValueExpr

A call to an (external) function that operates on zero or more arguments.

Author:

Arjohn Kampman

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ValueExpr>	args	The operator's argument.
protected String	uri

Constructor Summary

Constructors

Constructor	Description
FunctionCall()
FunctionCall(String uri, Iterable<ValueExpr> args)
FunctionCall(String uri, ValueExpr... args)	Creates a new unary value operator.

Method Summary

Modifier and Type	Method	Description
void	addArg(ValueExpr arg)
void	addArgs(Iterable<ValueExpr> args)
void	addArgs(ValueExpr... args)
FunctionCall	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()
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	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

Field Detail

uri

protected String uri

args

protected List<ValueExpr> args

The operator's argument.

Constructor Detail

FunctionCall

public FunctionCall()

FunctionCall

public FunctionCall(String uri,
                    ValueExpr... args)

Creates a new unary value operator.

Parameters:

args - The operator's argument, must not be null.

FunctionCall

public FunctionCall(String uri,
                    Iterable<ValueExpr> args)

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)

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 FunctionCall 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 ValueExpr

Overrides:

clone in class AbstractQueryModelNode

Returns:

A deep clone of this query model node.