org.mov.parser.expression
Class QuoteExpression

java.lang.Object
  org.mov.parser.expression.AbstractExpression
      org.mov.parser.expression.TerminalExpression
          org.mov.parser.expression.QuoteExpression

All Implemented Interfaces:

java.lang.Cloneable, Expression

public class QuoteExpression
extends TerminalExpression

Class that represents a quote kind, e.g. day open, day close, etc. Originally there was a separate class for each quote kind but this was deemed a little excessive, so it was all folded into a single class.

Field Summary

Fields inherited from interface org.mov.parser.Expression

BOOLEAN_TYPE, FALSE, FLOAT_QUOTE_TYPE, FLOAT_TYPE, INTEGER_QUOTE_TYPE, INTEGER_TYPE, STRING_TYPE, TRUE, TRUE_LEVEL

Constructor Summary

QuoteExpression(int quoteKind)
Create a new quote expression.

Method Summary

java.lang.Object	clone()
double	evaluate(Variables variables, QuoteBundle quoteBundle, Symbol symbol, int day) Evaluates the given expression and returns the result.
int	getQuoteKind() Get the quote kind.
int	getType() Get the type of the expression.
java.lang.String	toString() Convert the given expression to a string.

Methods inherited from class org.mov.parser.expression.TerminalExpression

checkType, getChildCount

Methods inherited from class org.mov.parser.expression.AbstractExpression

equals, getChild, getIndex, getNumberFormat, getParent, hashCode, isRoot, iterator, parseDouble, parseInt, setChild, setParent, simplify, size, size, valueOfDouble, valueOfInt

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QuoteExpression

public QuoteExpression(int quoteKind)

Create a new quote expression.

Parameters:

quoteKind - Kind of quote. One of Quote.DAY_OPEN, Quote.DAY_CLOSE, Quote.DAY_LOW, Quote.DAY_HIGH or Quote.DAY_VOLUME

Method Detail

getQuoteKind

public int getQuoteKind()

Get the quote kind.

Returns:

the quote kind, one of: Quote.DAY_OPEN, Quote.DAY_CLOSE, Quote.DAY_HIGH, Quote.DAY_LOW or Quote.DAY_VOLUME.

getType

public int getType()

Get the type of the expression.

Returns:

Expression.FLOAT_QUOTE_TYPE or Expression.INTEGER_QUOTE_TYPE.

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 java.lang.Object

Returns:

the string representation of the expression

clone

public java.lang.Object clone()

Specified by:

clone in interface Expression

Specified by:

clone in class AbstractExpression