Apache POI - Common 5.3.0 · org.apache.poi.ss.formula.functions.ArrayFunction

Method Summary

Modifier and Type	Method and Description
public static ValueEval	_evaluateOneArrayArg(ValueEval arg0, int srcRowIndex, int srcColumnIndex, Function<ValueEval, ValueEval> evalFunc)
public static ValueEval	_evaluateTwoArrayArgs(ValueEval arg0, ValueEval arg1, int srcRowIndex, int srcColumnIndex, BiFunction<ValueEval, ValueEval, ValueEval> evalFunc)
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`. evaluateArray(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 default ValueEval	evaluateOneArrayArg(ValueEval arg0, int srcRowIndex, int srcColumnIndex, Function<ValueEval, ValueEval> evalFunc)
public default 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`. evaluateTwoArrayArgs(ValueEval the first function argument. Empty values are represented with `BlankEval` or `MissingArgEval`, never `null` arg0, ValueEval the first function argument. Empty values are represented with `BlankEval` or `MissingArgEval`, never `null` arg1, int row index of the cell containing the formula under evaluation srcRowIndex, int column index of the cell containing the formula under evaluation srcColumnIndex, BiFunction<ValueEval, ValueEval, ValueEval> evalFunc) Evaluate an array function with two arguments.

Method Detail

_evaluateOneArrayArg	back to summary
public static ValueEval _evaluateOneArrayArg(ValueEval arg0, int srcRowIndex, int srcColumnIndex, Function<ValueEval, ValueEval> evalFunc)

_evaluateTwoArrayArgs	back to summary
public static ValueEval _evaluateTwoArrayArgs(ValueEval arg0, ValueEval arg1, int srcRowIndex, int srcColumnIndex, BiFunction<ValueEval, ValueEval, ValueEval> evalFunc)

evaluateArray back to summary

evaluateArray	back to summary
public ValueEval evaluateArray(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 evaluateArray(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.

evaluateOneArrayArg	back to summary
public default ValueEval evaluateOneArrayArg(ValueEval arg0, int srcRowIndex, int srcColumnIndex, Function<ValueEval, ValueEval> evalFunc)

evaluateTwoArrayArgs back to summary

evaluateTwoArrayArgs	back to summary
public default ValueEval evaluateTwoArrayArgs(ValueEval arg0, ValueEval arg1, int srcRowIndex, int srcColumnIndex, BiFunction<ValueEval, ValueEval, ValueEval> evalFunc) Evaluate an array function with two arguments. Parameters arg0:ValueEval the first function argument. Empty values are represented with `BlankEval` or `MissingArgEval`, never `null` arg1:ValueEval the first function argument. 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 default ValueEval evaluateTwoArrayArgs(ValueEval arg0, ValueEval arg1, int srcRowIndex, int srcColumnIndex, BiFunction<ValueEval, ValueEval, ValueEval> evalFunc)

Evaluate an array function with two arguments.

Parameters

arg0:ValueEval: the first function argument. Empty values are represented with BlankEval or MissingArgEval, never null
arg1:ValueEval: the first function argument. 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 Interface ArrayFunction

Method Summary

Method Detail