org.josef.web.servlet

Class AbstractCsvServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.josef.web.servlet.AbstractHttpServlet

org.josef.web.servlet.AbstractCsvServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

@Status(stage=DEVELOPMENT,
        unitTests=ABSENT)
 @Reviews(value=@Review(by="Kees Schotanus",at="2010-10-24",reason="Preliminary checkin"))
public abstract class AbstractCsvServlet
extends AbstractHttpServlet

Base class for all csv (comma separated values) based servlets that write csv output.
Use this base class for servlets that create csv files that can be opened with MicroSoft's Excel for example.
This servlet accepts the following initialization parameters:

Name	Description	Default
fileName	Name of the csv file	output.csv
rowSeparator	The separator that separates rows	The default line.separator for the platform
columnSeparator	The separator that separates columns	comma
attachment	Determines whether the csv file is opened in the browser or in Excel. The value can be false ("0" or "false") or true (any other value).	true
contentType	Determines the mime type	application/vnd.ms-excel

Known bugs:

• With Microsoft Office 2007 files can only be opened separately (as an attachment) and not within the browser!

To create a concrete servlet that outputs csv data, simply extend this class and implement the single abstract writeCsvData(HttpServletRequest, HttpServletResponse) method.

Version:

1.1 $Revision: 5814 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractCsvServlet()

Method Summary

Modifier and Type	Method and Description
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Processes the get request.
Character	getColumnSeparator() Gets the column separator.
String	getContentType() Gets the content type for this csv output.
String	getFileName() Gets the file name to write the csv output to.
String	getRowSeparator() Gets the row separator.
String	getServletInfo() Returns information about the servlet.
void	init(javax.servlet.ServletConfig servletConfig) Process init parameters.
boolean	isAttachment() Determines whether csv output is shown as an attachment or within the browser.
protected abstract void	writeCsvData(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Writes the csv output.

Methods inherited from class org.josef.web.servlet.AbstractHttpServlet

clearSessionData, destroy, getActiveRequests, getLocale, getRequiredInitParameter, getSessionInfo, service

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCsvServlet

public AbstractCsvServlet()

Method Detail

getServletInfo

public String getServletInfo()

Returns information about the servlet.

Specified by:

getServletInfo in interface javax.servlet.Servlet

Overrides:

getServletInfo in class AbstractHttpServlet

Returns:

Servlet-info.

init

public void init(javax.servlet.ServletConfig servletConfig)
          throws javax.servlet.ServletException

Process init parameters.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Parameters:

servletConfig - Servlet Configuration.

Throws:

javax.servlet.ServletException - When the super class throws this exception.

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws javax.servlet.ServletException,
                  IOException

Processes the get request.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

request - The request.

response - The response.

Throws:

javax.servlet.ServletException - When a servlet exception occurs.

IOException - When something goes wrong while creating output.

getFileName

public String getFileName()

Gets the file name to write the csv output to.

Returns:

The file name to write the csv output to.

getRowSeparator

public String getRowSeparator()

Gets the row separator.

Returns:

The row separator.

getColumnSeparator

public Character getColumnSeparator()

Gets the column separator.

Returns:

The column separator.

isAttachment

public boolean isAttachment()

Determines whether csv output is shown as an attachment or within the browser.

Returns:

True when csv output is shown as an attachment in a separate window, false when shown within the current window.

getContentType

public String getContentType()

Gets the content type for this csv output.

Returns:

The content type for this csv output.

writeCsvData

protected abstract void writeCsvData(javax.servlet.http.HttpServletRequest request,
                                     javax.servlet.http.HttpServletResponse response)
                              throws IOException

Writes the csv output.

Parameters:

request - The request object.

response - The response object.
Use this object to get the writer object for example.

Throws:

IOException - When an exception occurs while writing the csv data.