org.openepics.cable.export

Class ExcelExportTable

java.lang.Object

org.openepics.cable.export.ExcelExportTable

All Implemented Interfaces:

ExportTable

public class ExcelExportTable
extends Object
implements ExportTable

The class implements exporting the a single table into an Excel file.

Author:

Miha Vitorovič, Sunil Sah

Constructor Summary

Constructors

Constructor and Description
ExcelExportTable(int startRow) Constructs an Excel file exporter.

Method Summary

Modifier and Type	Method and Description
void	addDataRow(Object... data) This method adds a new row of data to the table.
void	addHeaderRow(String... titles) Defines a header row.
void	createTable(String title) The method creates the table.
InputStream	exportTable() This method puts the data into a stream that can be saved/sent to the client.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelExportTable

public ExcelExportTable(int startRow)

Constructs an Excel file exporter.

Parameters:

startRow - the 0 based index of the row to start the export at.

Method Detail

createTable

public void createTable(String title)

Description copied from interface: ExportTable

The method creates the table. Use to prepare the internal structures for the data that will be received.

Specified by:

createTable in interface ExportTable

Parameters:

title - name of the table if supported by the implementation

addHeaderRow

public void addHeaderRow(String... titles)

Description copied from interface: ExportTable

Defines a header row. For some formats the header row can be added multiple times (and may signify just a row displayed in different style), while for other formats can only be added once and before any of the data rows.

Specified by:

addHeaderRow in interface ExportTable

Parameters:

titles - a collection of strings to be used as column titles

addDataRow

public void addDataRow(Object... data)

Description copied from interface: ExportTable

This method adds a new row of data to the table. The input data can be in any format. The method is responsible for correctly interpreting the data entries.

Specified by:

addDataRow in interface ExportTable

Parameters:

data - the data

exportTable

public InputStream exportTable()

Description copied from interface: ExportTable

This method puts the data into a stream that can be saved/sent to the client.

Specified by:

exportTable in interface ExportTable

Returns:

the InputStream that can be used for download.