Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.xssf.usermodel
Class BaseXSSFFormulaEvaluator

java.lang.Object
  extended by org.apache.poi.xssf.usermodel.BaseXSSFFormulaEvaluator
All Implemented Interfaces:
WorkbookEvaluatorProvider, FormulaEvaluator
Direct Known Subclasses:
SXSSFFormulaEvaluator, XSSFFormulaEvaluator
public abstract class BaseXSSFFormulaEvaluator
extends java.lang.Object
implements FormulaEvaluator, WorkbookEvaluatorProvider

Internal POI use only - parent of XSSF and SXSSF formula evaluators

Constructor Summary
protected BaseXSSFFormulaEvaluator(WorkbookEvaluator bookEvaluator)
           
 
Method Summary
 WorkbookEvaluator _getWorkbookEvaluator()
           
 void clearAllCachedResultValues()
          Should be called whenever there are major changes (e.g.
protected  void doEvaluateInCell(Cell cell)
          If cell contains formula, it evaluates the formula, and puts the formula result back into the cell, in place of the old formula.
 CellValue evaluate(Cell cell)
          If cell contains a formula, the formula is evaluated and returned, else the CellValue simply copies the appropriate cell value from the cell and also its cell type.
 int evaluateFormulaCell(Cell cell)
          If cell contains formula, it evaluates the formula, and saves the result of the formula.
 void notifyDeleteCell(Cell cell)
           
 void notifySetFormula(Cell cell)
           
 void notifyUpdateCell(Cell cell)
           
 void setDebugEvaluationOutputForNextEval(boolean value)
          
 void setIgnoreMissingWorkbooks(boolean ignore)
          
 void setupReferencedWorkbooks(java.util.Map<java.lang.String,FormulaEvaluator> evaluators)
           
protected abstract  EvaluationCell toEvaluationCell(Cell cell)
          Turns a XSSFCell / SXSSFCell into a XSSFEvaluationCell
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.poi.ss.usermodel.FormulaEvaluator
evaluateAll, evaluateInCell
 

Constructor Detail

BaseXSSFFormulaEvaluator

protected BaseXSSFFormulaEvaluator(WorkbookEvaluator bookEvaluator)
Method Detail

clearAllCachedResultValues

public void clearAllCachedResultValues()
Should be called whenever there are major changes (e.g. moving sheets) to input cells in the evaluated workbook. Failure to call this method after changing cell values will cause incorrect behaviour of the evaluate~ methods of this class

Specified by:
clearAllCachedResultValues in interface FormulaEvaluator

notifySetFormula

public void notifySetFormula(Cell cell)
Specified by:
notifySetFormula in interface FormulaEvaluator

notifyDeleteCell

public void notifyDeleteCell(Cell cell)
Specified by:
notifyDeleteCell in interface FormulaEvaluator

notifyUpdateCell

public void notifyUpdateCell(Cell cell)
Specified by:
notifyUpdateCell in interface FormulaEvaluator

evaluate

public CellValue evaluate(Cell cell)
If cell contains a formula, the formula is evaluated and returned, else the CellValue simply copies the appropriate cell value from the cell and also its cell type. This method should be preferred over evaluateInCell() when the call should not modify the contents of the original cell.

Specified by:
evaluate in interface FormulaEvaluator
Parameters:
cell -

evaluateFormulaCell

public int evaluateFormulaCell(Cell cell)
If cell contains formula, it evaluates the formula, and saves the result of the formula. The cell remains as a formula cell. Else if cell does not contain formula, this method leaves the cell unchanged. Note that the type of the formula result is returned, so you know what kind of value is also stored with the formula. 
 int evaluatedCellType = evaluator.evaluateFormulaCell(cell);
Be aware that your cell will hold both the formula, and the result. If you want the cell replaced with the result of the formula, use evaluate(org.apache.poi.ss.usermodel.Cell) }

Specified by:
evaluateFormulaCell in interface FormulaEvaluator
Parameters:
cell - The cell to evaluate
Returns:
The type of the formula result (the cell's type remains as HSSFCell.CELL_TYPE_FORMULA however)

doEvaluateInCell

protected void doEvaluateInCell(Cell cell)
If cell contains formula, it evaluates the formula, and puts the formula result back into the cell, in place of the old formula. Else if cell does not contain formula, this method leaves the cell unchanged.

toEvaluationCell

protected abstract EvaluationCell toEvaluationCell(Cell cell)
Turns a XSSFCell / SXSSFCell into a XSSFEvaluationCell

setupReferencedWorkbooks

public void setupReferencedWorkbooks(java.util.Map<java.lang.String,FormulaEvaluator> evaluators)
Specified by:
setupReferencedWorkbooks in interface FormulaEvaluator

_getWorkbookEvaluator

public WorkbookEvaluator _getWorkbookEvaluator()
Specified by:
_getWorkbookEvaluator in interface WorkbookEvaluatorProvider

setIgnoreMissingWorkbooks

public void setIgnoreMissingWorkbooks(boolean ignore)

Specified by:
setIgnoreMissingWorkbooks in interface FormulaEvaluator

setDebugEvaluationOutputForNextEval

public void setDebugEvaluationOutputForNextEval(boolean value)

Specified by:
setDebugEvaluationOutputForNextEval in interface FormulaEvaluator
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD