org.apache.poi.ss.formula
Interface TwoDEval

All Superinterfaces:

ValueEval

All Known Subinterfaces:

AreaEval, ThreeDEval

All Known Implementing Classes:

AreaEvalBase

public interface TwoDEval
extends ValueEval

Common interface of AreaEval and AreaEvalBase, for 2D (row+column) evaluations

getValue

ValueEval getValue(int rowIndex,
                   int columnIndex)

Parameters:

rowIndex - relative row index (zero based)

columnIndex - relative column index (zero based)

Returns:

element at the specified row and column position

getWidth

int getWidth()

getHeight

int getHeight()

isRow

boolean isRow()

Returns:

true if the area has just a single row, this also includes the trivial case when the area has just a single cell.

isColumn

boolean isColumn()

Returns:

true if the area has just a single column, this also includes the trivial case when the area has just a single cell.

getRow

TwoDEval getRow(int rowIndex)

Parameters:

rowIndex - relative row index (zero based)

Returns:

a single row TwoDEval

getColumn

TwoDEval getColumn(int columnIndex)

Parameters:

columnIndex - relative column index (zero based)

Returns:

a single column TwoDEval

isSubTotal

boolean isSubTotal(int rowIndex,
                   int columnIndex)

Returns:

true if the cell at row and col is a subtotal