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

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

Class PrometheusSheetSheet

java.lang.Object

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

All Implemented Interfaces:

PrometheusSheet.PrometheusSheetSheetCtl

public abstract class PrometheusSheetSheet
extends Object
implements PrometheusSheet.PrometheusSheetSheetCtl

Class representing a sheet within a workBook.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusSheetSheet(PrometheusSheet.PrometheusSheetWorkBookCtl pWorkBook, String pName, boolean pReadOnly)	Constructor for Excel Sheet.

Method Summary

Modifier and Type	Method	Description
void	declareRange(String pName, PrometheusSheetCellPosition pSingleCell)	Name a single cell as a range.
String	getName()	Obtain the name of the sheet.
abstract int	getRowCount()	Get row count.
PrometheusSheet.PrometheusSheetWorkBookCtl	getWorkBook()	Obtain the workBook.
boolean	isReadOnly()	Is the sheet readOnly?
abstract ListIterator<PrometheusSheetRow>	iteratorForRange(int pFirstIndex, int pLastIndex)	Obtain an iterator of non-null rows for the view.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.tonywasher.joceanus.prometheus.service.sheet.PrometheusSheet.PrometheusSheetSheetCtl

applyDataFilter, applyDataValidation, createFreezePane, declareRange, getMutableColumnByIndex, getMutableRowByIndex, getReadOnlyColumnByIndex, getReadOnlyRowByIndex, getSheetIndex, isHidden, setHidden

Constructor Details

PrometheusSheetSheet

protected PrometheusSheetSheet(PrometheusSheet.PrometheusSheetWorkBookCtl pWorkBook,
 String pName,
 boolean pReadOnly)

Constructor for Excel Sheet.

Parameters:

pWorkBook - the workBook

pName - the sheet name

pReadOnly - is the sheet readOnly?

Method Details

getWorkBook

public PrometheusSheet.PrometheusSheetWorkBookCtl getWorkBook()

Obtain the workBook.

Returns:

the workBook

getName

public String getName()

Obtain the name of the sheet.

Specified by:

getName in interface PrometheusSheet.PrometheusSheetSheetCtl

Returns:

the name

isReadOnly

public boolean isReadOnly()

Is the sheet readOnly?

Returns:

true/false

getRowCount

public abstract int getRowCount()

Get row count.

Returns:

the count of rows

iteratorForRange

public abstract ListIterator<PrometheusSheetRow> iteratorForRange(int pFirstIndex,
 int pLastIndex)

Obtain an iterator of non-null rows for the view.

Parameters:

pFirstIndex - the first row in the view

pLastIndex - the last row in the view

Returns:

the iterator

declareRange

public void declareRange(String pName,
 PrometheusSheetCellPosition pSingleCell)
                  throws OceanusException

Name a single cell as a range.

Parameters:

pName - the name of the range

pSingleCell - the cell to name

Throws:

OceanusException - on error