Package org.apache.poi.ss.formula.eval
Class AreaEvalBase
java.lang.Object
org.apache.poi.ss.formula.eval.AreaEvalBase
- All Implemented Interfaces:
AreaEval
,ValueEval
,SheetRange
,ThreeDEval
,TwoDEval
- Direct Known Subclasses:
CacheAreaEval
- Author:
- Josh Micich
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
AreaEvalBase
(int firstRow, int firstColumn, int lastRow, int lastColumn) protected
AreaEvalBase
(AreaI ptg) protected
AreaEvalBase
(AreaI ptg, SheetRange sheets) protected
AreaEvalBase
(SheetRange sheets, int firstRow, int firstColumn, int lastRow, int lastColumn) -
Method Summary
Modifier and TypeMethodDescriptionfinal boolean
contains
(int row, int col) returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area.final boolean
containsColumn
(int col) returns true if the specified col is in rangefinal boolean
containsRow
(int row) returns true if the specified row is in rangefinal ValueEval
getAbsoluteValue
(int row, int col) final int
returns the 0-based index of the first col in this area.final int
returns the 0-based index of the first row in this area.int
int
final int
returns the 0-based index of the last col in this area.final int
returns the 0-based index of the last row in this area.int
abstract ValueEval
getRelativeValue
(int relativeRowIndex, int relativeColumnIndex) abstract ValueEval
getRelativeValue
(int sheetIndex, int relativeRowIndex, int relativeColumnIndex) final ValueEval
getValue
(int row, int col) final ValueEval
getValue
(int sheetIndex, int row, int col) int
getWidth()
final boolean
isColumn()
final boolean
isRow()
boolean
isSubTotal
(int rowIndex, int columnIndex)
-
Constructor Details
-
AreaEvalBase
protected AreaEvalBase(SheetRange sheets, int firstRow, int firstColumn, int lastRow, int lastColumn) -
AreaEvalBase
protected AreaEvalBase(int firstRow, int firstColumn, int lastRow, int lastColumn) -
AreaEvalBase
-
AreaEvalBase
-
-
Method Details
-
getFirstColumn
public final int getFirstColumn()Description copied from interface:AreaEval
returns the 0-based index of the first col in this area.- Specified by:
getFirstColumn
in interfaceAreaEval
-
getFirstRow
public final int getFirstRow()Description copied from interface:AreaEval
returns the 0-based index of the first row in this area.- Specified by:
getFirstRow
in interfaceAreaEval
-
getLastColumn
public final int getLastColumn()Description copied from interface:AreaEval
returns the 0-based index of the last col in this area.- Specified by:
getLastColumn
in interfaceAreaEval
-
getLastRow
public final int getLastRow()Description copied from interface:AreaEval
returns the 0-based index of the last row in this area.- Specified by:
getLastRow
in interfaceAreaEval
-
getFirstSheetIndex
public int getFirstSheetIndex()- Specified by:
getFirstSheetIndex
in interfaceSheetRange
-
getLastSheetIndex
public int getLastSheetIndex()- Specified by:
getLastSheetIndex
in interfaceSheetRange
-
getAbsoluteValue
- Specified by:
getAbsoluteValue
in interfaceAreaEval
- Returns:
- the ValueEval from within this area at the specified row and col index. Never
null
(possiblyBlankEval
). The specified indexes should be absolute indexes in the sheet and not relative indexes within the area.
-
contains
public final boolean contains(int row, int col) Description copied from interface:AreaEval
returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area. -
containsRow
public final boolean containsRow(int row) Description copied from interface:AreaEval
returns true if the specified row is in range- Specified by:
containsRow
in interfaceAreaEval
-
containsColumn
public final boolean containsColumn(int col) Description copied from interface:AreaEval
returns true if the specified col is in range- Specified by:
containsColumn
in interfaceAreaEval
-
isColumn
public final boolean isColumn() -
isRow
public final boolean isRow() -
getHeight
public int getHeight() -
getValue
-
getValue
- Specified by:
getValue
in interfaceThreeDEval
- Parameters:
sheetIndex
- sheet index (zero based)row
- relative row index (zero based)col
- relative column index (zero based)- Returns:
- element at the specified row and column position
-
getRelativeValue
- Specified by:
getRelativeValue
in interfaceAreaEval
- Returns:
- the ValueEval from within this area at the specified relativeRowIndex and
relativeColumnIndex. Never
null
(possiblyBlankEval
). The specified indexes should relative to the top left corner of this area.
-
getRelativeValue
public abstract ValueEval getRelativeValue(int sheetIndex, int relativeRowIndex, int relativeColumnIndex) -
getWidth
public int getWidth() -
isSubTotal
public boolean isSubTotal(int rowIndex, int columnIndex) - Specified by:
isSubTotal
in interfaceTwoDEval
- Returns:
- whether cell at rowIndex and columnIndex is a subtotal. By default return false which means 'don't care about subtotals'
-