Top Description Fields Constructors Methods
org.apache.poi.ss.formula

public final Class CacheAreaEval

extends AreaEvalBase
Class Inheritance
Imports
org.apache.poi.ss.formula.eval.AreaEval, .AreaEvalBase, .BlankEval, .ValueEval, org.apache.poi.ss.formula.ptg.AreaI, .AreaI.OffsetArea, org.apache.poi.ss.util.CellReference
Provides holding structure for temporary values in arrays during the evaluation process. As such, Row/Column references do not actually correspond to data in the file.

Field Summary

Modifier and TypeField and Description
private final ValueEval[]
_values

Constructor Summary

AccessConstructor and Description
public
CacheAreaEval(AreaI ptg, ValueEval[] values)

public
CacheAreaEval(int firstRow, int firstColumn, int lastRow, int lastColumn, ValueEval[] values)

Method Summary

Modifier and TypeMethod and Description
public TwoDEval
getColumn(int
relative column index (zero based)
columnIndex)

Implements org.apache.poi.ss.formula.TwoDEval.getColumn.

public ValueEval
getRelativeValue(int relativeRowIndex, int relativeColumnIndex)

Implements abstract org.apache.poi.ss.formula.eval.AreaEvalBase.getRelativeValue.

Implements org.apache.poi.ss.formula.eval.AreaEval.getRelativeValue.

public ValueEval
getRelativeValue(int sheetIndex, int relativeRowIndex, int relativeColumnIndex)

Implements abstract org.apache.poi.ss.formula.eval.AreaEvalBase.getRelativeValue.

public TwoDEval
getRow(int
relative row index (zero based)
rowIndex)

Implements org.apache.poi.ss.formula.TwoDEval.getRow.

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

Implements org.apache.poi.ss.formula.eval.AreaEval.offset.

Creates an AreaEval offset by a relative amount from the upper left cell of this area

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from org.apache.poi.ss.formula.eval.AreaEvalBase:
containscontainsColumncontainsRowgetAbsoluteValuegetFirstColumngetFirstRowgetFirstSheetIndexgetHeightgetLastColumngetLastRowgetLastSheetIndexgetValuegetValuegetWidthisColumnisRowisRowHiddenisSubTotal

Field Detail

_valuesback to summary
private final ValueEval[] _values

Constructor Detail

CacheAreaEvalback to summary
public CacheAreaEval(AreaI ptg, ValueEval[] values)
CacheAreaEvalback to summary
public CacheAreaEval(int firstRow, int firstColumn, int lastRow, int lastColumn, ValueEval[] values)

Method Detail

getColumnback to summary
public TwoDEval getColumn(int columnIndex)

Implements org.apache.poi.ss.formula.TwoDEval.getColumn.

Parameters
columnIndex:int

Doc from org.apache.poi.ss.formula.TwoDEval.getColumn.

relative column index (zero based)

Returns:TwoDEval

Doc from org.apache.poi.ss.formula.TwoDEval.getColumn.

a single column TwoDEval

Annotations
@Override
getRelativeValueback to summary
public ValueEval getRelativeValue(int relativeRowIndex, int relativeColumnIndex)

Implements abstract org.apache.poi.ss.formula.eval.AreaEvalBase.getRelativeValue.

Implements org.apache.poi.ss.formula.eval.AreaEval.getRelativeValue.

Returns:ValueEval

Doc from org.apache.poi.ss.formula.eval.AreaEval.getRelativeValue.

the ValueEval from within this area at the specified relativeRowIndex and relativeColumnIndex. Never null (possibly BlankEval). The specified indexes should relative to the top left corner of this area.

Annotations
@Override
getRelativeValueback to summary
public ValueEval getRelativeValue(int sheetIndex, int relativeRowIndex, int relativeColumnIndex)

Implements abstract org.apache.poi.ss.formula.eval.AreaEvalBase.getRelativeValue.

Annotations
@Override
getRowback to summary
public TwoDEval getRow(int rowIndex)

Implements org.apache.poi.ss.formula.TwoDEval.getRow.

Parameters
rowIndex:int

Doc from org.apache.poi.ss.formula.TwoDEval.getRow.

relative row index (zero based)

Returns:TwoDEval

Doc from org.apache.poi.ss.formula.TwoDEval.getRow.

a single row TwoDEval

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

Implements org.apache.poi.ss.formula.eval.AreaEval.offset.

Doc from org.apache.poi.ss.formula.eval.AreaEval.offset.

Creates an AreaEval offset by a relative amount from the upper left cell of this area

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object