org.apache.struts2.views.jasperreports
Class JasperReportsResult
java.lang.Object
org.apache.struts2.dispatcher.StrutsResultSupport
org.apache.struts2.views.jasperreports.JasperReportsResult
- All Implemented Interfaces:
- com.opensymphony.xwork2.Result, java.io.Serializable, org.apache.struts2.StrutsStatics, JasperReportConstants
public class JasperReportsResult
- extends org.apache.struts2.dispatcher.StrutsResultSupport
- 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 EL 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 EL 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.
-
reportParameters - (2.1.2+) OGNL expression used to retrieve a map of
report parameters from the value stack. The parameters may be accessed
in the report via the usual JR mechanism and might include data not
part of the dataSource, such as the user name of the report creator, etc.
-
exportParameters - (2.1.2+) OGNL expression used to retrieve a map of
JR exporter parameters from the value stack. The export parameters are
used to customize the JR export. For example, a PDF export might enable
encryption and set the user password to a string known to the report creator.
This result follows the same rules from StrutsResultSupport
.
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>
- See Also:
- Serialized Form
Field Summary |
protected java.lang.String |
contentDisposition
|
protected java.lang.String |
dataSource
|
protected java.lang.String |
delimiter
|
protected java.lang.String |
documentName
|
protected java.lang.String |
exportParameters
Names an exporter parameters map stack value,
allowing the use of custom export parameters. |
protected java.lang.String |
format
|
protected java.lang.String |
imageServletUrl
|
protected java.lang.String |
reportParameters
Names a report parameters map stack value, allowing
additional report parameters from the action. |
Fields inherited from class org.apache.struts2.dispatcher.StrutsResultSupport |
DEFAULT_PARAM |
Fields inherited from interface org.apache.struts2.StrutsStatics |
HTTP_REQUEST, HTTP_RESPONSE, PAGE_CONTEXT, SERVLET_CONTEXT, SERVLET_DISPATCHER, STRUTS_PORTLET_CONTEXT |
Methods inherited from class org.apache.struts2.dispatcher.StrutsResultSupport |
conditionalParse, execute, getLastFinalLocation, getLocation, setEncode, setLocation, setParse |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
dataSource
protected java.lang.String dataSource
format
protected java.lang.String format
documentName
protected java.lang.String documentName
contentDisposition
protected java.lang.String contentDisposition
delimiter
protected java.lang.String delimiter
imageServletUrl
protected java.lang.String imageServletUrl
reportParameters
protected java.lang.String reportParameters
- Names a report parameters map stack value, allowing
additional report parameters from the action.
exportParameters
protected java.lang.String exportParameters
- Names an exporter parameters map stack value,
allowing the use of custom export parameters.
JasperReportsResult
public JasperReportsResult()
- Default ctor.
JasperReportsResult
public JasperReportsResult(java.lang.String location)
- Default ctor with location.
- Parameters:
location
- Result location.
getImageServletUrl
public java.lang.String getImageServletUrl()
setImageServletUrl
public void setImageServletUrl(java.lang.String imageServletUrl)
setDataSource
public void setDataSource(java.lang.String dataSource)
setFormat
public void setFormat(java.lang.String format)
setDocumentName
public void setDocumentName(java.lang.String documentName)
setContentDisposition
public void setContentDisposition(java.lang.String contentDisposition)
setDelimiter
public void setDelimiter(java.lang.String delimiter)
getReportParameters
public java.lang.String getReportParameters()
setReportParameters
public void setReportParameters(java.lang.String reportParameters)
getExportParameters
public java.lang.String getExportParameters()
setExportParameters
public void setExportParameters(java.lang.String exportParameters)
doExecute
protected void doExecute(java.lang.String finalLocation,
com.opensymphony.xwork2.ActionInvocation invocation)
throws java.lang.Exception
- Specified by:
doExecute
in class org.apache.struts2.dispatcher.StrutsResultSupport
- Throws:
java.lang.Exception
Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.