|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.xssf.usermodel.XSSFFormulaEvaluator
public class XSSFFormulaEvaluator
Evaluates formula cells.
For performance reasons, this class keeps a cache of all previously calculated intermediate cell values. Be sure to callclearAllCachedResultValues()
if any workbook cells are changed between
calls to evaluate~ methods on this class.
Constructor Summary | |
---|---|
XSSFFormulaEvaluator(XSSFWorkbook workbook)
|
|
XSSFFormulaEvaluator(XSSFWorkbook workbook,
IStabilityClassifier stabilityClassifier)
Deprecated. (Sep 2009) (reduce overloading) use create(XSSFWorkbook, org.apache.poi.ss.formula.IStabilityClassifier, org.apache.poi.ss.formula.udf.UDFFinder) |
Method Summary | |
---|---|
void |
clearAllCachedResultValues()
Should be called whenever there are major changes (e.g. |
static XSSFFormulaEvaluator |
create(XSSFWorkbook workbook,
IStabilityClassifier stabilityClassifier,
UDFFinder udfFinder)
|
CellValue |
evaluate(Cell cell)
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. |
void |
evaluateAll()
Loops over all cells in all sheets of the supplied workbook. |
static void |
evaluateAllFormulaCells(XSSFWorkbook wb)
Loops over all cells in all sheets of the supplied workbook. |
int |
evaluateFormulaCell(Cell cell)
If cell contains formula, it evaluates the formula, and saves the result of the formula. |
XSSFCell |
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 |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public XSSFFormulaEvaluator(XSSFWorkbook workbook)
@Deprecated public XSSFFormulaEvaluator(XSSFWorkbook workbook, IStabilityClassifier stabilityClassifier)
create(XSSFWorkbook, org.apache.poi.ss.formula.IStabilityClassifier, org.apache.poi.ss.formula.udf.UDFFinder)
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 |
---|
public static XSSFFormulaEvaluator create(XSSFWorkbook workbook, IStabilityClassifier stabilityClassifier, UDFFinder udfFinder)
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)public void clearAllCachedResultValues()
clearAllCachedResultValues
in interface FormulaEvaluator
public void notifySetFormula(Cell cell)
FormulaEvaluator
notifySetFormula
in interface FormulaEvaluator
public void notifyDeleteCell(Cell cell)
FormulaEvaluator
notifyDeleteCell
in interface FormulaEvaluator
public void notifyUpdateCell(Cell cell)
FormulaEvaluator
notifyUpdateCell
in interface FormulaEvaluator
public CellValue evaluate(Cell cell)
evaluate
in interface FormulaEvaluator
cell
- public int evaluateFormulaCell(Cell cell)
int 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)
}
evaluateFormulaCell
in interface FormulaEvaluator
cell
- The cell to evaluate
public XSSFCell evaluateInCell(Cell cell)
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(org.apache.poi.ss.usermodel.Cell)
}
evaluateInCell
in interface FormulaEvaluator
cell
- public static void evaluateAllFormulaCells(XSSFWorkbook wb)
public void evaluateAll()
evaluateAll
in interface FormulaEvaluator
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |