org.apache.poi.hssf.record.formula.functions
Interface Function

All Known Implementing Classes:
AggregateFunction, And, BooleanFunction, CalendarFieldFunction, Choose, Column, Columns, ConcatEval, Count, Counta, Countif, DateFunc, Days360, Errortype, Even, False, FinanceFunction, Find, Hlookup, Hyperlink, If, Index, Isblank, IsError, IsNa, Isref, LogicalFunction, Lookup, Match, MinaMaxa, Mode, MultiOperandNumericFunction, Na, Not, NotImplementedFunction, Now, Npv, NumericFunction, NumericFunction.MultiArg, NumericFunction.OneArg, NumericFunction.TwoArg, Odd, Offset, Or, PercentEval, Pi, Rand, RangeEval, RelationalOperationEval, Replace, Row, Rows, Substitute, Sumif, Sumproduct, Sumx2my2, Sumx2py2, Sumxmy2, T, TextFunction, Time, Today, True, TwoOperandNumericOperation, UnaryMinusEval, UnaryPlusEval, 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
 ValueEval evaluate(ValueEval[] args, int srcRowIndex, short srcColumnIndex)
           
 

Method Detail

evaluate

ValueEval evaluate(ValueEval[] args,
                   int srcRowIndex,
                   short srcColumnIndex)
Parameters:
args - the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.
srcRowIndex - row index of the cell containing the formula under evaluation
srcColumnIndex - 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.