Apache POI - Common 5.3.0 · org.apache.poi.ss.formula.eval.AreaEvalBase

Modifier and Type	Field and Description
private final int	_firstColumn
private final int	_firstRow
private final int	_firstSheet
private final int	_lastColumn
private final int	_lastRow
private final int	_lastSheet
private final int	_nColumns
private final int	_nRows

Access	Constructor and Description
protected	AreaEvalBase(SheetRange sheets, int firstRow, int firstColumn, int lastRow, int lastColumn)
protected	AreaEvalBase(int firstRow, int firstColumn, int lastRow, int lastColumn)
protected	AreaEvalBase(AreaI ptg)
protected	AreaEvalBase(AreaI ptg, SheetRange sheets)

Method Summary

Modifier and Type	Method and Description
public final boolean	contains(int row, int col) Implements org.apache.poi.ss.formula.eval.AreaEval.contains. returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area.
public final boolean	containsColumn(int col) Implements org.apache.poi.ss.formula.eval.AreaEval.containsColumn. returns true if the specified col is in range
public final boolean	containsRow(int row) Implements org.apache.poi.ss.formula.eval.AreaEval.containsRow. returns true if the specified row is in range
public final ValueEval	getAbsoluteValue(int row, int col) Implements org.apache.poi.ss.formula.eval.AreaEval.getAbsoluteValue.
public final int	getFirstColumn() Implements org.apache.poi.ss.formula.eval.AreaEval.getFirstColumn. returns the 0-based index of the first col in this area.
public final int	getFirstRow() Implements org.apache.poi.ss.formula.eval.AreaEval.getFirstRow. returns the 0-based index of the first row in this area.
public int	getFirstSheetIndex() Implements org.apache.poi.ss.formula.SheetRange.getFirstSheetIndex.
public int	getHeight() Implements org.apache.poi.ss.formula.eval.AreaEval.getHeight.
public final int	getLastColumn() Implements org.apache.poi.ss.formula.eval.AreaEval.getLastColumn. returns the 0-based index of the last col in this area.
public final int	getLastRow() Implements org.apache.poi.ss.formula.eval.AreaEval.getLastRow. returns the 0-based index of the last row in this area.
public int	getLastSheetIndex() Implements org.apache.poi.ss.formula.SheetRange.getLastSheetIndex.
public abstract ValueEval	getRelativeValue(int relativeRowIndex, int relativeColumnIndex) Redeclares org.apache.poi.ss.formula.eval.AreaEval.getRelativeValue.
public abstract ValueEval	getRelativeValue(int sheetIndex, int relativeRowIndex, int relativeColumnIndex)
public final ValueEval	getValue(int relative row index (zero based) row, int relative column index (zero based) col) Implements org.apache.poi.ss.formula.TwoDEval.getValue.
public final ValueEval	getValue(int sheet index (zero based) sheetIndex, int relative row index (zero based) row, int relative column index (zero based) col) Implements org.apache.poi.ss.formula.ThreeDEval.getValue.
public int	getWidth() Implements org.apache.poi.ss.formula.eval.AreaEval.getWidth.
public final boolean	isColumn() Implements org.apache.poi.ss.formula.TwoDEval.isColumn.
public final boolean	isRow() Overrides default org.apache.poi.ss.formula.TwoDEval.isRow.
public boolean	Returns: false by default, meaning all rows are calculated isRowHidden(int rowIndex) Implements org.apache.poi.ss.formula.TwoDEval.isRowHidden.
public boolean	Returns: whether cell at rowIndex and columnIndex is a subtotal. By default return false which means 'don't care about subtotals' isSubTotal(int rowIndex, int columnIndex) Implements org.apache.poi.ss.formula.TwoDEval.isSubTotal.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

_firstColumn	back to summary
private final int _firstColumn

_firstRow	back to summary
private final int _firstRow

_firstSheet	back to summary
private final int _firstSheet

_lastColumn	back to summary
private final int _lastColumn

_lastRow	back to summary
private final int _lastRow

_lastSheet	back to summary
private final int _lastSheet

_nColumns	back to summary
private final int _nColumns

_nRows	back to summary
private final int _nRows

AreaEvalBase	back to summary
protected AreaEvalBase(SheetRange sheets, int firstRow, int firstColumn, int lastRow, int lastColumn)

AreaEvalBase	back to summary
protected AreaEvalBase(int firstRow, int firstColumn, int lastRow, int lastColumn)

AreaEvalBase	back to summary
protected AreaEvalBase(AreaI ptg)

AreaEvalBase	back to summary
protected AreaEvalBase(AreaI ptg, SheetRange sheets)

