com.aspose.gridjs

Class GridAbstractCalculationEngine

java.lang.Object

com.aspose.gridjs.GridAbstractCalculationEngine

public abstract class GridAbstractCalculationEngine
extends java.lang.Object

Represents user's custom calculation engine to extend the default calculation engine of Aspose.Cells.

Remarks

User should not modify any part of the Workbook directly in this implementation(except the calculated result of the custom function, which can be set by GridCalculationData.CalculatedValue property). Otherwise unexpected result or Exception may be caused. If user needs to change other data than calculated result in the implementation for some custom functions, For example, change cell's formula, style, ...etc., user should gather those data in this implementation and change them out of the scope of formula calculation.

Example

 
          class MyEngine extends GridAbstractCalculationEngine
         {
             public /*override*/ void calculate(GridCalculationData data)
             {
                 String funcName = data.getFunctionName().toUpperCase();
                 if ("MYFUNC".equals(funcName))
                 {   
                     //do calculation for MYFUNC here
                     int count = data.getParamCount();
                     Object res = null;
                     for (int i = 0; i <count; i++)
                     {
                         Object pv = data.getParamValue(i);
                         if (pv instanceof GridReferredArea)
                         {
                             GridReferredArea ra = (GridReferredArea)pv;
                             pv = ra.getValue(0, 0);
                         }
                         //process the parameter here
                         //res = ...;
                     }
                     data.setCalculatedValue(res);
                 }
             }
         }
 

Constructor Summary

Constructors

Constructor and Description
GridAbstractCalculationEngine()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	calculate(GridCalculationData data) Calculates one function with given data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GridAbstractCalculationEngine

public GridAbstractCalculationEngine()

Method Detail

calculate

public abstract void calculate(GridCalculationData data)

Calculates one function with given data.

Remarks

User should set the calculated value for given data for all functions(including excel native functions) that he wants to calculate by himself in this implementation.

Parameters:

data - The required data to calculate function such as function name, parameters, ...etc.