org.apache.poi.ss.formula.functions
Class RowFunc

java.lang.Object
  org.apache.poi.ss.formula.functions.RowFunc

All Implemented Interfaces:

Function, Function0Arg, Function1Arg

public final class RowFunc
extends java.lang.Object
implements Function0Arg, Function1Arg

Implementation for the Excel function ROW

Author:

Josh Micich

Constructor Summary

RowFunc()

Method Summary

ValueEval	evaluate(int srcRowIndex, int srcColumnIndex) see Function.evaluate(ValueEval[], int, int)
ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0) see Function.evaluate(ValueEval[], int, int)
ValueEval	evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RowFunc

public RowFunc()

Method Detail

evaluate

public ValueEval evaluate(int srcRowIndex,
                          int srcColumnIndex)

Description copied from interface: Function0Arg

see Function.evaluate(ValueEval[], int, int)

Specified by:

evaluate in interface Function0Arg

evaluate

public ValueEval evaluate(int srcRowIndex,
                          int srcColumnIndex,
                          ValueEval arg0)

Description copied from interface: Function1Arg

see Function.evaluate(ValueEval[], int, int)

Specified by:

evaluate in interface Function1Arg

evaluate

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

Specified by:

evaluate in interface Function

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.