HSSFFormulaEvaluator (POI API Documentation)

java.lang.Object
- org.apache.poi.ss.formula.BaseFormulaEvaluator
- - org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator

All Implemented Interfaces:

WorkbookEvaluatorProvider, FormulaEvaluator
```
public class HSSFFormulaEvaluator
extends BaseFormulaEvaluator
```
Evaluates formula cells.
For performance reasons, this class keeps a cache of all previously calculated intermediate cell values. Be sure to call BaseFormulaEvaluator.clearAllCachedResultValues() if any workbook cells are changed between calls to evaluate~ methods on this class.

Field Summary
- Fields inherited from class org.apache.poi.ss.formula.BaseFormulaEvaluator
  _bookEvaluator

Constructor Summary

Constructors
Constructor and Description
`HSSFFormulaEvaluator(HSSFWorkbook workbook)`
`HSSFFormulaEvaluator(HSSFWorkbook workbook, IStabilityClassifier stabilityClassifier)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HSSFFormulaEvaluator`	`create(HSSFWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder)`
`protected RichTextString`	`createRichTextString(java.lang.String str)`
`void`	`evaluateAll()` Loops over all cells in all sheets of the supplied workbook.
`static void`	`evaluateAllFormulaCells(HSSFWorkbook wb)` Loops over all cells in all sheets of the supplied workbook.
`static void`	`evaluateAllFormulaCells(Workbook wb)` Loops over all cells in all sheets of the supplied workbook.
`protected CellValue`	`evaluateFormulaCellValue(Cell cell)` Returns a CellValue wrapper around the supplied ValueEval instance.
`HSSFCell`	`evaluateInCell(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.
`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`	`notifyDeleteCell(HSSFCell cell)` Should be called to tell the cell value cache that the specified cell has just been deleted.
`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`	`notifyUpdateCell(HSSFCell 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.
`static void`	`setupEnvironment(java.lang.String[] workbookNames, HSSFFormulaEvaluator[] evaluators)` Coordinates several formula evaluators together so that formulas that involve external references can be evaluated.
`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.

Methods inherited from class org.apache.poi.ss.formula.BaseFormulaEvaluator
_getWorkbookEvaluator, clearAllCachedResultValues, evaluate, evaluateAllFormulaCells, evaluateFormulaCell, getEvaluationWorkbook, setCellType, setCellType, setCellValue, setupEnvironment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HSSFFormulaEvaluator
```
public HSSFFormulaEvaluator(HSSFWorkbook workbook)
```
  - HSSFFormulaEvaluator
```
public HSSFFormulaEvaluator(HSSFWorkbook workbook,
                            IStabilityClassifier stabilityClassifier)
```
    Parameters:
    
    workbook - The workbook to perform the formula evaluations in
    
    stabilityClassifier - used to optimise caching performance. Pass null for the (conservative) assumption that any cell may have its definition changed after evaluation begins.
- Method Detail
  - create
```
public static HSSFFormulaEvaluator create(HSSFWorkbook workbook,
                                          IStabilityClassifier stabilityClassifier,
                                          UDFFinder udfFinder)
```
    Parameters:
    
    workbook - The workbook to perform the formula evaluations in
    
    stabilityClassifier - used to optimise caching performance. Pass null for the (conservative) assumption that any cell may have its definition changed after evaluation begins.
    
    udfFinder - pass null for default (AnalysisToolPak only)
  - createRichTextString
```
protected RichTextString createRichTextString(java.lang.String str)
```
    Specified by:
    
    createRichTextString in class BaseFormulaEvaluator
  - setupEnvironment
```
public static void setupEnvironment(java.lang.String[] workbookNames,
                                    HSSFFormulaEvaluator[] evaluators)
```
    Coordinates several formula evaluators together so that formulas that involve external references can be evaluated.
    
    Parameters:
    
    workbookNames - the simple file names used to identify the workbooks in formulas with external links (for example "MyData.xls" as used in a formula "[MyData.xls]Sheet1!A1")
    
    evaluators - all evaluators for the full set of workbooks required by the formulas.
  - 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
    
    Overrides:
    
    setupReferencedWorkbooks in class BaseFormulaEvaluator
    
    Parameters:
    
    evaluators - Map of workbook names (no square brackets) to an evaluator on that workbook
  - notifyUpdateCell
```
public void notifyUpdateCell(HSSFCell cell)
```
    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
  - 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
  - notifyDeleteCell
```
public void notifyDeleteCell(HSSFCell cell)
```
    Should be called to tell the cell value cache that the specified cell has just been deleted. Failure to call this method after changing cell values will cause incorrect behaviour of the evaluate~ methods of this class
  - 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
  - notifySetFormula
```
public void notifySetFormula(Cell cell)
```
    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
  - evaluateInCell
```
public HSSFCell evaluateInCell(Cell cell)
```
    Description copied from class: BaseFormulaEvaluator
    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. Note that the same instance of Cell is returned to allow chained calls like:
```
 int evaluatedCellType = evaluator.evaluateInCell(cell).getCellType();
 
```
    Be aware that your cell value will be changed to hold the result of the formula. If you simply want the formula value computed for you, use BaseFormulaEvaluator.evaluateFormulaCell(Cell)}
    Specified by:
    
    evaluateInCell in interface FormulaEvaluator
    
    Overrides:
    
    evaluateInCell in class BaseFormulaEvaluator
    
    Parameters:
    
    cell - The Cell to evaluate and modify.
    
    Returns:
    
    the cell that was passed in, allowing for chained calls
  - evaluateAllFormulaCells
```
public static void evaluateAllFormulaCells(HSSFWorkbook wb)
```
    Loops over all cells in all sheets of the supplied workbook. For cells that contain formulas, their formulas are evaluated, and the results are saved. These cells remain as formula cells. For cells that do not contain formulas, no changes are made. This is a helpful wrapper around looping over all cells, and calling evaluateFormulaCell on each one.
  - evaluateAllFormulaCells
```
public static void evaluateAllFormulaCells(Workbook wb)
```
    Loops over all cells in all sheets of the supplied workbook. For cells that contain formulas, their formulas are evaluated, and the results are saved. These cells remain as formula cells. For cells that do not contain formulas, no changes are made. This is a helpful wrapper around looping over all cells, and calling evaluateFormulaCell on each one.
  - evaluateAll
```
public void evaluateAll()
```
    Loops over all cells in all sheets of the supplied workbook. For cells that contain formulas, their formulas are evaluated, and the results are saved. These cells remain as formula cells. For cells that do not contain formulas, no changes are made. This is a helpful wrapper around looping over all cells, and calling evaluateFormulaCell on each one.
  - evaluateFormulaCellValue
```
protected CellValue evaluateFormulaCellValue(Cell cell)
```
    Returns a CellValue wrapper around the supplied ValueEval instance.
    
    Specified by:
    
    evaluateFormulaCellValue in class BaseFormulaEvaluator
    
    Parameters:
    
    cell - The cell with the formula
  - setIgnoreMissingWorkbooks
```
public void setIgnoreMissingWorkbooks(boolean ignore)
```
    Description copied from interface: FormulaEvaluator
    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:
    - by default ignoreMissingWorkbooks=false and POI throws CollaboratingWorkbooksEnvironment.WorkbookNotFoundException if an external reference cannot be resolved
    - if ignoreMissingWorkbooks=true then POI uses cached formula result that already exists in the main workbook
    Specified by:
    
    setIgnoreMissingWorkbooks in interface FormulaEvaluator
    
    Overrides:
    
    setIgnoreMissingWorkbooks in class BaseFormulaEvaluator
    
    Parameters:
    
    ignore - whether to ignore missing references to external workbooks
  - setDebugEvaluationOutputForNextEval
```
public void setDebugEvaluationOutputForNextEval(boolean value)
```
    Description copied from interface: FormulaEvaluator
    
    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
    
    Overrides:
    
    setDebugEvaluationOutputForNextEval in class BaseFormulaEvaluator
    
    Parameters:
    
    value - whether to perform detailed output

Class HSSFFormulaEvaluator

Field Summary

Fields inherited from class org.apache.poi.ss.formula.BaseFormulaEvaluator

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.ss.formula.BaseFormulaEvaluator

Methods inherited from class java.lang.Object

Constructor Detail

HSSFFormulaEvaluator

HSSFFormulaEvaluator

Method Detail

create

createRichTextString

setupEnvironment

setupReferencedWorkbooks

notifyUpdateCell

notifyUpdateCell

notifyDeleteCell

notifyDeleteCell

notifySetFormula

evaluateInCell

evaluateAllFormulaCells

evaluateAllFormulaCells

evaluateAll

evaluateFormulaCellValue

setIgnoreMissingWorkbooks

setDebugEvaluationOutputForNextEval