org.expressionj.expr

Class ExprFunction

java.lang.Object

org.expressionj.model.AbstractExpression

org.expressionj.expr.AbstractExprFunction

org.expressionj.expr.ExprFunction

All Implemented Interfaces:

java.lang.Cloneable, Expression, ExpressionType, MultipleAryExpression

public class ExprFunction
extends AbstractExprFunction

Represent a "Function" expression.

Field Summary

Fields inherited from class org.expressionj.expr.AbstractExprFunction

exprs

Fields inherited from class org.expressionj.model.AbstractExpression

block, root

Fields inherited from interface org.expressionj.model.ExpressionType

STRUCT_ARRAY, STRUCT_SCALAR, STRUCT_STRUCTURE, TYPE_BOOL, TYPE_DYNAMIC, TYPE_FLOAT, TYPE_INTEGER, TYPE_NUMERIC, TYPE_STRING, TYPE_UNDEF

Constructor Summary

Constructors

Constructor and Description
ExprFunction(Expression root)
ExprFunction(Expression root, FunctionKey key)
ExprFunction(Expression root, java.lang.String name, int paramsSize)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
java.lang.Object	eval() Evaluate the expression.
java.lang.String	getExpressionName() Return the expression name.
FunctionKey	getFunctionKey()
short	getResultStructure() Return the structure of the result for the expression.
short	getResultType() Return the type of the result for the expression.
void	setFunctionKey(FunctionKey key)
void	setFunctionKey(java.lang.String name, int paramsSize)

Methods inherited from class org.expressionj.expr.AbstractExprFunction

addExpression, getExpressions, getVariables, setExpressions

Methods inherited from class org.expressionj.model.AbstractExpression

evalAsBoolean, evalAsFloat, evalAsInt, getParentBlock, getRoot, setParentBlock, setRoot

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.expressionj.model.Expression

evalAsBoolean, evalAsFloat, evalAsInt, getExpression, getLocalVariable, getLocalVariables, getParentBlock, getRoot, getVariable, getVariable, getVariables, hasVariable, hasVariable, removeVariable, setParentBlock

Constructor Detail

ExprFunction

public ExprFunction(Expression root)

ExprFunction

public ExprFunction(Expression root,
                    FunctionKey key)

ExprFunction

public ExprFunction(Expression root,
                    java.lang.String name,
                    int paramsSize)

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Specified by:

clone in interface Expression

Specified by:

clone in class AbstractExpression

Throws:

java.lang.CloneNotSupportedException

getExpressionName

public java.lang.String getExpressionName()

Description copied from interface: Expression

Return the expression name.

Returns:

the expression name

setFunctionKey

public void setFunctionKey(FunctionKey key)

setFunctionKey

public void setFunctionKey(java.lang.String name,
                           int paramsSize)

getFunctionKey

public FunctionKey getFunctionKey()

eval

public final java.lang.Object eval()
                            throws java.lang.ArithmeticException

Description copied from interface: Expression

Evaluate the expression.

Returns:

the result

Throws:

java.lang.ArithmeticException

getResultType

public final short getResultType()

Description copied from interface: Expression

Return the type of the result for the expression. The type can be:

• ExpressionType.TYPE_INTEGER: integer
• ExpressionType.TYPE_FLOAT: float
• ExpressionType.TYPE_NUMERIC: integer or float value. The runtime actual type may depend on the expression arguments
• ExpressionType.TYPE_STRING: string
• ExpressionType.TYPE_DYNAMIC: dynamic type. The runtime actual type may depend on the expression arguments
• ExpressionType.TYPE_UNDEF: undefined type. The default type, characteristic of an error if entountered.

Returns:

the type of the result for the expression

getResultStructure

public short getResultStructure()

Description copied from interface: Expression

Return the structure of the result for the expression. The structure can be:

• ExpressionType.STRUCT_SCALAR: a scalar value
• ExpressionType.STRUCT_ARRAY: an array value

Returns:

he structure of the result for the expression