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
ConstructorsModifierConstructorDescriptionprotectedAreaEvalBase(int firstRow, int firstColumn, int lastRow, int lastColumn) protectedAreaEvalBase(AreaI ptg) protectedAreaEvalBase(AreaI ptg, SheetRange sheets) protectedAreaEvalBase(SheetRange sheets, int firstRow, int firstColumn, int lastRow, int lastColumn) -
Method Summary
Modifier and TypeMethodDescriptionfinal booleancontains(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 booleancontainsColumn(int col) returns true if the specified col is in rangefinal booleancontainsRow(int row) returns true if the specified row is in rangefinal ValueEvalgetAbsoluteValue(int row, int col) final intreturns the 0-based index of the first col in this area.final intreturns the 0-based index of the first row in this area.intintfinal intreturns the 0-based index of the last col in this area.final intreturns the 0-based index of the last row in this area.intabstract ValueEvalgetRelativeValue(int relativeRowIndex, int relativeColumnIndex) abstract ValueEvalgetRelativeValue(int sheetIndex, int relativeRowIndex, int relativeColumnIndex) final ValueEvalgetValue(int row, int col) final ValueEvalgetValue(int sheetIndex, int row, int col) intgetWidth()final booleanisColumn()final booleanisRow()booleanisSubTotal(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:AreaEvalreturns the 0-based index of the first col in this area.- Specified by:
getFirstColumnin interfaceAreaEval
-
getFirstRow
public final int getFirstRow()Description copied from interface:AreaEvalreturns the 0-based index of the first row in this area.- Specified by:
getFirstRowin interfaceAreaEval
-
getLastColumn
public final int getLastColumn()Description copied from interface:AreaEvalreturns the 0-based index of the last col in this area.- Specified by:
getLastColumnin interfaceAreaEval
-
getLastRow
public final int getLastRow()Description copied from interface:AreaEvalreturns the 0-based index of the last row in this area.- Specified by:
getLastRowin interfaceAreaEval
-
getFirstSheetIndex
public int getFirstSheetIndex()- Specified by:
getFirstSheetIndexin interfaceSheetRange
-
getLastSheetIndex
public int getLastSheetIndex()- Specified by:
getLastSheetIndexin interfaceSheetRange
-
getAbsoluteValue
- Specified by:
getAbsoluteValuein 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:AreaEvalreturns 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:AreaEvalreturns true if the specified row is in range- Specified by:
containsRowin interfaceAreaEval
-
containsColumn
public final boolean containsColumn(int col) Description copied from interface:AreaEvalreturns true if the specified col is in range- Specified by:
containsColumnin interfaceAreaEval
-
isColumn
public final boolean isColumn() -
isRow
public final boolean isRow() -
getHeight
public int getHeight() -
getValue
-
getValue
- Specified by:
getValuein 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:
getRelativeValuein 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:
isSubTotalin interfaceTwoDEval- Returns:
- whether cell at rowIndex and columnIndex is a subtotal. By default return false which means 'don't care about subtotals'
-