org.expressionj.expr

Class ParsedEquation

java.lang.Object

org.expressionj.expr.ParsedEquation

All Implemented Interfaces:

java.lang.Cloneable, Equation, Expression, ExpressionType

public class ParsedEquation
extends java.lang.Object
implements Expression, Equation

This class represent a parsed condition.

Field Summary

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
ParsedEquation()

Method Summary

Modifier and Type	Method and Description
void	acceptUndefinedVariables(boolean acceptUndefVars)
void	addVariable(Variable var)
java.lang.Object	clone()
Constant	createBooleanConstant(boolean value)
Constant	createConstant(java.lang.String expr)
Constant	createPIConstant(double value)
void	endParsing()
java.lang.Object	eval() Evaluate the expression.
boolean	evalAsBoolean() Evaluate the expression as a boolean.
float	evalAsFloat() Evaluate the expression as a float.
int	evalAsInt() Evaluate the expression as an int.
Variable	getDollarVariable(java.lang.String dollarName)
Expression	getExpression() Return the associated expression.
java.lang.String	getExpressionName() Return the expression name.
java.util.Map<java.lang.String,LocalVariable>	getLocalVariables() Return the local variables used by this expression.
CodeBlock	getParentBlock() Return the parent expression block if the expression is one of several expressions separated by commas.
short	getResultStructure() Return the structure of the result for the expression.
short	getResultType() Return the type of the result for the expression.
Expression	getRoot() Return the root expression.
Variable	getVariable(java.lang.String varName) Return a variable declared by the expression.
Variable	getVariable(java.lang.String varName, boolean createIfAbsent) Return a variable declared by the expression.
java.util.Map<java.lang.String,Variable>	getVariables() Return the variables used by this expression.
java.util.Map<java.lang.String,Variable>	getVariables(boolean includeLocals) Return the variables used by this expression, possibly including local variables.
boolean	hasVariable(java.lang.String varName, boolean includeLocals) Return true if there is a variable with a specified name.
void	setExpression(Expression expr)
void	setParentBlock(CodeBlock block) Set the parent expression block.
void	setValue(java.lang.String varName, java.lang.Object value) Set the value of a variable.
void	setVariables(java.util.List<Variable> varsList)

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

getLocalVariable, hasVariable, removeVariable

Constructor Detail

ParsedEquation

public ParsedEquation()

Method Detail

clone

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

Specified by:

clone in interface Expression

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

setParentBlock

public void setParentBlock(CodeBlock block)

Description copied from interface: Expression

Set the parent expression block.

Specified by:

setParentBlock in interface Expression

Parameters:

block - the parent expression block

getParentBlock

public CodeBlock getParentBlock()

Description copied from interface: Expression

Return the parent expression block if the expression is one of several expressions separated by commas. For example, in the following equation: b=a+2; return b, the two "b=a+2" and "return b" have "b=a+2; return b" as their parent block.

Specified by:

getParentBlock in interface Expression

Returns:

the parent expression block

getExpressionName

public java.lang.String getExpressionName()

Description copied from interface: Expression

Return the expression name.

Specified by:

getExpressionName in interface Expression

Returns:

the expression name

acceptUndefinedVariables

public void acceptUndefinedVariables(boolean acceptUndefVars)

endParsing

public void endParsing()

setExpression

public void setExpression(Expression expr)

getVariables

public java.util.Map<java.lang.String,Variable> getVariables()

Return the variables used by this expression. Note that this method will not return any internal variables declared by the expression. For example, in the following expression: int c=a+b, only "a" and "b" will be returned.

Specified by:

getVariables in interface Expression

Returns:

the variables used by this expression

getVariables

public java.util.Map<java.lang.String,Variable> getVariables(boolean includeLocals)

Return the variables used by this expression, possibly including local variables.

Specified by:

getVariables in interface Expression

Parameters:

includeLocals - true if local variables should be included

Returns:

the variables used by this expression

getLocalVariables

public java.util.Map<java.lang.String,LocalVariable> getLocalVariables()

Return the local variables used by this expression. Return an empty Map by default.

Specified by:

getLocalVariables in interface Expression

Returns:

the variables used by this expression

getExpression

public Expression getExpression()

Description copied from interface: Expression

Return the associated expression. Return this by default.

Specified by:

getExpression in interface Equation

Specified by:

getExpression in interface Expression

Returns:

the associated expression

getRoot

public Expression getRoot()

Return the root expression.

Specified by:

getRoot in interface Expression

Returns:

the root expression

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.

Specified by:

getResultType in interface Expression

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

Specified by:

getResultStructure in interface Expression

Returns:

he structure of the result for the expression

addVariable

public void addVariable(Variable var)

setVariables

public void setVariables(java.util.List<Variable> varsList)

getDollarVariable

public Variable getDollarVariable(java.lang.String dollarName)
                           throws ParseException

Throws:

ParseException

getVariable

public Variable getVariable(java.lang.String varName)

Description copied from interface: Expression

Return a variable declared by the expression.

Specified by:

getVariable in interface Expression

Parameters:

varName - the variable name

Returns:

the variable

hasVariable

public boolean hasVariable(java.lang.String varName,
                           boolean includeLocals)

Return true if there is a variable with a specified name.

Specified by:

hasVariable in interface Expression

Parameters:

varName - the variable name

includeLocals - true if local variables should be included

Returns:

true if there is a variable with the specified name

getVariable

public Variable getVariable(java.lang.String varName,
                            boolean createIfAbsent)

Return a variable declared by the expression.

Specified by:

getVariable in interface Expression

Parameters:

varName - the variable name

createIfAbsent - true if the variabel should be created if absent

Returns:

the variable

createPIConstant

public Constant createPIConstant(double value)

createBooleanConstant

public Constant createBooleanConstant(boolean value)

createConstant

public Constant createConstant(java.lang.String expr)

setValue

public void setValue(java.lang.String varName,
                     java.lang.Object value)

Description copied from interface: Equation

Set the value of a variable.

Specified by:

setValue in interface Equation

Parameters:

varName - the variable name

value - the variable value

evalAsInt

public int evalAsInt()
              throws java.lang.ArithmeticException

Description copied from interface: Expression

Evaluate the expression as an int. The result of the evaluation will be the same as Expression.eval(), but the evaluation engine will be able to optimize the computation by knwoing that the result is an int (primitive valeus are cached internally).

Specified by:

evalAsInt in interface Expression

Returns:

the result as an int

Throws:

java.lang.ArithmeticException

evalAsFloat

public float evalAsFloat()
                  throws java.lang.ArithmeticException

Description copied from interface: Expression

Evaluate the expression as a float. The result of the evaluation will be the same as Expression.eval(), but the evaluation engine will be able to optimize the computation by knwoing that the result is a float (primitive valeus are cached internally).

Specified by:

evalAsFloat in interface Expression

Returns:

the result as a float

Throws:

java.lang.ArithmeticException

evalAsBoolean

public boolean evalAsBoolean()
                      throws java.lang.ArithmeticException

Description copied from interface: Expression

Evaluate the expression as a boolean. The result of the evaluation will be the same as Expression.eval(), but the evaluation engine will be able to optimize the computation by knwoing that the result is a boolean (primitive valeus are cached internally).

Specified by:

evalAsBoolean in interface Expression

Returns:

the result as a boolean

Throws:

java.lang.ArithmeticException

eval

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

Description copied from interface: Expression

Evaluate the expression.

Specified by:

eval in interface Expression

Returns:

the result

Throws:

java.lang.ArithmeticException