org.apache.poi.hssf.record.formula.functions
Class Lookup

java.lang.Object
  extended by org.apache.poi.hssf.record.formula.functions.Lookup
All Implemented Interfaces:
Function

public final class Lookup
extends java.lang.Object
implements Function

Implementation of Excel function LOOKUP.

LOOKUP finds an index row in a lookup table by the first column value and returns the value from another column. Syntax:
VLOOKUP(lookup_value, lookup_vector, result_vector)

lookup_value The value to be found in the lookup vector.
lookup_vector An area reference for the lookup data.
result_vector Single row or single column area reference from which the result value is chosen.

Author:
Josh Micich

Constructor Summary
Lookup()
           
 
Method Summary
 Eval evaluate(Eval[] args, int srcCellRow, short srcCellCol)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Lookup

public Lookup()
Method Detail

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 evaluation
srcCellCol - 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.