com.opensymphony.webwork.views.jasperreports
Class JasperReportsResult

java.lang.Object
  com.opensymphony.webwork.dispatcher.WebWorkResultSupport
      com.opensymphony.webwork.views.jasperreports.JasperReportsResult

All Implemented Interfaces:

JasperReportConstants, WebWorkStatics, com.opensymphony.xwork.Result, Serializable

public class JasperReportsResult
extends WebWorkResultSupport
implements JasperReportConstants

Generates a JasperReports report using the specified format or PDF if no format is specified.

This result type takes the following parameters:

• location (default) - the location where the compiled jasper report definition is (foo.jasper), relative from current URL.
• dataSource (required) - the Ognl expression used to retrieve the datasource from the value stack (usually a List).
• parse - true by default. If set to false, the location param will not be parsed for Ognl expressions.
• format - the format in which the report should be generated. Valid values can be found in JasperReportConstants. If no format is specified, PDF will be used.
• contentDisposition - disposition (defaults to "inline", values are typically filename="document.pdf").
• documentName - name of the document (will generate the http header Content-disposition = X; filename=X.[format]).
• delimiter - the delimiter used when generating CSV reports. By default, the character used is ",".
• imageServletUrl - name of the url that, when prefixed with the context page, can return report images.

This result follows the same rules from WebWorkResultSupport. Specifically, all parameters will be parsed if the "parse" parameter is not set to false.

Example:

 <result name="success" type="jasper">
   <param name="location">foo.jasper</param>
   <param name="dataSource">mySource</param>
   <param name="format">CSV</param>
 </result>
 

or for pdf

 <result name="success" type="jasper">
   <param name="location">foo.jasper</param>
   <param name="dataSource">mySource</param>
 </result>
 

Author:

Patrick Lightbody, Rainer Hermanns

See Also:

Serialized Form

Field Summary

protected String	contentDisposition
protected String	dataSource
protected String	delimiter
protected String	documentName
protected String	format
protected String	imageServletUrl

Fields inherited from class com.opensymphony.webwork.dispatcher.WebWorkResultSupport

DEFAULT_PARAM, encode, location, parse

Fields inherited from interface com.opensymphony.webwork.views.jasperreports.JasperReportConstants

FORMAT_CSV, FORMAT_HTML, FORMAT_PDF, FORMAT_RTF, FORMAT_XLS, FORMAT_XML

Fields inherited from interface com.opensymphony.webwork.WebWorkStatics

HTTP_REQUEST, HTTP_RESPONSE, PAGE_CONTEXT, SERVLET_CONTEXT, SERVLET_DISPATCHER

Constructor Summary

JasperReportsResult()

Method Summary

protected void	doExecute(String finalLocation, com.opensymphony.xwork.ActionInvocation invocation) Executes the result given a final location (jsp page, action, etc) and the action invocation (the state in which the action was executed).
String	getImageServletUrl()
void	setContentDisposition(String contentDisposition)
void	setDataSource(String dataSource)
void	setDelimiter(String delimiter)
void	setDocumentName(String documentName)
void	setFormat(String format)
void	setImageServletUrl(String imageServletUrl)

Methods inherited from class com.opensymphony.webwork.dispatcher.WebWorkResultSupport

conditionalParse, execute, setEncode, setLocation, setParse

Methods inherited from class java.lang.Object

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

Field Detail

dataSource

protected String dataSource

format

protected String format

documentName

protected String documentName

contentDisposition

protected String contentDisposition

delimiter

protected String delimiter

imageServletUrl

protected String imageServletUrl

Constructor Detail

JasperReportsResult

public JasperReportsResult()

Method Detail

getImageServletUrl

public String getImageServletUrl()

setImageServletUrl

public void setImageServletUrl(String imageServletUrl)

setDataSource

public void setDataSource(String dataSource)

setFormat

public void setFormat(String format)

setDocumentName

public void setDocumentName(String documentName)

setContentDisposition

public void setContentDisposition(String contentDisposition)

setDelimiter

public void setDelimiter(String delimiter)

doExecute

protected void doExecute(String finalLocation,
                         com.opensymphony.xwork.ActionInvocation invocation)
                  throws Exception

Description copied from class: WebWorkResultSupport

Executes the result given a final location (jsp page, action, etc) and the action invocation (the state in which the action was executed). Subclasses must implement this class to handle custom logic for result handling.

Specified by:

doExecute in class WebWorkResultSupport

Parameters:

finalLocation - the location (jsp page, action, etc) to go to.

invocation - the execution state of the action.

Throws:

Exception - if an error occurs while executing the result.