bradleyross.j2ee.servlets

Class CsvWriter.Instance

java.lang.Object

bradleyross.j2ee.servlets.CsvWriter.Instance

Enclosing class:

CsvWriter

protected class CsvWriter.Instance
extends Object

Encapsulates methods and properties for a given instance of the service method.

Methods and properties in this class will normally not be overridden.

Author:

Bradley Ross

Field Summary

Fields

Modifier and Type	Field and Description
protected int	columnCount Number of columns in result set
protected DatabaseProperties	data Object containing database connection information.
protected String	message String to be placed in CSV file as the first line in the file.
protected PrintWriter	output Object representing the output to the HTTP response.
protected String	outputFilename File name to be used when creating file.
protected HttpServletRequest	request Object containing HTTP request.
protected HttpServletResponse	response Object used for preparing HTTP response.
protected ResultSet	rs Object containing the result set.
protected ResultSetMetaData	rsmd Object containing meta data on result set.

Constructor Summary

Constructors

Constructor and Description
CsvWriter.Instance(HttpServletRequest req, HttpServletResponse res)

Method Summary

Methods

Modifier and Type	Method and Description
int	getColumnCount() Obtains number of columns in result set
DatabaseProperties	getDatabaseProperties()
String	getMessage() Getter for message.
String	getOutputFilename()
PrintWriter	getPrintWriter() Getter for output.
HttpServletRequest	getRequest() Getter for request.
HttpServletResponse	getResponse() Getter for response.
ResultSet	getResultSet() Getter for rs.
ResultSetMetaData	getResultSetMetaData() Getter for rsmd.
void	setColumnCount(int value) Sets number of columns in result set.
void	setDatabaseProperties(DatabaseProperties value)
void	setOutputFilename(String value)
void	setResultSet(ResultSet value) Setter for rs.
void	setResultSetMetaData(ResultSetMetaData value) Setter for rsmd.

Methods inherited from class java.lang.Object

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

Field Detail

request

protected HttpServletRequest request

Object containing HTTP request.

response

protected HttpServletResponse response

Object used for preparing HTTP response.

outputFilename

protected String outputFilename

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

Changes to this field can be made using the setValues method of the enclosing class.

See Also:

setOutputFilename(String), getOutputFilename(), CsvWriter.setValues(Instance)

message

protected String message

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

Changes to this field can be made by using the setValues method of the enclosing class.

See Also:

CsvWriter.setValues(Instance)

data

protected DatabaseProperties data

Object containing database connection information.

This field is set by the makeConnection method.

See Also:

CsvWriter.makeConnection()

rs

protected ResultSet rs

Object containing the result set.

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

See Also:

CsvWriter.getResultSet(HttpServletRequest, DatabaseProperties)

rsmd

protected ResultSetMetaData rsmd

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.

Must be moved to inner class

output

protected PrintWriter output

Object representing the output to the HTTP response.

columnCount

protected int columnCount

Number of columns in result set

Constructor Detail

CsvWriter.Instance

public CsvWriter.Instance(HttpServletRequest req,
                  HttpServletResponse res)

Method Detail

getResultSet

public ResultSet getResultSet()

Getter for rs.

Returns:

ResultSet object

See Also:

rs

setResultSet

public void setResultSet(ResultSet value)

Setter for rs.

This would not normally be called from outside classes.

Parameters:

value - Value to be used for field

See Also:

rs

getResultSetMetaData

public ResultSetMetaData getResultSetMetaData()

Getter for rsmd.

Returns:

ResultSetMetaData object

See Also:

rsmd

setResultSetMetaData

public void setResultSetMetaData(ResultSetMetaData value)

Setter for rsmd.

This would not normally be called by external classes.

Parameters:

value - ResultSetMetaData object

See Also:

rsmd

getDatabaseProperties

public DatabaseProperties getDatabaseProperties()

setDatabaseProperties

public void setDatabaseProperties(DatabaseProperties value)

getOutputFilename

public String getOutputFilename()

setOutputFilename

public void setOutputFilename(String value)

getColumnCount

public int getColumnCount()

Obtains number of columns in result set

Returns:

Number of columns

See Also:

columnCount

setColumnCount

public void setColumnCount(int value)

Sets number of columns in result set.

This method would not normally be used.

Parameters:

value - Value to be used

See Also:

columnCount

getPrintWriter

public PrintWriter getPrintWriter()

Getter for output.

Returns:

PrintWriter object.

See Also:

output

getMessage

public String getMessage()

Getter for message.

Returns:

Message text

See Also:

message

getRequest

public HttpServletRequest getRequest()

Getter for request.

Returns:

HttpServletRequest object

See Also:

request

getResponse

public HttpServletResponse getResponse()

Getter for response.

Returns:

HttpServletResponse object

See Also:

response