bradleyross.library.helpers

Class SpreadsheetHelpers

java.lang.Object

bradleyross.library.helpers.SpreadsheetHelpers

public class SpreadsheetHelpers
extends Object

Generates an Excel XML workbook.

Author:

Bradley Ross

See Also:

TestSpreadsheetHelpers

Field Summary

Fields

Modifier and Type	Field and Description
private int	debugLevel Controls amount of diagnostic messages to be generated.
private int	numCols Number of columns in the current spreadsheet.
private int	numRows Running count of the number of rows in the current spreadsheet.

Constructor Summary

Constructors

Constructor and Description
SpreadsheetHelpers()

Method Summary

Methods

Modifier and Type	Method and Description
private void	addText(StringBuffer working, String text)
String	endWorkbook() Generates the ending string for an Excel Workbook in XML format.
private String	endWorksheet() Generate the XML text to appear at the end of a spreadsheet within the workbook.
private String	endWorksheet(int numRows, int numCols)
protected String	generateWorksheetHeader(ResultSet rs, ResultSetMetaData meta, String columns) Generate header line for spreadsheet.
int	getDebugLevel() Returns value of debugLevel
void	listResultSet(ResultSet rs) Prints the contents of a result set.
String	newWorksheet(String worksheetName, BufferedReader in) Use java.io.Reader object to create an Excel worksheet.
String	newWorksheet(String worksheetName, File inputFile) Use the contents of a file to create an Excel worksheet.
String	newWorksheet(String worksheetName, ResultSet rs) Use the contents of a ResultSet to create an Excel spreadsheet.
String	newWorksheet(String worksheetName, ResultSet rs, String columns) Use the contents of a ResultSet to create an Excel spreadsheet.
String	newWorksheet(String worksheetName, ResultSet rs, String columns, int breakColumn) Use the contents of a ResultSet to create an Excel worksheet.
String	newWorksheet(String worksheetName, String input) Use the contents of a String object to create an Excel spreadsheet.
void	setDebugLevel(int level) Set amount of diagnostic messages to be printed.
String	startWorkbook() Returns the character string that should appear at the start of the workbook.
private String	startWorksheet(String worksheetName, int numRows, int numCols) Generate the XML text to appear at the start of a spreadsheet within the workbook.
void	stringToFile(String data, String fileName) This method constructs a new file containing the contents of a String object.

Methods inherited from class java.lang.Object

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

Field Detail

numRows

private int numRows

Running count of the number of rows in the current spreadsheet.

numCols

private int numCols

Number of columns in the current spreadsheet.

debugLevel

private int debugLevel

Controls amount of diagnostic messages to be generated.

See Also:

setDebugLevel(int), getDebugLevel()

Constructor Detail

SpreadsheetHelpers

public SpreadsheetHelpers()

Method Detail

setDebugLevel

public void setDebugLevel(int level)

Set amount of diagnostic messages to be printed.

A value of 0 indicates that a normal level diagnostic messages are to be printed. Increased values increase the quantity of diagnostic messages, while negative numbers reduce the amount of messages.

Parameters:

level - Desired level of diagnostic messages.

getDebugLevel

public int getDebugLevel()

Returns value of debugLevel

Returns:

Value of debugLevel

See Also:

debugLevel, setDebugLevel(int)

stringToFile

public void stringToFile(String data,
                String fileName)

This method constructs a new file containing the contents of a String object.

Parameters:

data - String containing information to be moved to file

fileName - Name of file to be generated

listResultSet

public void listResultSet(ResultSet rs)
                   throws SQLException

Prints the contents of a result set.

Parameters:

rs - ResultSet to be printed

Throws:

SQLException

addText

private void addText(StringBuffer working,
           String text)

startWorkbook

public String startWorkbook()

Returns the character string that should appear at the start of the workbook.

Some of the literal values in the listing below should probably be replaced with calculated values, particularly the date and time of the creation of the document.

Returns:

Text for start of workbook

startWorksheet

private String startWorksheet(String worksheetName,
                    int numRows,
                    int numCols)

Generate the XML text to appear at the start of a spreadsheet within the workbook.

Parameters:

worksheetName - Name of spreadsheet

numRows - Number of rows in spreadsheet

numCols - Number of columns in spreadsheet

Returns:

XML text for start of spreadsheet

endWorksheet

private String endWorksheet()

Generate the XML text to appear at the end of a spreadsheet within the workbook.

Returns:

XML code to end spreadsheet

generateWorksheetHeader

protected String generateWorksheetHeader(ResultSet rs,
                             ResultSetMetaData meta,
                             String columns)
                                  throws SQLException

Generate header line for spreadsheet.

Overriding this method should allow the contents of the header line to be changed as desired.

This method is normally called from the newWorksheet methods.

Parameters:

rs - Result Set from SQL query

meta - ResultSetMetaData from SQL query

columns - XML statements specifying formatting of columns

Throws:

SQLException

newWorksheet

public String newWorksheet(String worksheetName,
                  ResultSet rs)
                    throws SQLException

Use the contents of a ResultSet to create an Excel spreadsheet.

Parameters:

worksheetName - Name to be used for Excel spreadsheet.

rs - ResultSet object to be used.

Returns:

XML source for Excel spreadsheet

Throws:

SQLException

See Also:

newWorksheet(String, ResultSet, String)

newWorksheet

public String newWorksheet(String worksheetName,
                  ResultSet rs,
                  String columns)
                    throws SQLException

Use the contents of a ResultSet to create an Excel spreadsheet. This version allows the width of the columns to be set by the calling program.

Parameters:

worksheetName - Name to be used for Excel spreadsheet

rs - ResultSet object to be used

columns - String to be inserted into spreadsheet to define widths of columns

Returns:

XML source for Excel spreadsheet

Throws:

SQLException

newWorksheet

public String newWorksheet(String worksheetName,
                  ResultSet rs,
                  String columns,
                  int breakColumn)
                    throws SQLException

Use the contents of a ResultSet to create an Excel worksheet. This version allows the width of the columns to be set by the calling program.

Parameters:

worksheetName - Name to be used for Excel worksheet

rs - ResultSet object to be used

columns - String to be inserted into spreadsheet to define widths of columns

breakColumn - This is the number of the column that will be used for bursting the report

Returns:

XML source for Excel spreadsheet

Throws:

SQLException

See Also:

newWorksheet(String, ResultSet), newWorksheet(String, ResultSet, String)

newWorksheet

public String newWorksheet(String worksheetName,
                  File inputFile)

Use the contents of a file to create an Excel worksheet.

Parameters:

worksheetName - Name of worksheet to be created.

inputFile - Name of file to be read

Returns:

XML string containing Excel worksheet

newWorksheet

public String newWorksheet(String worksheetName,
                  String input)

Use the contents of a String object to create an Excel spreadsheet.

Parameters:

worksheetName - Name of spreadsheet to be created.

input - String object to be read

Returns:

XML string containing Excel spreadsheet

newWorksheet

public String newWorksheet(String worksheetName,
                  BufferedReader in)

Use java.io.Reader object to create an Excel worksheet.

Parameters:

worksheetName - Name of worksheet to be created.

in - String object to be read

Returns:

XML string containing Excel worksheet

endWorkbook

public String endWorkbook()

Generates the ending string for an Excel Workbook in XML format.

Returns:

Ending string for workbook.

endWorksheet

private String endWorksheet(int numRows,
                  int numCols)