bradleyross.j2ee.servlets

Class csvWriter2

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

bradleyross.j2ee.servlets.csvWriter2

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

Deprecated.

public abstract class csvWriter2
extends HttpServlet

Serves as a template for writing servlets that display the contains of a java.sql.ResultSet object as a CSV (comma separated values) page.

The methods getResultSet and makeConnection are abstract and will need to be overridden before this class can be used. The user may also wish to override several of the methods for formatting information.

This is the class that is currently used by com.amtrak.eng.servlets.downloadDataServlet and com.amtrak.eng.tests.testServlet. After bradleyross.library.servlets.csvWriter is modified to make the variables local to the service method, the classes in com.amtrak.eng should be modified to make use of that version.

Author:

Bradley Ross

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	columnCount Deprecated. Number of columns in result set
protected ServletConfig	config Deprecated. ServletConfig object as passed to the init method.
protected DatabaseProperties	data Deprecated. Object containing database connection information.
protected String	message Deprecated. String to be placed in CSV file as the first line in the file.
protected PrintWriter	output Deprecated. Object representing the output to the HTTP response.
protected String	outputFilename Deprecated. File name to be used when creating file.
protected ResultSet	rs Deprecated. Object containing the result set.
protected ResultSetMetaData	rsmd Deprecated. Object containing meta data on result set.
private static long	serialVersionUID Deprecated.

Constructor Summary

Constructors

Constructor and Description
csvWriter2() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Deprecated.
protected String	formatDateTime(Date valueIn) Deprecated. Alternate calling sequence, leaving out the column number
protected String	formatDateTime(Date valueIn, int column) Deprecated. Formatter for values involving date and time.
protected String	formatDouble(double valueIn) Deprecated. Alternate calling sequence, leaving out the column number.
protected String	formatDouble(double valueIn, int column) Deprecated. Formatter for floating point numbers.
protected String	formatInteger(int valueIn) Deprecated. Alternate calling sequence, omitting the column number.
protected String	formatInteger(int valueIn, int column) Deprecated. Formatter for integer values.
protected String	formatString(String valueIn) Deprecated. Method of calling formatString when it doesn't depend on the column in the result set.
protected String	formatString(String valueIn, int column) Deprecated. Double up on all double quotes in string and surround the string with double quotes so that it will be in the proper format for the CSV file.
protected abstract ResultSet	getResultSet(HttpServletRequest req) Deprecated. Will be overridden with the method for obtaining the SQL result set.
void	init(ServletConfig configIn) Deprecated.
protected abstract DatabaseProperties	makeConnection() Deprecated. Obtain the database connection information.
protected void	printHeader() Deprecated. Will print header line for CSV file.
protected void	printLine() Deprecated. Will print one line of CSV file.
void	service(HttpServletRequest req, HttpServletResponse res) Deprecated.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Deprecated.

See Also:

Constant Field Values

outputFilename

protected String outputFilename

Deprecated.

File name to be used when creating file. File will be suffixed with .csv.

Changes to this field can be placed in the method getResultSet.

See Also:

getResultSet(javax.servlet.http.HttpServletRequest)

message

protected String message

Deprecated.

String to be placed in CSV file as the first line in the file.

Changes to this field can be placed in the method getResultSet.

See Also:

getResultSet(javax.servlet.http.HttpServletRequest)

data

protected DatabaseProperties data

Deprecated.

Object containing database connection information.

This field is set by the makeConnection method.

See Also:

makeConnection()

rs

protected ResultSet rs

Deprecated.

Object containing the result set.

This object is created by the getResultMethod method which is called by the service method.

rsmd

protected ResultSetMetaData rsmd

Deprecated.

Object containing meta data on result set.

This object is created by the service method after the execution of the getResultSet method and before the execution of the printHeader method.

output

protected PrintWriter output

Deprecated.

Object representing the output to the HTTP response.

columnCount

protected int columnCount

Deprecated.

Number of columns in result set

config

protected ServletConfig config

Deprecated.

ServletConfig object as passed to the init method.

Constructor Detail

csvWriter2

public csvWriter2()

Deprecated.

Method Detail

init

public void init(ServletConfig configIn)
          throws ServletException

Deprecated.

Specified by:

init in interface Servlet

Overrides:

init in class GenericServlet

Throws:

ServletException

destroy

public void destroy()

Deprecated.

Specified by:

destroy in interface Servlet

Overrides:

destroy in class GenericServlet

service

public void service(HttpServletRequest req,
           HttpServletResponse res)
             throws IOException

Deprecated.

Overrides:

service in class HttpServlet

Parameters:

req - Object containing request information

res - Object containing response information

Throws:

IOException

makeConnection

protected abstract DatabaseProperties makeConnection()
                                              throws IOException

Deprecated.

Obtain the database connection information.

Throws:

IOException

getResultSet

protected abstract ResultSet getResultSet(HttpServletRequest req)
                                   throws IOException

Deprecated.

Will be overridden with the method for obtaining the SQL result set.

Changes to fields such as message and outputFilename can go in this method.

Parameters:

req - Request information

Returns:

Result set

Throws:

IOException

See Also:

message, outputFilename

printHeader

protected void printHeader()
                    throws IOException

Deprecated.

Will print header line for CSV file.

Throws:

IOException

printLine

protected void printLine()
                  throws IOException

Deprecated.

Will print one line of CSV file.

This method will be changed at a later time to allow the specification of overriding methods for formatting timestamps, integers, floating point numbers, character strings, etc.

Throws:

IOException

formatString

protected String formatString(String valueIn)

Deprecated.

Method of calling formatString when it doesn't depend on the column in the result set.

Parameters:

valueIn - String to be processed

Returns:

Processed string

formatString

protected String formatString(String valueIn,
                  int column)

Deprecated.

Double up on all double quotes in string and surround the string with double quotes so that it will be in the proper format for the CSV file.

Parameters:

valueIn - String to be processed

column - Column number of item (not used unless method overriden)

Returns:

Processed string

formatDouble

protected String formatDouble(double valueIn)

Deprecated.

Alternate calling sequence, leaving out the column number.

Parameters:

valueIn - Floating point number to be formatted

Returns:

Formatted string

formatDouble

protected String formatDouble(double valueIn,
                  int column)

Deprecated.

Formatter for floating point numbers.

This method can be overridden to control printing of the values in the CSV file.

Parameters:

valueIn - Floating point number to be processed

column - Column number

Returns:

Formatted string

formatInteger

protected String formatInteger(int valueIn)

Deprecated.

Alternate calling sequence, omitting the column number.

Parameters:

valueIn - Integer value to be formatted

Returns:

Formatted string

formatInteger

protected String formatInteger(int valueIn,
                   int column)

Deprecated.

Formatter for integer values.

This method can be overridden to control printing of the values in the CSV file.

Parameters:

valueIn - Integer to be formatted

column - Column number

Returns:

Formatted string

formatDateTime

protected String formatDateTime(Date valueIn)

Deprecated.

Alternate calling sequence, leaving out the column number

Parameters:

valueIn - java.util.Date object containing date and time

Returns:

Formatted string

formatDateTime

protected String formatDateTime(Date valueIn,
                    int column)

Deprecated.

Formatter for values involving date and time.

This method can be overridden to control printing of the values in the CSV file.

Parameters:

valueIn - java.util.Date object containing date and time

column - Column number

Returns:

Formatted string