Package com.aquima.interactions.expressions.semantics.nodes

Class FunctionCall

java.lang.Object

com.aquima.interactions.expressions.semantics.SemanticNodeBase

com.aquima.interactions.expressions.semantics.nodes.FunctionCall

All Implemented Interfaces:

ISemanticNode

public class FunctionCall
extends SemanticNodeBase

The function expression can be used to invoke a (custom) function.

Since:

6.4

Author:

O. Kerpershoek, F. van der Meer

Constructor Summary

Constructors

Constructor	Description
FunctionCall(Position position, IFunction function, ISemanticNode... parameters)	Constructs the node with the required arguments.

Method Summary

Modifier and Type	Method	Description
void	collectScopedObjects(ScopedObjects resultSet)	This method may be used to collect the names of the objects that need to be in scope in order to evaluate the expression of this node.
ISemanticNode	getArgument(int index)	This method returns the argument node for the specified index (zero based).
int	getArgumentCount()	this method returns an integer containing the number of arguments that are defined for the function.
ISemanticNode[]	getArguments()	This method returns an array containing the nodes of the function arguments.
ISemanticNode[]	getChildNodes()	This method returns an array containing the child nodes.
IFunction	getFunction()	This method returns the function implementation that should be invoked.
String	toString()
void	visit(ISemanticNodeVisitor visitor)	This method allows a type safe visitation of the node.

Methods inherited from class com.aquima.interactions.expressions.semantics.SemanticNodeBase

addMessage, getDataType, getDomain, getMessages, getPosition, getType, hasMessage, isDerivedType, isMultivalue, setDerived, setDomain, setType, setType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FunctionCall

public FunctionCall(Position position,
                    IFunction function,
                    ISemanticNode... parameters)

Constructs the node with the required arguments.

Parameters:

position - Position information for the node.

function - The implementation of the function that should be invoked.

parameters - The parameters (expressions) that should be passed to the function.

Method Detail

getFunction

public IFunction getFunction()

This method returns the function implementation that should be invoked.

Returns:

the function implementation that should be invoked.

getArguments

public ISemanticNode[] getArguments()

This method returns an array containing the nodes of the function arguments.

Returns:

an array containing the nodes of the function arguments.

getArgument

public ISemanticNode getArgument(int index)

This method returns the argument node for the specified index (zero based).

Parameters:

index - The index of the requested argument node.

Returns:

the argument node for the specified index.

getArgumentCount

public int getArgumentCount()

this method returns an integer containing the number of arguments that are defined for the function.

Returns:

an integer containing the number of arguments that are defined for the function.

getChildNodes

public ISemanticNode[] getChildNodes()

Description copied from interface: ISemanticNode

This method returns an array containing the child nodes. The order of the child nodes in the array is not defined, and the array may be empty for nodes that do not have child nodes.

Returns:

Array containing the child nodes of this node.

collectScopedObjects

public void collectScopedObjects(ScopedObjects resultSet)

Description copied from interface: ISemanticNode

This method may be used to collect the names of the objects that need to be in scope in order to evaluate the expression of this node. The object passed to the method will be enriched with the names of the objects that need to be in scope.

Parameters:

resultSet - The object that should be used to add the names of the objects that need to be in scope to.

visit

public void visit(ISemanticNodeVisitor visitor)

Description copied from interface: ISemanticNode

This method allows a type safe visitation of the node. The visit method will not invoke the visitor for any child nodes.

Parameters:

visitor - The visitor that should be invoked for this node.

toString

public String toString()

Overrides:

toString in class SemanticNodeBase