Package org.apache.poi.ss.formula.functions

Interface Function

All Known Subinterfaces:

Function0Arg, Function1Arg, Function2Arg, Function3Arg, Function4Arg

All Known Implementing Classes:

Address, AggregateFunction, Areas, BesselJ, Bin2Dec, BooleanFunction, CalendarFieldFunction, Choose, Code, Columns, Complex, ConcatEval, Correl, Count, Counta, Countblank, Countif, Covar, DateFunc, DateValue, Days360, Dec2Bin, Dec2Hex, Delta, DollarDe, DollarFr, DStarRunner, ELEvalFunction, Errortype, FactDouble, FinanceFunction, Fixed, Fixed0ArgFunction, Fixed1ArgFunction, Fixed2ArgFunction, Fixed3ArgFunction, Fixed4ArgFunction, Forecast, Frequency, Hex2Dec, Hlookup, Hyperlink, IfFunc, Imaginary, ImReal, Index, Intercept, IntersectionEval, IPMT, Irr, LinearRegressionFunction, LogicalFunction, Lookup, LookupAndReferenceFunctionImpl.Unique, Match, MatrixFunction, MatrixFunction.MutableValueCollector, MatrixFunction.OneArrayArg, MatrixFunction.TwoArrayArg, MinaMaxa, Mirr, Mode, MultiOperandNumericFunction, NormDist, NormInv, NormSDist, NormSInv, NotImplementedFunction, Npv, NumericFunction, Oct2Dec, OverridableFunction, PercentEval, PercentRank, PPMT, Quotient, RangeEval, Rank, Rate, RelationalOperationEval, Replace, Rept, Roman, Rows, Slope, Standardize, Substitute, Subtotal, Sumif, Sumproduct, Sumx2my2, Sumx2py2, Sumxmy2, T, TDist, TDist2t, TDistLt, TDistRt, TextFunction, TimeFunc, TimeValue, Trend, TwoOperandNumericOperation, UnaryMinusEval, UnaryPlusEval, Value, Vlookup, WeekdayFunc, WeekNum, XYNumericFunction

public interface Function

Common interface for all implementations of Excel built-in functions.

Method Summary

Modifier and Type	Method	Description
ValueEval	evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

Method Detail

evaluate

ValueEval evaluate(ValueEval[] args,
                   int srcRowIndex,
                   int 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.