org.apache.poi.ss.formula.functions
Class Vlookup
java.lang.Object
org.apache.poi.ss.formula.functions.Vlookup
- All Implemented Interfaces:
- Function, Function3Arg, Function4Arg
public final class Vlookup
- extends java.lang.Object
Implementation of the VLOOKUP() function.
VLOOKUP finds a row in a lookup table by the first column value and returns the value from another column.
Syntax:
VLOOKUP(lookup_value, table_array, col_index_num, range_lookup)
lookup_value The value to be found in the first column of the table array.
table_array An area reference for the lookup data.
col_index_num a 1 based index specifying which column value of the lookup data will be returned.
range_lookup If TRUE (default), VLOOKUP finds the largest value less than or equal to
the lookup_value. If FALSE, only exact matches will be considered
- Author:
- Josh Micich
Method Summary |
ValueEval |
evaluate(int srcRowIndex,
int srcColumnIndex,
ValueEval arg0,
ValueEval arg1,
ValueEval arg2)
see Function.evaluate(ValueEval[], int, int) |
ValueEval |
evaluate(int srcRowIndex,
int srcColumnIndex,
ValueEval arg0,
ValueEval arg1,
ValueEval arg2,
ValueEval arg3)
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 |
Vlookup
public Vlookup()
evaluate
public ValueEval evaluate(int srcRowIndex,
int srcColumnIndex,
ValueEval arg0,
ValueEval arg1,
ValueEval arg2)
- Description copied from interface:
Function3Arg
- see
Function.evaluate(ValueEval[], int, int)
evaluate
public ValueEval evaluate(int srcRowIndex,
int srcColumnIndex,
ValueEval arg0,
ValueEval arg1,
ValueEval arg2,
ValueEval arg3)
- Description copied from interface:
Function4Arg
- see
Function.evaluate(ValueEval[], int, int)
evaluate
public final 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 evaluationsrcColumnIndex
- 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 2012 The Apache Software Foundation or
its licensors, as applicable.