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

java.lang.Object
  extended by org.apache.poi.hssf.record.formula.functions.XYNumericFunction
All Implemented Interfaces:
Function
Direct Known Subclasses:
Sumx2my2, Sumx2py2, Sumxmy2

public abstract class XYNumericFunction
extends java.lang.Object
implements Function

Author:
Amol S. Deshmukh < amolweb at ya hoo dot com >

Nested Class Summary
protected static interface XYNumericFunction.Accumulator
           
 
Constructor Summary
XYNumericFunction()
           
 
Method Summary
protected abstract  XYNumericFunction.Accumulator createAccumulator()
          Constructs a new instance of the Accumulator used to calculated this function
 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

XYNumericFunction

public XYNumericFunction()
Method Detail

createAccumulator

protected abstract XYNumericFunction.Accumulator createAccumulator()
Constructs a new instance of the Accumulator used to calculated this function


evaluate

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