Module io.github.tonywasher.joceanus.prometheus.sheet.api

Package io.github.tonywasher.joceanus.prometheus.service.sheet

Class PrometheusSheetView

java.lang.Object

io.github.tonywasher.joceanus.prometheus.service.sheet.PrometheusSheetView

public class PrometheusSheetView
extends Object

Represents a view of a range of cells.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusSheetView(PrometheusSheetCell pFirstCell, PrometheusSheetCell pLastCell)	Constructor.
	PrometheusSheetView(PrometheusSheetSheet pSheet, PrometheusSheetCellPosition pFirstCell, PrometheusSheetCellPosition pLastCell)	Constructor.

Method Summary

Modifier and Type	Method	Description
ListIterator<PrometheusSheetCell>	cellIterator(PrometheusSheetRow pRow)	Obtain a cell iterator for non-empty cells in the view and in the row.
protected int	convertRowIndex(int pRowIndex)	Convert Row index.
PrometheusSheetCellPosition	getBaseCell()	Obtain the top left position.
PrometheusSheetCell	getCellByPosition(int pColumnIndex, int pRowIndex)	Obtain the cell at required position.
PrometheusSheetCell	getCellByPosition(PrometheusSheetCellPosition pPosition)	Obtain the cell at required position.
int	getColumnCount()	Determine number of columns in this view.
PrometheusSheetRow	getRowByIndex(int pRowIndex)	Obtain the row at required index.
PrometheusSheetCell	getRowCellByIndex(PrometheusSheetRow pRow, int pIndex)	Obtain the cell at required index.
int	getRowCount()	Determine number of rows in this view.
PrometheusSheetSheet	getSheet()	Obtain the underlying sheet.
ListIterator<PrometheusSheetRow>	rowIterator()	Obtain a row iterator for non-empty rows in this view.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PrometheusSheetView

public PrometheusSheetView(PrometheusSheetSheet pSheet,
 PrometheusSheetCellPosition pFirstCell,
 PrometheusSheetCellPosition pLastCell)

Constructor.

Parameters:

pSheet - the sheet containing the view

pFirstCell - the first cell of the view

pLastCell - the last cell of the view

PrometheusSheetView

protected PrometheusSheetView(PrometheusSheetCell pFirstCell,
 PrometheusSheetCell pLastCell)

Constructor.

Parameters:

pFirstCell - the first cell of the view

pLastCell - the last cell of the view

Method Details

getSheet

public PrometheusSheetSheet getSheet()

Obtain the underlying sheet.

Returns:

the underlying sheet

getBaseCell

public PrometheusSheetCellPosition getBaseCell()

Obtain the top left position.

Returns:

the top left position

getRowCount

public int getRowCount()

Determine number of rows in this view.

Returns:

the number of rows.

getColumnCount

public int getColumnCount()

Determine number of columns in this view.

Returns:

the number of columns.

convertRowIndex

protected int convertRowIndex(int pRowIndex)

Convert Row index.

Parameters:

pRowIndex - the view index

Returns:

the sheet index or -1 if outside view

getRowByIndex

public PrometheusSheetRow getRowByIndex(int pRowIndex)

Obtain the row at required index.

Parameters:

pRowIndex - the requested row index

Returns:

the requested row.

getCellByPosition

public PrometheusSheetCell getCellByPosition(int pColumnIndex,
 int pRowIndex)

Obtain the cell at required position.

Parameters:

pColumnIndex - the requested column index

pRowIndex - the requested row index

Returns:

the requested cell.

getCellByPosition

public PrometheusSheetCell getCellByPosition(PrometheusSheetCellPosition pPosition)

Obtain the cell at required position.

Parameters:

pPosition - the requested position

Returns:

the requested cell.

getRowCellByIndex

public PrometheusSheetCell getRowCellByIndex(PrometheusSheetRow pRow,
 int pIndex)

Obtain the cell at required index.

Parameters:

pRow - the row to extract from

pIndex - the requested index

Returns:

the requested cell.

cellIterator

public ListIterator<PrometheusSheetCell> cellIterator(PrometheusSheetRow pRow)

Obtain a cell iterator for non-empty cells in the view and in the row.

Parameters:

pRow - the row

Returns:

the iterator

rowIterator

public ListIterator<PrometheusSheetRow> rowIterator()

Obtain a row iterator for non-empty rows in this view.

Returns:

the iterator