Apache POI - Common 5.3.0 · org.apache.poi.ss.formula.BaseFormulaEvaluator

Modifier and Type	Field and Description
protected final WorkbookEvaluator	_bookEvaluator

Access	Constructor and Description
protected	BaseFormulaEvaluator(WorkbookEvaluator bookEvaluator)

Method Summary

Modifier and Type	Method and Description
public WorkbookEvaluator	_getWorkbookEvaluator() Implements org.apache.poi.ss.formula.WorkbookEvaluatorProvider._getWorkbookEvaluator. Provide the underlying WorkbookEvaluator
public void	clearAllCachedResultValues() Implements org.apache.poi.ss.usermodel.FormulaEvaluator.clearAllCachedResultValues. Should be called whenever there are major changes (e.g. moving sheets) to input cells in the evaluated workbook.
protected abstract RichTextString	createRichTextString(String str)
public CellValue	Returns: `null` if the supplied cell is `null` or blank evaluate(Cell may be `null` signifying that the cell is not present (or blank) cell) Implements org.apache.poi.ss.usermodel.FormulaEvaluator.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.
public static void	evaluateAllFormulaCells(Workbook wb) Loops over all cells in all sheets of the supplied workbook.
protected static void	evaluateAllFormulaCells(Workbook wb, FormulaEvaluator evaluator)
public CellType	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#_NONE` rather than throwing an exception. evaluateFormulaCell(Cell The cell to evaluate cell) Implements org.apache.poi.ss.usermodel.FormulaEvaluator.evaluateFormulaCell. If cell contains formula, it evaluates the formula, and saves the result of the formula.
protected abstract CellValue	evaluateFormulaCellValue(Cell cell)
public Cell	Returns: the `cell` that was passed in, allowing for chained calls evaluateInCell(Cell The `Cell` to evaluate and modify. cell) Implements org.apache.poi.ss.usermodel.FormulaEvaluator.evaluateInCell. If cell contains formula, it evaluates the formula, and puts the formula result back into the cell, in place of the old formula.
protected EvaluationWorkbook	Returns: evaluation workbook getEvaluationWorkbook() internal use
protected void	setCellType(Cell The Cell to populate cell, CellValue The CellValue to read the result type from cv) Set the cell type based on the computed cell type as part of a formula evaluation.
protected void	setCellType(Cell The Cell to populate cell, CellType The wanted type for this Cell cellType) Override if a different variation is needed, e.g. passing the evaluator to the cell method
protected void	setCellValue(Cell cell, CellValue cv)
public void	setDebugEvaluationOutputForNextEval(boolean whether to perform detailed output value) Implements org.apache.poi.ss.usermodel.FormulaEvaluator.setDebugEvaluationOutputForNextEval. Perform detailed output of formula evaluation for next evaluation only?
public void	setIgnoreMissingWorkbooks(boolean whether to ignore missing references to external workbooks ignore) Implements org.apache.poi.ss.usermodel.FormulaEvaluator.setIgnoreMissingWorkbooks. Whether to ignore missing references to external workbooks and use cached formula results in the main workbook instead.
public static void	setupEnvironment(String[] 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") workbookNames, BaseFormulaEvaluator[] all evaluators for the full set of workbooks required by the formulas. evaluators) Coordinates several formula evaluators together so that formulas that involve external references can be evaluated.
public void	setupReferencedWorkbooks(Map<String, FormulaEvaluator> Map of workbook names (no square brackets) to an evaluator on that workbook evaluators) Implements org.apache.poi.ss.usermodel.FormulaEvaluator.setupReferencedWorkbooks. Sets up the Formula Evaluator to be able to reference and resolve links to other workbooks, eg [Test.xls]Sheet1!A1.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

_bookEvaluator	back to summary
protected final WorkbookEvaluator _bookEvaluator

BaseFormulaEvaluator	back to summary
protected BaseFormulaEvaluator(WorkbookEvaluator bookEvaluator)

Method Detail

_getWorkbookEvaluator	back to summary
public WorkbookEvaluator _getWorkbookEvaluator() Implements org.apache.poi.ss.formula.WorkbookEvaluatorProvider._getWorkbookEvaluator. Doc from org.apache.poi.ss.formula.WorkbookEvaluatorProvider._getWorkbookEvaluator. Provide the underlying WorkbookEvaluator Annotations @Override

_getWorkbookEvaluator

back to summary

public WorkbookEvaluator _getWorkbookEvaluator()

Implements org.apache.poi.ss.formula.WorkbookEvaluatorProvider._getWorkbookEvaluator.

Doc from org.apache.poi.ss.formula.WorkbookEvaluatorProvider._getWorkbookEvaluator.

Provide the underlying WorkbookEvaluator

Annotations

@Override

clearAllCachedResultValues	back to summary
public void clearAllCachedResultValues() Implements org.apache.poi.ss.usermodel.FormulaEvaluator.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 Annotations @Override

clearAllCachedResultValues

back to summary

public void clearAllCachedResultValues()

Implements org.apache.poi.ss.usermodel.FormulaEvaluator.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

Annotations

@Override

createRichTextString	back to summary
protected abstract RichTextString createRichTextString(String str)

evaluate back to summary

evaluate	back to summary
public CellValue evaluate(Cell cell) Implements org.apache.poi.ss.usermodel.FormulaEvaluator.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. Parameters cell:Cell may be `null` signifying that the cell is not present (or blank) Returns:CellValue `null` if the supplied cell is `null` or blank Annotations @Override

public CellValue evaluate(Cell cell)

Implements org.apache.poi.ss.usermodel.FormulaEvaluator.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.

Parameters

cell:Cell: may be null signifying that the cell is not present (or blank)

Returns:CellValue

null if the supplied cell is null or blank

Annotations

@Override

evaluateAllFormulaCells	back to summary
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.

evaluateAllFormulaCells

back to summary

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.

evaluateAllFormulaCells	back to summary
protected static void evaluateAllFormulaCells(Workbook wb, FormulaEvaluator evaluator)

evaluateFormulaCell back to summary

evaluateFormulaCell	back to summary
public CellType evaluateFormulaCell(Cell cell) Implements org.apache.poi.ss.usermodel.FormulaEvaluator.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, use `evaluate(org.apache.poi.ss.usermodel.Cell)` } Parameters cell:Cell The cell to evaluate Returns:CellType The type of the formula result (the cell's type remains as CellType.FORMULA however) If cell is not a formula cell, returns `CellType#_NONE` rather than throwing an exception. Annotations @Override

public CellType evaluateFormulaCell(Cell cell)

Implements org.apache.poi.ss.usermodel.FormulaEvaluator.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, use evaluate(org.apache.poi.ss.usermodel.Cell) }

