org.openepics.cable.export

Class SimpleTableExporter

java.lang.Object

org.openepics.cable.export.SimpleTableExporter

Direct Known Subclasses:

SimpleConnectorTableExporter, SimpleLogTableExporter, SimpleManufacturerTableExporter

public abstract class SimpleTableExporter
extends Object

An abstract class that implements common methods for exporting a simple table into an Excel or CSV format. The class provides support for an Export data dialog, which behaves the same whenever user wants to export tabular data. The implementing classes just need to implement methods that fill the file with the actual data.

Author:

Miha Vitorovič

Constructor Summary

Constructors

Constructor and Description
SimpleTableExporter() Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract void	addData(ExportTable exportTable) The method that fills the table with the exported data.
protected abstract void	addHeaderRow(ExportTable exportTable) The method that adds a header row to the export data.
protected abstract int	getExcelDataStartRow()
org.primefaces.model.StreamedContent	getExportedTable()
String	getFileFormat()
protected abstract String	getFileName()
protected abstract String	getTableName()
boolean	isIncludeHeaderRow()
void	prepareTableExportPopup() Prepares the default values of the Export data dialog: file format and header row
void	setFileFormat(String fileFormat)
void	setIncludeHeaderRow(boolean includeHeaderRow)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleTableExporter

public SimpleTableExporter()

Constructor.

Method Detail

prepareTableExportPopup

public void prepareTableExportPopup()

Prepares the default values of the Export data dialog: file format and header row

getFileFormat

public String getFileFormat()

Returns:

the fileFormat

setFileFormat

public void setFileFormat(String fileFormat)

Parameters:

fileFormat - the fileFormat to set

isIncludeHeaderRow

public boolean isIncludeHeaderRow()

Returns:

the includeHeaderRow

setIncludeHeaderRow

public void setIncludeHeaderRow(boolean includeHeaderRow)

Parameters:

includeHeaderRow - the includeHeaderRow to set

getExportedTable

public org.primefaces.model.StreamedContent getExportedTable()

Returns:

The data from the table exported into the PrimeFaces file download stream

getTableName

protected abstract String getTableName()

Returns:

the name of the table to be used when creating. This name may be used by the ExportTable implementation.

getFileName

protected abstract String getFileName()

Returns:

the name of the file to use WITHOUT extension

addHeaderRow

protected abstract void addHeaderRow(ExportTable exportTable)

The method that adds a header row to the export data.

Parameters:

exportTable - the table to add header row to

addData

protected abstract void addData(ExportTable exportTable)

The method that fills the table with the exported data.

Parameters:

exportTable - the table to add the data rows to

getExcelDataStartRow

protected abstract int getExcelDataStartRow()

Returns:

the 0 based index of the first data row in the excel table file