org.apache.poi.ss.usermodel
Class FormulaEvaluator

java.lang.Object
  extended by org.apache.poi.ss.usermodel.FormulaEvaluator
Direct Known Subclasses:
HSSFFormulaEvaluator

public class FormulaEvaluator
extends java.lang.Object

Author:
Amol S. Deshmukh < amolweb at ya hoo dot com >

Nested Class Summary
static class FormulaEvaluator.CellValue
          Mimics the 'data view' of a cell.
 
Field Summary
protected  org.apache.poi.ss.usermodel.Row row
           
protected  org.apache.poi.ss.usermodel.Sheet sheet
           
protected  org.apache.poi.ss.usermodel.Workbook workbook
           
 
Constructor Summary
FormulaEvaluator(org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.usermodel.Workbook workbook)
           
 
Method Summary
 FormulaEvaluator.CellValue evaluate(org.apache.poi.ss.usermodel.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.
static void evaluateAllFormulaCells(org.apache.poi.ss.usermodel.Workbook wb)
          Loops over all cells in all sheets of the supplied workbook.
static AreaEval evaluateArea3dPtg(org.apache.poi.ss.usermodel.Workbook workbook, Area3DPtg a3dp)
           
static AreaEval evaluateAreaPtg(org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.usermodel.Workbook workbook, AreaPtg ap)
           
 int evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell cell)
          If cell contains formula, it evaluates the formula, and saves the result of the formula.
 org.apache.poi.ss.usermodel.Cell evaluateInCell(org.apache.poi.ss.usermodel.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 static FormulaEvaluator.CellValue getCellValueForEval(ValueEval eval, org.apache.poi.ss.usermodel.CreationHelper cHelper)
          Returns a CellValue wrapper around the supplied ValueEval instance.
protected static ValueEval getEvalForCell(org.apache.poi.ss.usermodel.Cell cell, org.apache.poi.ss.usermodel.Row row, org.apache.poi.ss.usermodel.Sheet sheet, org.apache.poi.ss.usermodel.Workbook workbook)
          Given a cell, find its type and from that create an appropriate ValueEval impl instance and return that.
protected static Eval getEvalForPtg(Ptg ptg)
          returns an appropriate Eval impl instance for the Ptg.
 void setCurrentRow(org.apache.poi.ss.usermodel.Row row)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

row

protected org.apache.poi.ss.usermodel.Row row

sheet

protected org.apache.poi.ss.usermodel.Sheet sheet

workbook

protected org.apache.poi.ss.usermodel.Workbook workbook
Constructor Detail

FormulaEvaluator

public FormulaEvaluator(org.apache.poi.ss.usermodel.Sheet sheet,
                        org.apache.poi.ss.usermodel.Workbook workbook)
Method Detail

setCurrentRow

public void setCurrentRow(org.apache.poi.ss.usermodel.Row row)

evaluate

public FormulaEvaluator.CellValue evaluate(org.apache.poi.ss.usermodel.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. This method should be preferred over evaluateInCell() when the call should not modify the contents of the original cell.

Parameters:
cell -

evaluateFormulaCell

public int evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell cell)
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.
 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 #evaluateInCell(HSSFCell)

Parameters:
cell - The cell to evaluate
Returns:
The type of the formula result (the cell's type remains as HSSFCell.CELL_TYPE_FORMULA however)

evaluateInCell

public org.apache.poi.ss.usermodel.Cell evaluateInCell(org.apache.poi.ss.usermodel.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. 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 #evaluateFormulaCell(HSSFCell)

Parameters:
cell -

evaluateAllFormulaCells

public static void evaluateAllFormulaCells(org.apache.poi.ss.usermodel.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.


getCellValueForEval

protected static FormulaEvaluator.CellValue getCellValueForEval(ValueEval eval,
                                                                org.apache.poi.ss.usermodel.CreationHelper cHelper)
Returns a CellValue wrapper around the supplied ValueEval instance.

Parameters:
eval -

evaluateAreaPtg

public static AreaEval evaluateAreaPtg(org.apache.poi.ss.usermodel.Sheet sheet,
                                       org.apache.poi.ss.usermodel.Workbook workbook,
                                       AreaPtg ap)

evaluateArea3dPtg

public static AreaEval evaluateArea3dPtg(org.apache.poi.ss.usermodel.Workbook workbook,
                                         Area3DPtg a3dp)

getEvalForPtg

protected static Eval getEvalForPtg(Ptg ptg)
returns an appropriate Eval impl instance for the Ptg. The Ptg must be one of: Area3DPtg, AreaPtg, RefPtg, Ref3DPtg, IntPtg, NumberPtg, StringPtg, BoolPtg
special Note: OperationPtg subtypes cannot be passed here!

Parameters:
ptg -

getEvalForCell

protected static ValueEval getEvalForCell(org.apache.poi.ss.usermodel.Cell cell,
                                          org.apache.poi.ss.usermodel.Row row,
                                          org.apache.poi.ss.usermodel.Sheet sheet,
                                          org.apache.poi.ss.usermodel.Workbook workbook)
Given a cell, find its type and from that create an appropriate ValueEval impl instance and return that. Since the cell could be an external reference, we need the sheet that this belongs to. Non existent cells are treated as empty.

Parameters:
cell -
sheet -
workbook -


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.