nz.org.venice.parser.expression
Class GetVariableExpression

java.lang.Object
  nz.org.venice.parser.expression.AbstractExpression
      nz.org.venice.parser.expression.TerminalExpression
          nz.org.venice.parser.expression.GetVariableExpression

All Implemented Interfaces:

java.lang.Cloneable, Expression

public class GetVariableExpression

extends TerminalExpression

A representation of an expression to return the value of a variable.

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

GetVariableExpression(java.lang.String name, int type)

Method Summary

java.lang.Object	clone()
boolean	equals(java.lang.Object object) Returns whether this expression tree and the given expression tree are equivalent.
double	evaluate(Variables variables, QuoteBundle quoteBundle, Symbol symbol, int day) Evaluates the given expression and returns the result.
java.lang.String	getName()
int	getType() Get the type of the expression.
int	hashCode() If you override the equals(java.lang.Object) method then you should override this method.
java.lang.String	toString() Convert the given expression to a string.

Methods inherited from class nz.org.venice.parser.expression.TerminalExpression

checkType, getChildCount

Methods inherited from class nz.org.venice.parser.expression.AbstractExpression

getChild, getId, getIndex, getNumberFormat, getParent, getParseMetadata, 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

GetVariableExpression

public GetVariableExpression(java.lang.String name,
                             int type)

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

getName

public java.lang.String getName()

getType

public int getType()

Description copied from interface: Expression

Get the type of the expression.

Returns:

one of Expression.BOOLEAN_TYPE, Expression.FLOAT_TYPE, Expression.INTEGER_TYPE, Expression.FLOAT_QUOTE_TYPE or Expression.INTEGER_QUOTE_TYPE.

equals

public boolean equals(java.lang.Object object)

Description copied from class: AbstractExpression

Returns whether this expression tree and the given expression tree are equivalent.

Specified by:

equals in interface Expression

Overrides:

equals in class AbstractExpression

Parameters:

object - the other expression

hashCode

public int hashCode()

Description copied from class: AbstractExpression

If you override the AbstractExpression.equals(java.lang.Object) method then you should override this method. It provides a very basic hash code function.

Specified by:

hashCode in interface Expression

Overrides:

hashCode in class AbstractExpression

Returns:

a poor hash code of the tree

clone

public java.lang.Object clone()

Specified by:

clone in interface Expression

Specified by:

clone in class AbstractExpression