org.openepics.cable.services.dl

Class DataSaverExcelBase<T>

java.lang.Object

org.openepics.cable.services.dl.DataSaverExcelBase<T>

Type Parameters:

T - type

Direct Known Subclasses:

DataSaverExcelStream

public abstract class DataSaverExcelBase<T>
extends Object

Abstract super class for store and save data to Excel.

Author:

Zoltan Runyo

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.poi.ss.usermodel.ClientAnchor	anchor
protected org.apache.poi.ss.usermodel.CreationHelper	creationHelper
protected org.apache.poi.ss.usermodel.Drawing	drawing
protected DSHeader	header
protected org.apache.poi.ss.usermodel.Sheet	sheet

Constructor Summary

Constructors

Constructor and Description
DataSaverExcelBase()

Method Summary

Modifier and Type	Method and Description
InputStream	save() Saves the stored data objects to spreadsheet.
protected abstract void	save(T object) Saves the object by calling setValue(...) and setCommand(...) methods.
protected void	setCommand(DSCommand command) Writes the command string in the spreadsheet at the current row.
void	setCommand(int rowIndex, DSCommand command) Writes the command string in the spreadsheet at the specified row.
void	setValue(int rowIndex, Object columnName, Object value) Stores the value in the spreadsheet at the specified row and the specified column.

Methods inherited from class java.lang.Object

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

Field Detail

sheet

protected org.apache.poi.ss.usermodel.Sheet sheet

header

protected DSHeader header

drawing

protected org.apache.poi.ss.usermodel.Drawing drawing

creationHelper

protected org.apache.poi.ss.usermodel.CreationHelper creationHelper

anchor

protected org.apache.poi.ss.usermodel.ClientAnchor anchor

Constructor Detail

DataSaverExcelBase

public DataSaverExcelBase()

Method Detail

save

public InputStream save()

Saves the stored data objects to spreadsheet.

Returns:

the input stream containing the spreadsheet

setCommand

public void setCommand(int rowIndex,
                       DSCommand command)

Writes the command string in the spreadsheet at the specified row. The save() method performs all the required command writing, this method is public only for the purpose of tests.

Parameters:

rowIndex - the row index, 0 for the first object

command - the command to write; if DSCommand.NONE or DSCommand.OPERATION, nothing is written

save

protected abstract void save(T object)

Saves the object by calling setValue(...) and setCommand(...) methods.

Parameters:

object - the object to be saved

setCommand

protected void setCommand(DSCommand command)

Writes the command string in the spreadsheet at the current row.

Parameters:

command - the command to write; if DSCommand.NONE, nothing is written

setValue

public void setValue(int rowIndex,
                     Object columnName,
                     Object value)

Stores the value in the spreadsheet at the specified row and the specified column. The save() method performs all the required storing, this method is public only for the purpose of tests.

Parameters:

rowIndex - the row index, 0 for the first object

columnName - the column name

value - the value to store