nz.org.venice.parser.expression
Class DayOfWeekExpression

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

All Implemented Interfaces:

java.lang.Cloneable, Expression

public class DayOfWeekExpression

extends TerminalExpression

A function that returns the current day of week. The first day of the week depends on the locale. In the U.S it starts on Sunday, in France it starts on Monday. The first day of the week will be 1.

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

DayOfWeekExpression()

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 nz.org.venice.parser.expression.TerminalExpression

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

DayOfWeekExpression

public DayOfWeekExpression()

Method Detail

evaluate

public double evaluate(Variables variables,
                       QuoteBundle quoteBundle,
                       Symbol symbol,
                       int day)

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

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

Description copied from interface: Expression

Perform type checking on the expression.

Specified by:

checkType in interface Expression

Overrides:

checkType in class TerminalExpression

Throws:

TypeMismatchException

getType

public int getType()

Get the type of the expression.

Returns:

returns Expression.INTEGER_TYPE.

clone

public java.lang.Object clone()

Specified by:

clone in interface Expression

Specified by:

clone in class AbstractExpression