org.apache.poi.ss.formula.functions

public Interface Function

Known Direct Subinterfaces: org.apache.poi.ss.formula.functions.Function0Arg, org.apache.poi.ss.formula.functions.Function1Arg, org.apache.poi.ss.formula.functions.Function2Arg, org.apache.poi.ss.formula.functions.Function3Arg, org.apache.poi.ss.formula.functions.Function4Arg
Known Direct Implementers: org.apache.poi.ss.formula.functions.Irr, org.apache.poi.ss.formula.functions.MatrixFunction, org.apache.poi.ss.formula.functions.Mode, org.apache.poi.ss.formula.functions.MultiOperandNumericFunction, org.apache.poi.ss.formula.functions.NotImplementedFunction, org.apache.poi.ss.formula.functions.Npv, org.apache.poi.ss.formula.functions.NumericFunction, org.apache.poi.ss.formula.functions.Offset, org.apache.poi.ss.formula.functions.PercentRank, org.apache.poi.ss.formula.functions.Rate, org.apache.poi.ss.formula.functions.Subtotal, org.apache.poi.ss.formula.functions.Sumproduct, org.apache.poi.ss.formula.functions.TextFunction, org.apache.poi.ss.formula.functions.Trend, org.apache.poi.ss.formula.functions.WeekdayFunc, org.apache.poi.ss.formula.functions.Address, org.apache.poi.ss.formula.functions.Areas, org.apache.poi.ss.formula.functions.BooleanFunction, org.apache.poi.ss.formula.functions.Choose, org.apache.poi.ss.formula.functions.Count, org.apache.poi.ss.formula.functions.Counta
Imports: org.apache.poi.ss.formula.eval.BlankEval, .ErrorEval, .MissingArgEval, .ValueEval

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

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public ValueEval	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`. evaluate(ValueEval[] the evaluated function arguments. Empty values are represented with `BlankEval` or `MissingArgEval`, never `null`. args, int row index of the cell containing the formula under evaluation srcRowIndex, int column index of the cell containing the formula under evaluation srcColumnIndex)

public ValueEval

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.

evaluate(ValueEval[]

the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.

args, int

row index of the cell containing the formula under evaluation

srcRowIndex, int

column index of the cell containing the formula under evaluation

srcColumnIndex)

Method Detail

evaluate back to summary

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

public ValueEval evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

Parameters

args:ValueEval[]: the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.
srcRowIndex:int: row index of the cell containing the formula under evaluation
srcColumnIndex:int: column index of the cell containing the formula under evaluation

Returns:ValueEval

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.