Top Description Methods
org.apache.poi.ss.formula.eval

public Interface RefEval

extends ValueEval, SheetRange
Known Direct Implementers
org.apache.poi.ss.formula.eval.RefEvalBase
Imports
org.apache.poi.ss.formula.SheetRange, org.apache.poi.ss.usermodel.CellType
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 Cell has type CellType#NUMERIC, the contained value object should be of type NumberEval; if cell type is CellType#STRING, contained value object should be of type StringEval

Method Summary

Modifier and TypeMethod and Description
public int
getColumn()

returns the zero based column index.

public int
getFirstSheetIndex()

Redeclares org.apache.poi.ss.formula.SheetRange.getFirstSheetIndex.

returns the first sheet index this applies to

public ValueEval

Returns:

the evaluated value of the cell referred to by this RefEval on the given sheet
getInnerValueEval(int sheetIndex)

public int
getLastSheetIndex()

Redeclares org.apache.poi.ss.formula.SheetRange.getLastSheetIndex.

returns the last sheet index this applies to, which will be the same as the first for a 2D and many 3D references

public int
getNumberOfSheets()

returns the number of sheets this applies to

public int
getRow()

returns the zero based row index.

public AreaEval
offset(int relFirstRowIx, int relLastRowIx, int relFirstColIx, int relLastColIx)

Creates an AreaEval offset by a relative amount from this RefEval

Method Detail

getColumnback to summary
public int getColumn()

returns the zero based column index.

getFirstSheetIndexback to summary
public int getFirstSheetIndex()

Redeclares org.apache.poi.ss.formula.SheetRange.getFirstSheetIndex.

returns the first sheet index this applies to

getInnerValueEvalback to summary
public ValueEval getInnerValueEval(int sheetIndex)
Returns:ValueEval

the evaluated value of the cell referred to by this RefEval on the given sheet

getLastSheetIndexback to summary
public int getLastSheetIndex()

Redeclares org.apache.poi.ss.formula.SheetRange.getLastSheetIndex.

returns the last sheet index this applies to, which will be the same as the first for a 2D and many 3D references

getNumberOfSheetsback to summary
public int getNumberOfSheets()

returns the number of sheets this applies to

getRowback to summary
public int getRow()

returns the zero based row index.

offsetback to summary
public AreaEval offset(int relFirstRowIx, int relLastRowIx, int relFirstColIx, int relLastColIx)

Creates an AreaEval offset by a relative amount from this RefEval