Class Index
java.lang.Object
org.apache.poi.ss.formula.functions.Index
- All Implemented Interfaces:
ArrayMode
,Function
,Function2Arg
,Function3Arg
,Function4Arg
public final class Index
extends Object
implements Function2Arg, Function3Arg, Function4Arg, ArrayMode
Implementation for the Excel function INDEX
Syntax :
INDEX ( reference, row_num[, column_num [, area_num]])
INDEX ( array, row_num[, column_num])
reference | typically an area reference, possibly a union of areas |
---|---|
array | a literal array value (currently not supported) |
row_num | selects the row within the array or area reference |
column_num | selects column within the array or area reference. default is 1 |
area_num | used when reference is a union of areas |
- Author:
- Josh Micich
-
Constructor Details
-
Index
public Index()
-
-
Method Details
-
evaluate
Description copied from interface:Function2Arg
- Specified by:
evaluate
in interfaceFunction2Arg
-
evaluate
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, ValueEval arg2) Description copied from interface:Function3Arg
- Specified by:
evaluate
in interfaceFunction3Arg
-
evaluate
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, ValueEval arg2, ValueEval arg3) Description copied from interface:Function4Arg
- Specified by:
evaluate
in interfaceFunction4Arg
-
evaluate
- Specified by:
evaluate
in interfaceFunction
- Parameters:
args
- the evaluated function arguments. Empty values are represented withBlankEval
orMissingArgEval
, nevernull
.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
, nevernull
. Note - Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate toDouble.NaN
be sure to translate the result toErrorEval.NUM_ERROR
.
-