Parameters

cell:Cell: The cell to evaluate

Returns:CellType

The type of the formula result (the cell's type remains as CellType.FORMULA however) If cell is not a formula cell, returns CellType#_NONE rather than throwing an exception.

Annotations

@Override

evaluateFormulaCellValue	back to summary
protected abstract CellValue evaluateFormulaCellValue(Cell cell)

evaluateInCell back to summary

evaluateInCell	back to summary
public Cell evaluateInCell(Cell cell) Implements org.apache.poi.ss.usermodel.FormulaEvaluator.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 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 `evaluateFormulaCell(Cell)`} Parameters cell:Cell The `Cell` to evaluate and modify. Returns:Cell the `cell` that was passed in, allowing for chained calls Annotations @Override

public Cell evaluateInCell(Cell cell)

Implements org.apache.poi.ss.usermodel.FormulaEvaluator.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 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 evaluateFormulaCell(Cell)}

Parameters

cell:Cell: The Cell to evaluate and modify.

Returns:Cell

the cell that was passed in, allowing for chained calls

Annotations

@Override

getEvaluationWorkbook	back to summary
protected EvaluationWorkbook getEvaluationWorkbook() internal use Returns:EvaluationWorkbook evaluation workbook

getEvaluationWorkbook

back to summary

protected EvaluationWorkbook getEvaluationWorkbook()

internal use

Returns:EvaluationWorkbook: evaluation workbook

setCellType	back to summary
protected void setCellType(Cell cell, CellValue cv) Set the cell type based on the computed cell type as part of a formula evaluation. Parameters cell:Cell The Cell to populate cv:CellValue The CellValue to read the result type from

setCellType

back to summary

protected void setCellType(Cell cell, CellValue cv)

Set the cell type based on the computed cell type as part of a formula evaluation.

