org.expressionj.expr

Class ExprFORMAT

java.lang.Object

org.expressionj.model.AbstractExpression

org.expressionj.expr.AbstractExprFunction

org.expressionj.expr.ExprFORMAT

All Implemented Interfaces:

java.lang.Cloneable, Expression, ExpressionType, MultipleAryExpression

public class ExprFORMAT
extends AbstractExprFunction

Represent a "format" 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
ExprFORMAT(Expression root)

Method Summary

Modifier and Type	Method and Description
void	addExpression(Expression expr)
java.lang.Object	clone()
java.lang.Object	eval() Evaluate the expression.
java.lang.String	getExpressionName() Return the expression name.
short	getResultStructure() Return the structure of the result for the expression.
short	getResultType() Return the type of the result for the expression.

Methods inherited from class org.expressionj.expr.AbstractExprFunction

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

ExprFORMAT

public ExprFORMAT(Expression root)

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

addExpression

public void addExpression(Expression expr)
                   throws java.lang.Exception

Specified by:

addExpression in interface MultipleAryExpression

Overrides:

addExpression in class AbstractExprFunction

Throws:

java.lang.Exception

eval

public 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 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