org.apache.poi.xssf.usermodel
Class XSSFFormulaEvaluator

java.lang.Object
  org.apache.poi.ss.formula.BaseFormulaEvaluator
      org.apache.poi.xssf.usermodel.BaseXSSFFormulaEvaluator
          org.apache.poi.xssf.usermodel.XSSFFormulaEvaluator

All Implemented Interfaces:

WorkbookEvaluatorProvider, FormulaEvaluator

public final class XSSFFormulaEvaluator
extends BaseXSSFFormulaEvaluator

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.

XSSFFormulaEvaluator

public XSSFFormulaEvaluator(XSSFWorkbook workbook)

XSSFFormulaEvaluator

protected XSSFFormulaEvaluator(XSSFWorkbook workbook,
                               WorkbookEvaluator bookEvaluator)

create

public static XSSFFormulaEvaluator create(XSSFWorkbook workbook,
                                          IStabilityClassifier stabilityClassifier,
                                          UDFFinder udfFinder)

Parameters:

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)

evaluateAllFormulaCells

public static void evaluateAllFormulaCells(XSSFWorkbook 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.

evaluateInCell

public XSSFCell 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 HSSFCell 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.evaluateFormulaCellEnum(Cell)}

Specified by:

evaluateInCell in interface FormulaEvaluator

Overrides:

evaluateInCell in class BaseFormulaEvaluator

Returns:

the cell that was passed in, allowing for chained calls

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.

toEvaluationCell

protected EvaluationCell toEvaluationCell(Cell cell)

Turns a XSSFCell into a XSSFEvaluationCell

Specified by:

toEvaluationCell in class BaseXSSFFormulaEvaluator