Module io.github.tonywasher.joceanus.prometheus.core

Package io.github.tonywasher.joceanus.prometheus.sheets

Class PrometheusSheetWriter

java.lang.Object

io.github.tonywasher.joceanus.prometheus.sheets.PrometheusSheetWriter

All Implemented Interfaces:

PrometheusSheetControl

public abstract class PrometheusSheetWriter
extends Object
implements PrometheusSheetControl

Write control for spreadsheets.

Author:

Tony Washer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusSheetWriter(TethysUIThreadStatusReport pReport)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addSheet(PrometheusSheetDataItem<?> pSheet)	Add Sheet to list.
void	createBackup(GordianZipLock pZipLock, OutputStream pZipStream)	Create a Backup Workbook.
void	createBackup(PrometheusDataSet pData, File pFile, PrometheusSheetWorkBookType pType)	Create a Backup Workbook.
void	createBackup(PrometheusDataSet pData, OutputStream pZipStream, PrometheusSheetWorkBookType pType)	Create a Backup Workbook.
void	createBackup(OutputStream pZipStream)	Create a Backup Workbook.
PrometheusDataSet	getData()	get data.
TethysUIThreadStatusReport	getReport()	get report.
PrometheusSheetWorkBook	getWorkBook()	get workbook.
protected abstract void	registerSheets()	Register sheets.

Methods inherited from class java.lang.Object

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

Constructor Details

PrometheusSheetWriter

protected PrometheusSheetWriter(TethysUIThreadStatusReport pReport)

Constructor.

Parameters:

pReport - the report

Method Details

getReport

public TethysUIThreadStatusReport getReport()

Description copied from interface: PrometheusSheetControl

get report.

Specified by:

getReport in interface PrometheusSheetControl

Returns:

the report

getWorkBook

public PrometheusSheetWorkBook getWorkBook()

Description copied from interface: PrometheusSheetControl

get workbook.

Specified by:

getWorkBook in interface PrometheusSheetControl

Returns:

the workbook

getData

public PrometheusDataSet getData()

Description copied from interface: PrometheusSheetControl

get data.

Specified by:

getData in interface PrometheusSheetControl

Returns:

the data

addSheet

protected void addSheet(PrometheusSheetDataItem<?> pSheet)

Add Sheet to list.

Parameters:

pSheet - the sheet

createBackup

public void createBackup(PrometheusDataSet pData,
 File pFile,
 PrometheusSheetWorkBookType pType)
                  throws OceanusException

Create a Backup Workbook.

Parameters:

pData - Data to write out

pFile - the backup file to write to

pType - the workBookType

Throws:

OceanusException - on error

createBackup

public void createBackup(PrometheusDataSet pData,
 OutputStream pZipStream,
 PrometheusSheetWorkBookType pType)
                  throws OceanusException

Create a Backup Workbook.

Parameters:

pData - Data to write out

pZipStream - the output stream

pType - the workBookType

Throws:

OceanusException - on error

createBackup

public void createBackup(OutputStream pZipStream)
                  throws OceanusException

Create a Backup Workbook.

Parameters:

pZipStream - the backup file to write to

Throws:

OceanusException - on error

createBackup

public void createBackup(GordianZipLock pZipLock,
 OutputStream pZipStream)
                  throws OceanusException

Create a Backup Workbook.

Parameters:

pZipLock - the zipLock

pZipStream - the backup file to write to

Throws:

OceanusException - on error

registerSheets

protected abstract void registerSheets()

Register sheets.