org.apache.poi.hssf.record.formula.functions
Interface Function
- All Known Implementing Classes:
- AggregateFunction, And, BooleanFunction, CalendarFieldFunction, Choose, Column, Columns, Count, Counta, Countif, DateFunc, Errortype, Even, False, FinanceFunction, Find, Hlookup, Hyperlink, If, Index, Isblank, IsError, Islogical, Isnontext, Isnumber, Isref, Istext, LogicalFunction, Lookup, Match, MinaMaxa, Mode, MultiOperandNumericFunction, Na, Not, NotImplementedFunction, Now, NumericFunction, NumericFunction.MultiArg, NumericFunction.OneArg, NumericFunction.TwoArg, Odd, Offset, Or, Pi, Rand, Replace, Row, Rows, Substitute, Sumif, Sumproduct, Sumx2my2, Sumx2py2, Sumxmy2, T, TextFunction, Time, Today, True, Value, Vlookup, XYNumericFunction
public interface Function
Common interface for all implementations of Excel built-in functions.
- Author:
- Amol S. Deshmukh < amolweb at ya hoo dot com >
Method Summary |
Eval |
evaluate(Eval[] args,
int srcRowIndex,
short srcColumnIndex)
|
evaluate
Eval evaluate(Eval[] args,
int srcRowIndex,
short srcColumnIndex)
- Parameters:
args
- the evaluated function arguments. Elements of this array typically implement
ValueEval
. Empty values are represented with BlankEval
or MissingArgEval
, never null
.srcRowIndex
- row index of the cell containing the formula under evaluationsrcColumnIndex
- 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.