com.aspose.cells.AbstractCalculationEngine.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aspose-cells Show documentation

Aspose.Cells for Java

There is a newer version: 23.1






AbstractCalculationEngine





com.aspose.cells

Class AbstractCalculationEngine
java.lang.Object
    com.aspose.cells.AbstractCalculationEngine



public abstract class AbstractCalculationEngine extends java.lang.Object





            Represents user's custom calculation engine to extend the default calculation engine of Aspose.Cells.
            
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 CalculationData.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.












Property Getters/Setters Summary



boolean isParamLiteralRequired() 
          
            Indicates whether this engine needs the literal text of parameter while doing calculation. Default value is false.
            



boolean getProcessBuiltInFunctions() 
          
            Whether built-in functions that have been supported by the built-in engine should be checked and processed by this implementation.
            Default is false.
            If user needs to change the calculation logic of some built-in functions, this property should be set as true.
            

 







Method Summary




abstract void calculate(CalculationData data) 
          
            Calculates one function with given data.
            

 








Property Getters/Setters Detail



isParamLiteralRequired 
public boolean isParamLiteralRequired()


            Indicates whether this engine needs the literal text of parameter while doing calculation. Default value is false.
            
If this custom calculation engine requires the parameter's literal text, more stacks will be required to cache the literal text for parameters and Calculate() method may be called recursively to calculate the parameter's value.
            Commonly the literal text is not needed for calculating formulas and this method should return false for most implementations to get better performance.
            



getProcessBuiltInFunctions 
public boolean getProcessBuiltInFunctions()


            Whether built-in functions that have been supported by the built-in engine should be checked and processed by this implementation.
            Default is false.
            If user needs to change the calculation logic of some built-in functions, this property should be set as true.
            







Method Detail



calculate 
public abstract void calculate(CalculationData data)

            Calculates one function with given data.
            
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.




See Also:


          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.

          Aspose.Cells Support Forum - our preferred method of support.
We guarantee a prompt response to any inquiry!
© 2003-2022 Aspose Pty Ltd. All rights reserved.

Property Getters/Setters Summary
`boolean`	`isParamLiteralRequired()`
	Indicates whether this engine needs the literal text of parameter while doing calculation. Default value is false.
`boolean`	`getProcessBuiltInFunctions()`
	Whether built-in functions that have been supported by the built-in engine should be checked and processed by this implementation. Default is false. If user needs to change the calculation logic of some built-in functions, this property should be set as true.

Method Summary
`abstract void`	`calculate(CalculationData data)`
`abstract void`	Calculates one function with given data.

isParamLiteralRequired
public boolean isParamLiteralRequired()

getProcessBuiltInFunctions
public boolean getProcessBuiltInFunctions()

calculate
public abstract void calculate(CalculationData data)

com.aspose.cells.AbstractCalculationEngine.html Maven / Gradle / Ivy

com.aspose.cells Class AbstractCalculationEngine

isParamLiteralRequired

getProcessBuiltInFunctions

calculate

com.aspose.cells
Class AbstractCalculationEngine