Package org.apache.poi.hssf.usermodel
Class HSSFFormulaEvaluator
java.lang.Object
org.apache.poi.ss.formula.BaseFormulaEvaluator
org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator
- All Implemented Interfaces:
WorkbookEvaluatorProvider,FormulaEvaluator
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
ConstructorsConstructorDescriptionHSSFFormulaEvaluator(HSSFWorkbook workbook) HSSFFormulaEvaluator(HSSFWorkbook workbook, IStabilityClassifier stabilityClassifier) -
Method Summary
Modifier and TypeMethodDescriptionstatic HSSFFormulaEvaluatorcreate(HSSFWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder) protected RichTextStringvoidLoops over all cells in all sheets of the supplied workbook.static voidLoops over all cells in all sheets of the supplied workbook.static voidLoops over all cells in all sheets of the supplied workbook.protected CellValueevaluateFormulaCellValue(Cell cell) Returns a CellValue wrapper around the supplied ValueEval instance.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.voidnotifyDeleteCell(HSSFCell cell) Should be called to tell the cell value cache that the specified cell has just been deleted.voidnotifyDeleteCell(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 changedvoidnotifySetFormula(Cell cell) Should be called to tell the cell value cache that the specified (value or formula) cell has changed.voidnotifyUpdateCell(HSSFCell cell) Should be called to tell the cell value cache that the specified (value or formula) cell has changed.voidnotifyUpdateCell(Cell cell) Should be called to tell the cell value cache that the specified (value or formula) cell has changed.voidsetDebugEvaluationOutputForNextEval(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).voidsetIgnoreMissingWorkbooks(boolean ignore) Whether to ignore missing references to external workbooks and use cached formula results in the main workbook instead.static voidsetupEnvironment(String[] workbookNames, HSSFFormulaEvaluator[] evaluators) Coordinates several formula evaluators together so that formulas that involve external references can be evaluated.voidsetupReferencedWorkbooks(Map<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, evaluateFormulaCellEnum, getEvaluationWorkbook, setCellType, setCellType, setCellValue, setupEnvironment
-
Constructor Details
-
HSSFFormulaEvaluator
-
HSSFFormulaEvaluator
- Parameters:
workbook- The workbook to perform the formula evaluations instabilityClassifier- used to optimise caching performance. Passnullfor the (conservative) assumption that any cell may have its definition changed after evaluation begins.
-
-
Method Details
-
create
public static HSSFFormulaEvaluator create(HSSFWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder) - Parameters:
workbook- The workbook to perform the formula evaluations instabilityClassifier- used to optimise caching performance. Passnullfor the (conservative) assumption that any cell may have its definition changed after evaluation begins.udfFinder- passnullfor default (AnalysisToolPak only)
-
createRichTextString
- Specified by:
createRichTextStringin classBaseFormulaEvaluator
-
setupEnvironment
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
Description copied from interface:FormulaEvaluatorSets 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:
setupReferencedWorkbooksin interfaceFormulaEvaluator- Overrides:
setupReferencedWorkbooksin classBaseFormulaEvaluator- Parameters:
evaluators- Map of workbook names (no square brackets) to an evaluator on that workbook
-
notifyUpdateCell
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
Description copied from interface:FormulaEvaluatorShould 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
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
Description copied from interface:FormulaEvaluatorShould 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
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
Description copied from class:BaseFormulaEvaluatorIf 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 ofCellis 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, useBaseFormulaEvaluator.evaluateFormulaCell(Cell)}- Specified by:
evaluateInCellin interfaceFormulaEvaluator- Overrides:
evaluateInCellin classBaseFormulaEvaluator- Parameters:
cell- TheCellto evaluate and modify.- Returns:
- the
cellthat was passed in, allowing for chained calls
-
evaluateAllFormulaCells
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
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
Returns a CellValue wrapper around the supplied ValueEval instance.- Specified by:
evaluateFormulaCellValuein classBaseFormulaEvaluator- Parameters:
cell-
-
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:
- by default ignoreMissingWorkbooks=false and POI throws
CollaboratingWorkbooksEnvironment.WorkbookNotFoundExceptionif an external reference cannot be resolved - if ignoreMissingWorkbooks=true then POI uses cached formula result that already exists in the main workbook
- Specified by:
setIgnoreMissingWorkbooksin interfaceFormulaEvaluator- Overrides:
setIgnoreMissingWorkbooksin classBaseFormulaEvaluator- Parameters:
ignore- whether to ignore missing references to external workbooks
- by default ignoreMissingWorkbooks=false and POI throws
-
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:
setDebugEvaluationOutputForNextEvalin interfaceFormulaEvaluator- Overrides:
setDebugEvaluationOutputForNextEvalin classBaseFormulaEvaluator- Parameters:
value- whether to perform detailed output
-