org.apache.poi.hssf.record.formula.functions
Class Value

java.lang.Object
  extended by org.apache.poi.hssf.record.formula.functions.Value
All Implemented Interfaces:
Function

public final class Value
extends java.lang.Object
implements Function

Implementation for Excel VALUE() function.

Syntax:
VALUE(text)
Converts the text argument to a number. Leading and/or trailing whitespace is ignored. Currency symbols and thousands separators are stripped out. Scientific notation is also supported. If the supplied text does not convert properly the result is #VALUE! error. Blank string converts to zero.

Author:
Josh Micich

Constructor Summary
Value()
           
 
Method Summary
 Eval evaluate(Eval[] args, int srcCellRow, short srcCellCol)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Value

public Value()
Method Detail

evaluate

public Eval evaluate(Eval[] args,
                     int srcCellRow,
                     short srcCellCol)
Specified by:
evaluate in interface Function
Parameters:
args - the evaluated function arguments. Elements of this array typically implement ValueEval. Empty values are represented with BlankEval or MissingArgEval, never null.
srcCellRow - row index of the cell containing the formula under evaluation
srcCellCol - column index of the cell containing the formula under evaluation
Returns:
The evaluated result, possibly an ErrorEval, never null. Note - Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate to Double.NaN be sure to translate the result to ErrorEval.NUM_ERROR.


Copyright 2009 The Apache Software Foundation or its licensors, as applicable.