com.aspose.cells

Class AbstractCalculationMonitor

java.lang.Object

com.aspose.cells.AbstractCalculationMonitor

public abstract class AbstractCalculationMonitor
extends java.lang.Object

Monitor for user to track the progress of formula calculation.

Example

 
         class MyCalculationMonitor extends AbstractCalculationMonitor
         {
             public /*override*/ void beforeCalculate(int sheetIndex, int rowIndex, int colIndex)
             {
                 if(sheetIndex!=0 || rowIndex!=0 || colIndex!=0)
                 {
                     return;
                 }
                 System.out.println("Cell A1 will be calculated.");
             }
         }
         Workbook wb = new Workbook("calc.xlsx");
         CalculationOptions opts = new CalculationOptions();
         opts.setCalculationMonitor(new MyCalculationMonitor());
         wb.calculateFormula(opts);
 
 

Constructor Summary

Constructors

Constructor and Description
AbstractCalculationMonitor()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterCalculate(int sheetIndex, int rowIndex, int colIndex) Implement this method to do business after one cell has been calculated.
void	beforeCalculate(int sheetIndex, int rowIndex, int colIndex) Implement this method to do business before calculating one cell.
java.lang.Object	getCalculatedValue() Gets the newly calculated value of the cell.
java.lang.Object	getOriginalValue() Gets the old value of the calculated cell.
boolean	getValueChanged() Whether the cell's value has been changed after the calculation.
protected void	interrupt(java.lang.String msg) Interrupts the calculation progress.
boolean	onCircular(java.util.Iterator circularCellsData) Implement this method to do business when calculating formulas with circular references.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCalculationMonitor

public AbstractCalculationMonitor()

Method Detail

interrupt

protected void interrupt(java.lang.String msg)

Interrupts the calculation progress.

Parameters:

msg - The message for the thrown Exception(CellsException with code Interrupted). null or empty string denotes that the progress should be terminated quietly.

getOriginalValue

public java.lang.Object getOriginalValue()

Gets the old value of the calculated cell. Should be used only in beforeCalculate(int,int,int) and afterCalculate(int,int,int).

getValueChanged

public boolean getValueChanged()

Whether the cell's value has been changed after the calculation. Should be used only in afterCalculate(int,int,int).

getCalculatedValue

public java.lang.Object getCalculatedValue()

Gets the newly calculated value of the cell. Should be used only in afterCalculate(int,int,int).

beforeCalculate

public void beforeCalculate(int sheetIndex,
                   int rowIndex,
                   int colIndex)

Implement this method to do business before calculating one cell.

Parameters:

sheetIndex - Index of the sheet that the cell belongs to.

rowIndex - Row index of the cell

colIndex - Column index of the cell

afterCalculate

public void afterCalculate(int sheetIndex,
                  int rowIndex,
                  int colIndex)

Implement this method to do business after one cell has been calculated.

Parameters:

sheetIndex - Index of the sheet that the cell belongs to.

rowIndex - Row index of the cell

colIndex - Column index of the cell

onCircular

public boolean onCircular(java.util.Iterator circularCellsData)

Implement this method to do business when calculating formulas with circular references.

Remarks

In the implementation user may also set the expected value as calculated result for part/all of those cells so the formula engine will not calculate them recursively.

Parameters:

circularCellsData - IEnumerator with CalculationCell items representing cells that depend on circular references.

Returns:

Whether the formula engine needs to calculate those cells in circular after this call. True to let the formula engine continue to do calculation for them. False to let the formula engine just mark those cells as Calculated.