Method Detail

contains	back to summary
public final boolean contains(int row, int col) Implements org.apache.poi.ss.formula.eval.AreaEval.contains. Doc from org.apache.poi.ss.formula.eval.AreaEval.contains. returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area. Annotations @Override

contains

back to summary

public final boolean contains(int row, int col)

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

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

returns true if the cell at row and col specified as absolute indexes in the sheet is contained in this area.

Annotations

@Override

containsColumn	back to summary
public final boolean containsColumn(int col) Implements org.apache.poi.ss.formula.eval.AreaEval.containsColumn. Doc from org.apache.poi.ss.formula.eval.AreaEval.containsColumn. returns true if the specified col is in range Annotations @Override

containsColumn

back to summary

public final boolean containsColumn(int col)

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

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

returns true if the specified col is in range

Annotations

@Override

containsRow	back to summary
public final boolean containsRow(int row) Implements org.apache.poi.ss.formula.eval.AreaEval.containsRow. Doc from org.apache.poi.ss.formula.eval.AreaEval.containsRow. returns true if the specified row is in range Annotations @Override

containsRow

back to summary

public final boolean containsRow(int row)

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

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

returns true if the specified row is in range

Annotations

@Override

getAbsoluteValue back to summary

getAbsoluteValue	back to summary
public final ValueEval getAbsoluteValue(int row, int col) Implements org.apache.poi.ss.formula.eval.AreaEval.getAbsoluteValue. Returns:ValueEval Doc from org.apache.poi.ss.formula.eval.AreaEval.getAbsoluteValue. the ValueEval from within this area at the specified row and col index. Never `null` (possibly `BlankEval`). The specified indexes should be absolute indexes in the sheet and not relative indexes within the area. Annotations @Override

public final ValueEval getAbsoluteValue(int row, int col)

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

Returns:ValueEval

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

the ValueEval from within this area at the specified row and col index. Never null (possibly BlankEval). The specified indexes should be absolute indexes in the sheet and not relative indexes within the area.

Annotations

@Override

getFirstColumn	back to summary
public final int getFirstColumn() Implements org.apache.poi.ss.formula.eval.AreaEval.getFirstColumn. Doc from org.apache.poi.ss.formula.eval.AreaEval.getFirstColumn. returns the 0-based index of the first col in this area. Annotations @Override

getFirstColumn

back to summary

public final int getFirstColumn()

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

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

returns the 0-based index of the first col in this area.

Annotations

@Override

getFirstRow	back to summary
public final int getFirstRow() Implements org.apache.poi.ss.formula.eval.AreaEval.getFirstRow. Doc from org.apache.poi.ss.formula.eval.AreaEval.getFirstRow. returns the 0-based index of the first row in this area. Annotations @Override

getFirstRow

back to summary

public final int getFirstRow()

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

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

returns the 0-based index of the first row in this area.

Annotations

@Override

getFirstSheetIndex	back to summary
public int getFirstSheetIndex() Implements org.apache.poi.ss.formula.SheetRange.getFirstSheetIndex. Annotations @Override

getFirstSheetIndex

back to summary

public int getFirstSheetIndex()

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

Annotations

@Override

getHeight	back to summary
public int getHeight() Implements org.apache.poi.ss.formula.eval.AreaEval.getHeight. Annotations @Override

getHeight

back to summary

public int getHeight()

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

Annotations

@Override

getLastColumn	back to summary
public final int getLastColumn() Implements org.apache.poi.ss.formula.eval.AreaEval.getLastColumn. Doc from org.apache.poi.ss.formula.eval.AreaEval.getLastColumn. returns the 0-based index of the last col in this area. Annotations @Override

getLastColumn

back to summary

public final int getLastColumn()

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

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

returns the 0-based index of the last col in this area.

Annotations

@Override

getLastRow	back to summary
public final int getLastRow() Implements org.apache.poi.ss.formula.eval.AreaEval.getLastRow. Doc from org.apache.poi.ss.formula.eval.AreaEval.getLastRow. returns the 0-based index of the last row in this area. Annotations @Override

getLastRow

back to summary

public final int getLastRow()

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

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

returns the 0-based index of the last row in this area.

Annotations

@Override

getLastSheetIndex	back to summary
public int getLastSheetIndex() Implements org.apache.poi.ss.formula.SheetRange.getLastSheetIndex. Annotations @Override

getLastSheetIndex

back to summary

public int getLastSheetIndex()

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

Annotations

@Override

getRelativeValue back to summary

getRelativeValue	back to summary
public abstract ValueEval getRelativeValue(int relativeRowIndex, int relativeColumnIndex) Redeclares 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

