org.apache.poi.hssf.record.formula.eval
Interface RefEval

All Superinterfaces:
Eval, ValueEval
All Known Implementing Classes:
Ref2DEval, Ref3DEval

public interface RefEval
extends ValueEval

Author:
Amol S Deshmukh < amolweb at ya hoo dot com > RefEval is the super interface for Ref2D and Ref3DEval. Basically a RefEval impl should contain reference to the original ReferencePtg or Ref3DPtg as well as the final "value" resulting from the evaluation of the cell reference. Thus if the HSSFCell has type CELL_TYPE_NUMERIC, the contained value object should be of type NumberEval; if cell type is CELL_TYPE_STRING, contained value object should be of type StringEval

Method Summary
 short getColumn()
          returns the column index.
 ValueEval getInnerValueEval()
          The (possibly evaluated) ValueEval contained in this RefEval.
 short getRow()
          returns the row index.
 boolean isEvaluated()
          returns true if this RefEval contains an evaluated value instead of a direct value.
 

Method Detail

getInnerValueEval

ValueEval getInnerValueEval()
The (possibly evaluated) ValueEval contained in this RefEval. eg. if cell A1 contains "test" then in a formula referring to cell A1 the RefEval representing A1 will return as the getInnerValueEval() the object of concrete type StringEval


getColumn

short getColumn()
returns the column index.


getRow

short getRow()
returns the row index.


isEvaluated

boolean isEvaluated()
returns true if this RefEval contains an evaluated value instead of a direct value. eg. say cell A1 has the value: ="test" Then the RefEval representing A1 will return isEvaluated() equal to false. On the other hand, say cell A1 has the value: =B1 and B1 has the value "test", then the RefEval representing A1 will return isEvaluated() equal to true.



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