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

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

Interface PrometheusSheetWorkBook

All Superinterfaces:

PrometheusSheet.PrometheusSheetWorkBookCtl

public interface PrometheusSheetWorkBook
extends PrometheusSheet.PrometheusSheetWorkBookCtl

Sheet Service interface.

Method Summary

Modifier and Type	Method	Description
PrometheusSheetView	getRangeView(String pName)	Obtain a view of the named range.
PrometheusSheetSheet	getSheet(String pName)	Access an existing Sheet with the given name.
PrometheusSheetSheet	newSheet(String pName)	Create a new Sheet with the given name.
PrometheusSheetSheet	newSheet(String pName, int pNumRows, int pNumCols)	Create a new Sheet with the given name.

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

createFormatter, isReadOnly, saveToStream

Method Details

newSheet

PrometheusSheetSheet newSheet(String pName)
                       throws OceanusException

Description copied from interface: PrometheusSheet.PrometheusSheetWorkBookCtl

Create a new Sheet with the given name.

Specified by:

newSheet in interface PrometheusSheet.PrometheusSheetWorkBookCtl

Parameters:

pName - the name of the new sheet

Returns:

the new sheet

Throws:

OceanusException - on error

newSheet

PrometheusSheetSheet newSheet(String pName,
 int pNumRows,
 int pNumCols)
                       throws OceanusException

Description copied from interface: PrometheusSheet.PrometheusSheetWorkBookCtl

Create a new Sheet with the given name.

Specified by:

newSheet in interface PrometheusSheet.PrometheusSheetWorkBookCtl

Parameters:

pName - the name of the new sheet

pNumRows - the number of rows to allocate

pNumCols - the number of columns to allocate

Returns:

the new sheet

Throws:

OceanusException - on error

getSheet

PrometheusSheetSheet getSheet(String pName)
                       throws OceanusException

Description copied from interface: PrometheusSheet.PrometheusSheetWorkBookCtl

Access an existing Sheet with the given name.

Specified by:

getSheet in interface PrometheusSheet.PrometheusSheetWorkBookCtl

Parameters:

pName - the name of the sheet

Returns:

the sheet (or null if no such sheet)

Throws:

OceanusException - on error

getRangeView

PrometheusSheetView getRangeView(String pName)
                          throws OceanusException

Description copied from interface: PrometheusSheet.PrometheusSheetWorkBookCtl

Obtain a view of the named range.

Specified by:

getRangeView in interface PrometheusSheet.PrometheusSheetWorkBookCtl

Parameters:

pName - the name of the range

Returns:

the view of the range

Throws:

OceanusException - on error