org.apache.poi.hssf.record.formula.functions
Class Index
java.lang.Object
org.apache.poi.hssf.record.formula.functions.Index
- All Implemented Interfaces:
- Function
public final class Index
- extends java.lang.Object
- implements Function
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 Summary |
Index()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Index
public Index()
evaluate
public Eval evaluate(Eval[] args,
int srcCellRow,
short srcCellCol)
- Specified by:
evaluate
in interface Function
- Parameters:
args
- the evaluated function arguments. Elements of this array typically implement
ValueEval
. Empty values are represented with BlankEval
or MissingArgEval
, never null
.srcCellRow
- row index of the cell containing the formula under evaluationsrcCellCol
- 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.