net.sf.flatpack.excel

Class ExcelTransformer

java.lang.Object

net.sf.flatpack.excel.ExcelTransformer

public class ExcelTransformer
extends Object

Converts a DataSet object into an excel spreadsheet. Only detail records will be contained in the export. Header / Trailer records defined by <record> tags in the pzmap will be ignored on the export.

Author:

Paul Zepernick

Constructor Summary

Constructors

Constructor and Description
ExcelTransformer(DataSet ds, File xlsFile) Constructs a new Excel transformer

Method Summary

Modifier and Type	Method and Description
String[]	getExcludeFromExportColumns()
String[]	getExportOnlyColumns()
String[]	getNumericColumns()
void	setExcludeFromExportColumns(String[] excludeFromExportColumns) The columns names contained in the array will be igored if setExportOnlyColumns() is called.
void	setExportOnlyColumns(String[] exportOnlyColumns) When set, only columns contained in the String[] will be exported out to Excel.
void	setNumericColumns(String[] numericColumns) Columns contained in this array will be writen as numerics to Excel instead of Text
void	writeExcelFile() Writes the Excel file to disk

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelTransformer

public ExcelTransformer(DataSet ds,
                        File xlsFile)

Constructs a new Excel transformer

Parameters:

ds - DataSet to convert

xlsFile - Excel file to be created

Method Detail

writeExcelFile

public void writeExcelFile()
                    throws IOException,
                           jxl.write.WriteException

Writes the Excel file to disk

Throws:

IOException

jxl.write.WriteException

setExcludeFromExportColumns

public void setExcludeFromExportColumns(String[] excludeFromExportColumns)

The columns names contained in the array will be igored if setExportOnlyColumns() is called. Any columns names contained in this list will be excluded from the export in Excel.

Parameters:

excludeFromExportColumns - the excludeFromExportColumns to set

setExportOnlyColumns

public void setExportOnlyColumns(String[] exportOnlyColumns)

When set, only columns contained in the String[] will be exported out to Excel.

Parameters:

exportOnlyColumns - the exportOnlyColumns to set

getNumericColumns

public String[] getNumericColumns()

Returns:

the numericColumns

setNumericColumns

public void setNumericColumns(String[] numericColumns)

Columns contained in this array will be writen as numerics to Excel instead of Text

Parameters:

numericColumns - the numericColumns to set

getExportOnlyColumns

public String[] getExportOnlyColumns()

Returns:

the exportOnlyColumns

getExcludeFromExportColumns

public String[] getExcludeFromExportColumns()

Returns:

the excludeFromExportColumns