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()
          Provide the underlying WorkbookEvaluator
 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)
          Should be called to tell the cell value cache that the specified cell has just become a formula cell, or the formula text has changed
 void notifySetFormula(Cell cell)
          Should be called to tell the cell value cache that the specified (value or formula) cell has changed.
 void notifyUpdateCell(Cell cell)
          Should be called to tell the cell value cache that the specified (value or formula) cell has changed.
 void setDebugEvaluationOutputForNextEval(boolean value)
          Perform detailed output of formula evaluation for next evaluation only? Is for developer use only (also developers using POI for their XLS files).
 void setIgnoreMissingWorkbooks(boolean ignore)
          Whether to ignore missing references to external workbooks and use cached formula results in the main workbook instead.
 void setupReferencedWorkbooks(java.util.Map<java.lang.String,FormulaEvaluator> evaluators)
          Sets up the Formula Evaluator to be able to reference and resolve links to other workbooks, eg [Test.xls]Sheet1!A1.
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)
Description copied from interface: FormulaEvaluator
Should be called to tell the cell value cache that the specified (value or formula) cell has changed. Failure to call this method after changing cell values will cause incorrect behaviour of the evaluate~ methods of this class

Specified by:
notifySetFormula in interface FormulaEvaluator

notifyDeleteCell

public void notifyDeleteCell(Cell cell)
Description copied from interface: FormulaEvaluator
Should be called to tell the cell value cache that the specified cell has just become a formula cell, or the formula text has changed

Specified by:
notifyDeleteCell in interface FormulaEvaluator

notifyUpdateCell

public void notifyUpdateCell(Cell cell)
Description copied from interface: FormulaEvaluator
Should be called to tell the cell value cache that the specified (value or formula) cell has changed. Failure to call this method after changing cell values will cause incorrect behaviour of the evaluate~ methods of this class

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)
Description copied from interface: FormulaEvaluator
Sets up the Formula Evaluator to be able to reference and resolve links to other workbooks, eg [Test.xls]Sheet1!A1.

For a workbook referenced as [Test.xls]Sheet1!A1, you should supply a map containing the key Test.xls (no square brackets), and an open FormulaEvaluator onto that Workbook.

Specified by:
setupReferencedWorkbooks in interface FormulaEvaluator
Parameters:
evaluators - Map of workbook names (no square brackets) to an evaluator on that workbook

_getWorkbookEvaluator

public WorkbookEvaluator _getWorkbookEvaluator()
Description copied from interface: WorkbookEvaluatorProvider
Provide the underlying WorkbookEvaluator

Specified by:
_getWorkbookEvaluator in interface WorkbookEvaluatorProvider

setIgnoreMissingWorkbooks

public void setIgnoreMissingWorkbooks(boolean ignore)
Whether to ignore missing references to external workbooks and use cached formula results in the main workbook instead.

In some cases external workbooks referenced by formulas in the main workbook are not available. With this method you can control how POI handles such missing references:

Specified by:
setIgnoreMissingWorkbooks in interface FormulaEvaluator
Parameters:
ignore - whether to ignore missing references to external workbooks

setDebugEvaluationOutputForNextEval

public void setDebugEvaluationOutputForNextEval(boolean value)
Perform detailed output of formula evaluation for next evaluation only? Is for developer use only (also developers using POI for their XLS files). Log-Level WARN is for basic info, INFO for detailed information. These quite high levels are used because you have to explicitly enable this specific logging.

Specified by:
setDebugEvaluationOutputForNextEval in interface FormulaEvaluator
Parameters:
value - whether to perform detailed output


Copyright 2016 The Apache Software Foundation or its licensors, as applicable.