Top Description Constructors Methods
org.apache.poi.ss.formula.functions

pack-priv abstract Class Var3or4ArgFunction

extends Object
implements Function3Arg, Function4Arg
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.functions.Function4Arg, org.apache.poi.ss.formula.functions.Function, org.apache.poi.ss.formula.functions.Function3Arg
Known Direct Subclasses
org.apache.poi.ss.formula.functions.Vlookup, org.apache.poi.ss.formula.functions.Hlookup, org.apache.poi.ss.formula.functions.Substitute
Imports
org.apache.poi.ss.formula.eval.ErrorEval, .ValueEval
Convenience base class for any function which must take three or four arguments

Constructor Summary

AccessConstructor and Description
pack-priv
Var3or4ArgFunction()

Method Summary

Modifier and TypeMethod and Description
public final ValueEval
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)

Implements org.apache.poi.ss.formula.functions.Function.evaluate.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Var3or4ArgFunctionback to summary
pack-priv Var3or4ArgFunction()

Method Detail

evaluateback to summary
public final ValueEval evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

Implements org.apache.poi.ss.formula.functions.Function.evaluate.

Parameters
args:ValueEval[]

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

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

srcRowIndex:int

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

row index of the cell containing the formula under evaluation

srcColumnIndex:int

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

column index of the cell containing the formula under evaluation

Returns:ValueEval

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

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.