com.redhat.rhn.frontend.taglibs.list

Class CSVTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

com.redhat.rhn.frontend.taglibs.list.CSVTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class CSVTag
extends javax.servlet.jsp.tagext.BodyTagSupport

Exports a List of data to a comma separated value string

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CSV_DOWNLOAD_URI

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
CSVTag()

Method Summary

Modifier and Type	Method and Description
int	doEndTag() $
int	doStartTag() $
java.lang.String	getExportColumns()
java.lang.String	getHeader()
java.lang.String	getUniqueName() Build the list's unique name Algorithm for the unique name is: Take the CRC value of the following string: request url + ";" + name
java.lang.String	makeCSVRequestParams() Creates the request parameter string needed to pass info to the action handling the CSV exporting.
void	release() $
void	setDataset(java.lang.String nameIn) Sets the name of the dataset to use Tries to locate the list in the following order: page context, request attribute, session attribute
void	setExportColumns(java.lang.String exportIn)
void	setHeader(java.lang.String headerIn) Header is a string to go on the top of a CSV exported file, can be used to provide extra info to a user.
void	setName(java.lang.String nameIn) Stores the "name" of the list.
void	setupPageData()

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Field Detail

CSV_DOWNLOAD_URI

public static final java.lang.String CSV_DOWNLOAD_URI

See Also:

Constant Field Values

Constructor Detail

CSVTag

public CSVTag()

Method Detail

setName

public void setName(java.lang.String nameIn)

Stores the "name" of the list. This is the "salt" used to build the uniqueName used by the ListTag and ColumnTag.

Parameters:

nameIn - list name

getUniqueName

public java.lang.String getUniqueName()

Build the list's unique name Algorithm for the unique name is: Take the CRC value of the following string: request url + ";" + name

Returns:

unique name

setHeader

public void setHeader(java.lang.String headerIn)

Header is a string to go on the top of a CSV exported file, can be used to provide extra info to a user.

Parameters:

headerIn - optional text to be printed as first line of exported CSV file

getHeader

public java.lang.String getHeader()

Returns:

optional header text for CSV file

setDataset

public void setDataset(java.lang.String nameIn)
                throws javax.servlet.jsp.JspException

Sets the name of the dataset to use Tries to locate the list in the following order: page context, request attribute, session attribute

Parameters:

nameIn - name of dataset

Throws:

javax.servlet.jsp.JspException - indicates something went wrong

setupPageData

public void setupPageData()
                   throws javax.servlet.jsp.JspException

Throws:

javax.servlet.jsp.JspException - exception raised if datasetname is not defined

getExportColumns

public java.lang.String getExportColumns()

Returns:

Returns the exportColumns.

setExportColumns

public void setExportColumns(java.lang.String exportIn)

Parameters:

exportIn - The export to set.

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

$

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

$

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException

release

public void release()

$

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class javax.servlet.jsp.tagext.BodyTagSupport

makeCSVRequestParams

public java.lang.String makeCSVRequestParams()

Creates the request parameter string needed to pass info to the action handling the CSV exporting.

Returns:

String with request parameters for CSVDownloadAction