org.mov.parser.expression
Class CorrExpression

java.lang.Object
  org.mov.parser.expression.AbstractExpression
      org.mov.parser.expression.QuaternaryExpression
          org.mov.parser.expression.CorrExpression

All Implemented Interfaces:

java.lang.Cloneable, Expression

public class CorrExpression
extends QuaternaryExpression

An expression which finds the correleation between two stock quotes.

Author:

Andrew Leppard

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

CorrExpression(Expression symbol, Expression quote, Expression days, Expression lag)
Create a new correlation expression between the current stock quote, and the given quote.

Method Summary

int	checkType() Perform type checking on 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 org.mov.parser.expression.QuaternaryExpression

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

CorrExpression

public CorrExpression(Expression symbol,
                      Expression quote,
                      Expression days,
                      Expression lag)

Create a new correlation expression between the current stock quote, and the given quote. Find the correlation of the given quote kind. For the given number of days, at the given offset.

Parameters:

symbol - the symbol of the correlated stock

quote - the quote kind to correlate

days - the number of days to correlate over

lag - the offset from the current day

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

Returns:

the string representation of the expression

checkType

public int checkType()
              throws TypeMismatchException

Description copied from interface: Expression

Perform type checking on the expression.

Returns:

the return type of the expression

Throws:

TypeMismatchException - if the expression has incorrect types

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.

clone

public java.lang.Object clone()

Specified by:

clone in interface Expression

Specified by:

clone in class AbstractExpression