Parameters

cell:Cell: The Cell to populate
cv:CellValue: The CellValue to read the result type from

setCellType	back to summary
protected void setCellType(Cell cell, CellType cellType) Override if a different variation is needed, e.g. passing the evaluator to the cell method Parameters cell:Cell The Cell to populate cellType:CellType The wanted type for this Cell

setCellType

back to summary

protected void setCellType(Cell cell, CellType cellType)

Override if a different variation is needed, e.g. passing the evaluator to the cell method

Parameters

cell:Cell: The Cell to populate
cellType:CellType: The wanted type for this Cell

setCellValue	back to summary
protected void setCellValue(Cell cell, CellValue cv)

setDebugEvaluationOutputForNextEval	back to summary
public void setDebugEvaluationOutputForNextEval(boolean value) Implements org.apache.poi.ss.usermodel.FormulaEvaluator.setDebugEvaluationOutputForNextEval. Doc from org.apache.poi.ss.usermodel.FormulaEvaluator.setDebugEvaluationOutputForNextEval. 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. Parameters value:boolean whether to perform detailed output Annotations @Override

setDebugEvaluationOutputForNextEval

back to summary

public void setDebugEvaluationOutputForNextEval(boolean value)

Implements org.apache.poi.ss.usermodel.FormulaEvaluator.setDebugEvaluationOutputForNextEval.

Doc from org.apache.poi.ss.usermodel.FormulaEvaluator.setDebugEvaluationOutputForNextEval.

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.

Parameters

value:boolean: whether to perform detailed output

Annotations

@Override

setIgnoreMissingWorkbooks back to summary

setIgnoreMissingWorkbooks	back to summary
public void setIgnoreMissingWorkbooks(boolean ignore) Implements org.apache.poi.ss.usermodel.FormulaEvaluator.setIgnoreMissingWorkbooks. Doc from org.apache.poi.ss.usermodel.FormulaEvaluator.setIgnoreMissingWorkbooks. 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 `org.apache.poi.ss.formula.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 Parameters ignore:boolean whether to ignore missing references to external workbooks Annotations @Override

public void setIgnoreMissingWorkbooks(boolean ignore)

Implements org.apache.poi.ss.usermodel.FormulaEvaluator.setIgnoreMissingWorkbooks.

Doc from org.apache.poi.ss.usermodel.FormulaEvaluator.setIgnoreMissingWorkbooks.

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 org.apache.poi.ss.formula.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

Parameters

ignore:boolean: whether to ignore missing references to external workbooks

Annotations

@Override

setupEnvironment	back to summary
public static void setupEnvironment(String[] workbookNames, BaseFormulaEvaluator[] evaluators) Coordinates several formula evaluators together so that formulas that involve external references can be evaluated. Parameters workbookNames:String[] 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:BaseFormulaEvaluator[] all evaluators for the full set of workbooks required by the formulas.

setupEnvironment

back to summary

public static void setupEnvironment(String[] workbookNames, BaseFormulaEvaluator[] evaluators)

Coordinates several formula evaluators together so that formulas that involve external references can be evaluated.

Parameters

workbookNames:String[]: 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:BaseFormulaEvaluator[]: all evaluators for the full set of workbooks required by the formulas.

setupReferencedWorkbooks	back to summary
public void setupReferencedWorkbooks(Map<String, FormulaEvaluator> evaluators) Implements org.apache.poi.ss.usermodel.FormulaEvaluator.setupReferencedWorkbooks. Doc from org.apache.poi.ss.usermodel.FormulaEvaluator.setupReferencedWorkbooks. 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. Parameters evaluators:Map<String, FormulaEvaluator> Map of workbook names (no square brackets) to an evaluator on that workbook Annotations @Override

setupReferencedWorkbooks

back to summary

public void setupReferencedWorkbooks(Map<String, FormulaEvaluator> evaluators)

Implements org.apache.poi.ss.usermodel.FormulaEvaluator.setupReferencedWorkbooks.

Doc from org.apache.poi.ss.usermodel.FormulaEvaluator.setupReferencedWorkbooks.

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.

Parameters

evaluators:Map<String, FormulaEvaluator>: Map of workbook names (no square brackets) to an evaluator on that workbook

Annotations

@Override

public abstract Class BaseFormulaEvaluator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail