Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hssf » usermodel » [javadoc | source]
org.apache.poi.hssf.usermodel
public class: HSSFFormulaEvaluator [javadoc | source]
java.lang.Object
   org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator
Nested Class Summary:
public static final class  HSSFFormulaEvaluator.CellValue  Mimics the 'data view' of a cell. This allows formula evaluator to return a CellValue instead of precasting the value to String or Number or boolean type. 
Field Summary
protected  HSSFRow row     
protected  HSSFSheet sheet     
protected  HSSFWorkbook workbook     
Constructor:
 public HSSFFormulaEvaluator(HSSFSheet sheet,
    HSSFWorkbook workbook) 
Method from org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator Summary:
evaluate,   evaluateAllFormulaCells,   evaluateArea3dPtg,   evaluateAreaPtg,   evaluateFormulaCell,   evaluateInCell,   getCellValueForEval,   getEvalForCell,   getEvalForPtg,   getUnderlyingParser,   inspectPtgs,   setCurrentRow
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator Detail:
 public HSSFFormulaEvaluator.CellValue evaluate(HSSFCell 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.
 public static  void evaluateAllFormulaCells(HSSFWorkbook 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.
 public static AreaEval evaluateArea3dPtg(HSSFWorkbook workbook,
    Area3DPtg a3dp) 
 public static AreaEval evaluateAreaPtg(HSSFSheet sheet,
    HSSFWorkbook workbook,
    AreaPtg ap) 
 public int evaluateFormulaCell(HSSFCell 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)
 public HSSFCell evaluateInCell(HSSFCell 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)
 protected static HSSFFormulaEvaluator.CellValue getCellValueForEval(ValueEval eval) 
    Returns a CellValue wrapper around the supplied ValueEval instance.
 protected static ValueEval getEvalForCell(HSSFCell cell,
    HSSFRow row,
    HSSFSheet sheet,
    HSSFWorkbook 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.
 protected static Eval getEvalForPtg(Ptg ptg) 
    returns an appropriate Eval impl instance for the Ptg. The Ptg must be one of: Area3DPtg, AreaPtg, ReferencePtg, Ref3DPtg, IntPtg, NumberPtg, StringPtg, BoolPtg
    special Note: OperationPtg subtypes cannot be passed here!
 public static FormulaParser getUnderlyingParser(HSSFWorkbook workbook,
    String formula) 
    Returns an underlying FormulaParser, for the specified Formula String and HSSFWorkbook. This will allow you to generate the Ptgs yourself, if your needs are more complex than just having the formula evaluated.
  void inspectPtgs(String formula) 
    debug method
 public  void setCurrentRow(HSSFRow row)