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

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

Interface PrometheusSheetWorkBook

public interface PrometheusSheetWorkBook

Sheet Service interface.

Method Summary

Modifier and Type	Method	Description
default OceanusDataFormatter	createFormatter()	Create data formatter.
PrometheusSheetView	getRangeView(String pName)	Obtain a view of the named range.
PrometheusSheetSheet	getSheet(String pName)	Access an existing Sheet with the given name.
boolean	isReadOnly()	Is the WorkBook readOnly?
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.
void	saveToStream(OutputStream pOutput)	Save the workBook to output stream.

Method Details

isReadOnly

boolean isReadOnly()

Is the WorkBook readOnly?

Returns:

true/false

saveToStream

void saveToStream(OutputStream pOutput)
           throws OceanusException

Save the workBook to output stream.

Parameters:

pOutput - the output stream

Throws:

OceanusException - on error

newSheet

PrometheusSheetSheet newSheet(String pName)
                       throws OceanusException

Create a new Sheet with the given name.

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

Create a new Sheet with the given name.

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

Access an existing Sheet with the given name.

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

Obtain a view of the named range.

Parameters:

pName - the name of the range

Returns:

the view of the range

Throws:

OceanusException - on error

createFormatter

default OceanusDataFormatter createFormatter()

Create data formatter.

Returns:

the new formatter