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

public abstract class PrometheusSheetWriter
extends Object

Write control for spreadsheets.

Author:

Tony Washer

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PrometheusSheetWriter(TethysUIFactory<?> pFactory, TethysUIThreadStatusReport pReport)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	addSheet(PrometheusSheetDataItem<?> pSheet)	Add Sheet to list.
void	createBackup(PrometheusDataSet pData, File pFile, PrometheusSheetWorkBookType pType)	Create a Backup Workbook.
void	createBackup(PrometheusDataSet pData, OutputStream pZipStream, PrometheusSheetWorkBookType pType)	Create a Backup Workbook.
PrometheusDataSet	getData()	get dataSet.
protected TethysUIThreadStatusReport	getReport()	get report.
protected 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(TethysUIFactory<?> pFactory,
 TethysUIThreadStatusReport pReport)

Constructor.

Parameters:

pFactory - the gui factory

pReport - the report

Method Details

getReport

protected TethysUIThreadStatusReport getReport()

get report.

Returns:

the report

getWorkBook

protected PrometheusSheetWorkBook getWorkBook()

get workbook.

Returns:

the workbook

getData

public PrometheusDataSet getData()

get dataSet.

Returns:

the dataSet

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 backup file to write to

pType - the workBookType

Throws:

OceanusException - on error

registerSheets

protected abstract void registerSheets()

Register sheets.