File Doc Category Size Date Package
RefEval.java API Doc Apache Poi 3.0.1 2462 Sun Mar 11 12:59:28 GMT 2007 org.apache.poi.hssf.record.formula.eval

RefEval

public interface RefEval implements 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

Fields Summary
Constructors Summary
Methods Summary
public short getColumn()
returns the column index.
return
public org.apache.poi.hssf.record.formula.eval.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
return
public short getRow()
returns the row index.
return
public 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.
return