Package org.apache.poi.ss.formula
Class BaseFormulaEvaluator
java.lang.Object
org.apache.poi.ss.formula.BaseFormulaEvaluator
- All Implemented Interfaces:
WorkbookEvaluatorProvider,FormulaEvaluator
- Direct Known Subclasses:
BaseXSSFFormulaEvaluator,HSSFFormulaEvaluator
public abstract class BaseFormulaEvaluator
extends Object
implements FormulaEvaluator, WorkbookEvaluatorProvider
Common functionality across file formats for evaluating formula cells.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionProvide the underlying WorkbookEvaluatorvoidShould be called whenever there are major changes (e.g.protected abstract RichTextStringIf 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.static voidLoops over all cells in all sheets of the supplied workbook.protected static voidevaluateAllFormulaCells(Workbook wb, FormulaEvaluator evaluator) evaluateFormulaCell(Cell cell) If cell contains formula, it evaluates the formula, and saves the result of the formula.evaluateFormulaCellEnum(Cell cell) Deprecated.protected abstract CellValueevaluateFormulaCellValue(Cell cell) 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.protected EvaluationWorkbookinternal useprotected voidsetCellType(Cell cell, CellType cellType) Override if a different variation is needed, e.g.protected voidsetCellType(Cell cell, CellValue cv) set the cell typeprotected voidsetCellValue(Cell cell, CellValue cv) 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, BaseFormulaEvaluator[] 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.poi.ss.usermodel.FormulaEvaluator
evaluateAll, notifyDeleteCell, notifySetFormula, notifyUpdateCell
-
Field Details
-
_bookEvaluator
-
-
Constructor Details
-
BaseFormulaEvaluator
-
-
Method Details
-
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- Parameters:
evaluators- Map of workbook names (no square brackets) to an evaluator on that workbook
-
_getWorkbookEvaluator
Description copied from interface:WorkbookEvaluatorProviderProvide the underlying WorkbookEvaluator- Specified by:
_getWorkbookEvaluatorin interfaceWorkbookEvaluatorProvider
-
getEvaluationWorkbook
internal use- Returns:
- evaluation workbook
-
clearAllCachedResultValues
public void clearAllCachedResultValues()Should be called whenever there are major changes (e.g. moving sheets) to input cells in the evaluated workbook. If performance is not critical, a single call to this method may be used instead of many specific calls to the notify~ methods. Failure to call this method after changing cell values will cause incorrect behaviour of the evaluate~ methods of this class- Specified by:
clearAllCachedResultValuesin interfaceFormulaEvaluator
-
evaluate
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:
evaluatein interfaceFormulaEvaluator- Parameters:
cell- may benullsignifying that the cell is not present (or blank)- Returns:
nullif the supplied cell isnullor blank
-
evaluateInCell
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 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, useevaluateFormulaCell(Cell)}- Specified by:
evaluateInCellin interfaceFormulaEvaluator- Parameters:
cell- TheCellto evaluate and modify.- Returns:
- the
cellthat was passed in, allowing for chained calls
-
evaluateFormulaCellValue
-
evaluateFormulaCell
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.CellType 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, useevaluate(org.apache.poi.ss.usermodel.Cell)}- Specified by:
evaluateFormulaCellin interfaceFormulaEvaluator- Parameters:
cell- The cell to evaluate- Returns:
- The type of the formula result (the cell's type remains as CellType.FORMULA however)
If cell is not a formula cell, returns
CellType._NONErather than throwing an exception.
-
evaluateFormulaCellEnum
Deprecated.useevaluateFormulaCell(cell)insteadIf 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.CellType 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, useevaluate(org.apache.poi.ss.usermodel.Cell)}- Specified by:
evaluateFormulaCellEnumin interfaceFormulaEvaluator- Parameters:
cell- The cell to evaluate- Returns:
- The type of the formula result (the cell's type remains as CellType.FORMULA however)
If cell is not a formula cell, returns
CellType._NONErather than throwing an exception. - Since:
- POI 3.15 beta 3
-
setCellType
set the cell type- Parameters:
cell-cv-
-
setCellType
Override if a different variation is needed, e.g. passing the evaluator to the cell method- Parameters:
cell-cellType-
-
createRichTextString
-
setCellValue
-
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
-
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- 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- Parameters:
value- whether to perform detailed output
-
evaluateFormulaCell(cell)instead