org.zkoss.poi.ss.formula.functions

Class Rate

java.lang.Object

org.zkoss.poi.ss.formula.functions.Rate

All Implemented Interfaces:

Function

public class Rate
extends java.lang.Object
implements Function

Implements the Excel Rate function

Constructor Summary

Constructors

Constructor and Description
Rate()

Method Summary

Methods

Modifier and Type	Method and Description
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

Rate

public Rate()

Method Detail

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.