public abstract ValueEval getRelativeValue(int relativeRowIndex, int relativeColumnIndex)

Redeclares 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

getRelativeValue	back to summary
public abstract ValueEval getRelativeValue(int sheetIndex, int relativeRowIndex, int relativeColumnIndex)

getValue	back to summary
public final ValueEval getValue(int row, int col) Implements org.apache.poi.ss.formula.TwoDEval.getValue. Parameters row:int Doc from org.apache.poi.ss.formula.TwoDEval.getValue. relative row index (zero based) col:int Doc from org.apache.poi.ss.formula.TwoDEval.getValue. relative column index (zero based) Returns:ValueEval Doc from org.apache.poi.ss.formula.TwoDEval.getValue. element at the specified row and column position Annotations @Override

getValue

back to summary

public final ValueEval getValue(int row, int col)

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

Parameters

row:int

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

relative row index (zero based)

col:int

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

relative column index (zero based)

Returns:ValueEval

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

element at the specified row and column position

Annotations

@Override

getValue	back to summary
public final ValueEval getValue(int sheetIndex, int row, int col) Implements org.apache.poi.ss.formula.ThreeDEval.getValue. Parameters sheetIndex:int Doc from org.apache.poi.ss.formula.ThreeDEval.getValue. sheet index (zero based) row:int Doc from org.apache.poi.ss.formula.ThreeDEval.getValue. relative row index (zero based) col:int Doc from org.apache.poi.ss.formula.ThreeDEval.getValue. relative column index (zero based) Returns:ValueEval Doc from org.apache.poi.ss.formula.ThreeDEval.getValue. element at the specified row and column position Annotations @Override

getValue

back to summary

public final ValueEval getValue(int sheetIndex, int row, int col)

Implements org.apache.poi.ss.formula.ThreeDEval.getValue.

Parameters

sheetIndex:int

Doc from org.apache.poi.ss.formula.ThreeDEval.getValue.

sheet index (zero based)

row:int

Doc from org.apache.poi.ss.formula.ThreeDEval.getValue.

relative row index (zero based)

col:int

Doc from org.apache.poi.ss.formula.ThreeDEval.getValue.

relative column index (zero based)

Returns:ValueEval

Doc from org.apache.poi.ss.formula.ThreeDEval.getValue.

element at the specified row and column position

Annotations

@Override

getWidth	back to summary
public int getWidth() Implements org.apache.poi.ss.formula.eval.AreaEval.getWidth. Annotations @Override

getWidth

back to summary

public int getWidth()

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

Annotations

@Override

isColumn back to summary

isColumn	back to summary
public final boolean isColumn() Implements org.apache.poi.ss.formula.TwoDEval.isColumn. Returns:boolean Doc from org.apache.poi.ss.formula.TwoDEval.isColumn. `true` if the area has just a single column, this also includes the trivial case when the area has just a single cell. Annotations @Override

public final boolean isColumn()

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

Returns:boolean

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

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

Annotations

@Override

isRow back to summary

isRow	back to summary
public final boolean isRow() Overrides default org.apache.poi.ss.formula.TwoDEval.isRow. Returns:boolean Doc from org.apache.poi.ss.formula.TwoDEval.isRow. `true` if the area has just a single row, this also includes the trivial case when the area has just a single cell. Annotations @Override

public final boolean isRow()

Overrides default org.apache.poi.ss.formula.TwoDEval.isRow.

Returns:boolean

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

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

Annotations

@Override

isRowHidden back to summary

isRowHidden	back to summary
public boolean isRowHidden(int rowIndex) Implements org.apache.poi.ss.formula.TwoDEval.isRowHidden. Returns:boolean false by default, meaning all rows are calculated Annotations @Override See Also `org.apache.poi.ss.formula.TwoDEval#isRowHidden(int)`

public boolean isRowHidden(int rowIndex)

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

Returns:boolean

false by default, meaning all rows are calculated

Annotations

@Override

isSubTotal	back to summary
public boolean isSubTotal(int rowIndex, int columnIndex) Implements org.apache.poi.ss.formula.TwoDEval.isSubTotal. Returns:boolean whether cell at rowIndex and columnIndex is a subtotal. By default return false which means 'don't care about subtotals' Annotations @Override

isSubTotal

back to summary

public boolean isSubTotal(int rowIndex, int columnIndex)

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

Returns:boolean

whether cell at rowIndex and columnIndex is a subtotal. By default return false which means 'don't care about subtotals'

Annotations

@Override

public abstract Class AreaEvalBase

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail