org.mov.parser.expression
Class SqrtExpression

java.lang.Object
  org.mov.parser.expression.AbstractExpression
      org.mov.parser.expression.UnaryExpression
          org.mov.parser.expression.SqrtExpression

All Implemented Interfaces:

java.lang.Cloneable, Expression

public class SqrtExpression
extends UnaryExpression

An expression which calculates the square root of a number.

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

SqrtExpression(Expression number)

Method Summary

int	checkType() Check the input argument 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.
Expression	simplify() Perform simplifications and optimisations on the expression tree.
java.lang.String	toString() Convert the given expression to a string.

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

getChildCount

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SqrtExpression

public SqrtExpression(Expression number)

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

Check the input argument to the expression. It can only be Expression.INTEGER_TYPE or Expression.FLOAT_TYPE.

Returns:

the type of the expression

Throws:

TypeMismatchException - if the expression has incorrect types

simplify

public Expression simplify()

Description copied from class: AbstractExpression

Perform simplifications and optimisations on the expression tree. For example, if the expression tree was a and true then the expression tree would be simplified to a.

Specified by:

simplify in interface Expression

Overrides:

simplify in class AbstractExpression

getType

public int getType()

Get the type of the expression.

Returns:

either Expression.FLOAT_TYPE or Expression.INTEGER_TYPE.

clone

public java.lang.Object clone()

Specified by:

clone in interface Expression

Specified by:

clone in class AbstractExpression