Package org.apache.poi.ss.formula.functions

Class Rank

java.lang.Object

org.apache.poi.ss.formula.functions.Rank

All Implemented Interfaces:

Function, Function2Arg, Function3Arg

public class Rank
extends Object

Returns the rank of a number in a list of numbers. The rank of a number is its size relative to other values in a list. Syntax: RANK(number,ref,order) Number is the number whose rank you want to find. Ref is an array of, or a reference to, a list of numbers. Nonnumeric values in ref are ignored. Order is a number specifying how to rank number. If order is 0 (zero) or omitted, Microsoft Excel ranks number as if ref were a list sorted in descending order. If order is any nonzero value, Microsoft Excel ranks number as if ref were a list sorted in ascending order.

Constructor Summary

Constructors

Constructor	Description
Rank()

Method Summary

Modifier and Type	Method	Description
ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1)	see Function.evaluate(ValueEval[], int, int)
ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, ValueEval arg2)	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

Rank

public Rank()

Method Detail

evaluate

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

Description copied from interface: Function2Arg

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

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