Venice 0.751beta

nz.org.venice.parser.expression
Class ForExpression

java.lang.Object
  extended bynz.org.venice.parser.expression.AbstractExpression
      extended bynz.org.venice.parser.expression.QuaternaryExpression
          extended bynz.org.venice.parser.expression.ForExpression
All Implemented Interfaces:
java.lang.Cloneable, Expression

public class ForExpression
extends QuaternaryExpression

An expression which represents the for command. e.g.

for(int i = 0; i < 10; i++) {
   a += i;
}


Field Summary
 
Fields inherited from interface nz.org.venice.parser.Expression
BOOLEAN_TYPE, FALSE, FLOAT_QUOTE_TYPE, FLOAT_TYPE, INTEGER_QUOTE_TYPE, INTEGER_SHORT_TYPE, INTEGER_TYPE, NUMERIC_TYPE, STRING_TYPE, TRUE, TRUE_LEVEL, UNDEFINED_TYPE
 
Constructor Summary
ForExpression(Expression initial, Expression condition, Expression loop, Expression command)
          Construct a for expression.
 
Method Summary
 int checkType()
          Check the input arguments to the expression.
 java.lang.Object clone()
           
 double evaluate(Variables variables, QuoteBundle quoteBundle, Symbol symbol, int day)
          Evaluates the given expression and returns the result.
 int getType()
          Get the type of the expression.
 java.lang.String toString()
          Convert the given expression to a string.
 
Methods inherited from class nz.org.venice.parser.expression.QuaternaryExpression
getChildCount
 
Methods inherited from class nz.org.venice.parser.expression.AbstractExpression
equals, getChild, getId, getIndex, getNumberFormat, getParent, getParseMetadata, hashCode, isRoot, iterator, parseDouble, parseInt, printParents, setChild, setChildMutableVersion, setParent, setParseMetadata, simplify, simplifyMutableVersion, size, size, validTree, valueOfDouble, valueOfInt
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ForExpression

public ForExpression(Expression initial,
                     Expression condition,
                     Expression loop,
                     Expression command)
Construct a for expression.
for(initial; condition; loop) {
   command
}

Parameters:
initial - loop initialisation.
condition - loop condition test.
loop - the loop traversal function.
command - the command to loop.
Method Detail

evaluate

public double evaluate(Variables variables,
                       QuoteBundle quoteBundle,
                       Symbol symbol,
                       int day)
                throws EvaluationException
Description copied from interface: Expression
Evaluates the given expression and returns the result.

Parameters:
variables - variable storage area for expression
quoteBundle - the quote bundle containing quote data to use
symbol - the current symbol
day - current date in cache fast access format
Returns:
the result of the expression
Throws:
EvaluationException - if the expression performs an illegal operation such as divide by zero.

toString

public java.lang.String toString()
Description copied from interface: Expression
Convert the given expression to a string.

Specified by:
toString in interface Expression
Overrides:
toString in class AbstractExpression

checkType

public int checkType()
              throws TypeMismatchException
Check the input arguments to the expression. The arguments can be any type except for the condition argument which must be Expression.BOOLEAN_TYPE.

Returns:
the type of the command argument.
Throws:
TypeMismatchException - if the expression has incorrect types

getType

public int getType()
Get the type of the expression.

Returns:
the type of the command argument.

clone

public java.lang.Object clone()
Specified by:
clone in interface Expression
Specified by:
clone in class AbstractExpression

Venice 0.751beta