com.sptci.rwt
Class ExcelGenerator

java.lang.Object
  com.sptci.rwt.ExcelGenerator

 class ExcelGenerator
extends Object

An Excel workbook generator for data contained in a Rows object. This uses the Apache POI HSSF library for creating Excel workbooks.

© Copyright 2007 Sans Pareil Technologies, Inc.

Version:

$Id: ExcelGenerator.java 4123 2008-05-25 21:49:01Z rakesh $

Author:

Rakesh Vidyadharan 2007-10-09

Constructor Summary

ExcelGenerator()

Method Summary

private void	createHeader(Row row, org.apache.poi.hssf.usermodel.HSSFWorkbook workbook, org.apache.poi.hssf.usermodel.HSSFSheet sheet, short index) Create the header row for the excel sheet using the Column.name field.
private void	createQuery(String query, org.apache.poi.hssf.usermodel.HSSFWorkbook workbook, org.apache.poi.hssf.usermodel.HSSFSheet sheet, short index, short columns) Create the cells used to display the SQL statement that was executed to generate the results.
private void	createRow(Row row, org.apache.poi.hssf.usermodel.HSSFWorkbook workbook, org.apache.poi.hssf.usermodel.HSSFSheet sheet, short index) Create a header row for the excel sheet using the Column.name field.
(package private) org.apache.poi.hssf.usermodel.HSSFWorkbook	generate(String query, List<Rows> rows) Create a new workbook that holds the data in Rows.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExcelGenerator

ExcelGenerator()

Method Detail

generate

org.apache.poi.hssf.usermodel.HSSFWorkbook generate(String query,
                                                    List<Rows> rows)

Create a new workbook that holds the data in Rows. Also display query to indicate the statement that was used to generate the results.

Parameters:

query - The SQL query to execute.

rows - The list of rows data set to export.

Returns:

The work book that contains the data in rows.

See Also:

createQuery(java.lang.String, org.apache.poi.hssf.usermodel.HSSFWorkbook, org.apache.poi.hssf.usermodel.HSSFSheet, short, short), createHeader(com.sptci.rwt.Row, org.apache.poi.hssf.usermodel.HSSFWorkbook, org.apache.poi.hssf.usermodel.HSSFSheet, short), createRow(com.sptci.rwt.Row, org.apache.poi.hssf.usermodel.HSSFWorkbook, org.apache.poi.hssf.usermodel.HSSFSheet, short)

createQuery

private void createQuery(String query,
                         org.apache.poi.hssf.usermodel.HSSFWorkbook workbook,
                         org.apache.poi.hssf.usermodel.HSSFSheet sheet,
                         short index,
                         short columns)

Create the cells used to display the SQL statement that was executed to generate the results.

Parameters:

query - The SQL statement used to generate the results.

workbook - The excel workbook.

sheet - The excel work sheet.

index - The row number for the header.

columns - The number of columns this row spans.

createHeader

private void createHeader(Row row,
                          org.apache.poi.hssf.usermodel.HSSFWorkbook workbook,
                          org.apache.poi.hssf.usermodel.HSSFSheet sheet,
                          short index)

Create the header row for the excel sheet using the Column.name field.

Parameters:

row - The row instance from which column names are extracted.

workbook - The excel workbook.

sheet - The sheet in which the header row is to be inserted.

index - The row number for the header.

createRow

private void createRow(Row row,
                       org.apache.poi.hssf.usermodel.HSSFWorkbook workbook,
                       org.apache.poi.hssf.usermodel.HSSFSheet sheet,
                       short index)

Create a header row for the excel sheet using the Column.name field.

Parameters:

row - The row instance from which column names are extracted.

workbook - The excel workbook.

sheet - The sheet in which the header row is to be inserted.

index - The row index to set.