ar.com.fdvs.dj.core
Class DynamicJasperHelper

java.lang.Object
  ar.com.fdvs.dj.core.DynamicJasperHelper

public final class DynamicJasperHelper
extends java.lang.Object

Helper class for running a report and some other DJ related stuff

Field Summary

static java.lang.String

DEFAULT_XML_ENCODING

Constructor Summary

DynamicJasperHelper()

Method Summary

protected static void	compileOrLoadSubreports(DynamicReport dr, java.util.Map _parameters)
static boolean	existsGroupWithColumnNames(java.util.List groups) Returns true if at least one group is configured to show the column name in its header
static void	exportToHtml(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String imageServletUrl, DynamicReport dynamicReport, LayoutManager layoutManager, net.sf.jasperreports.engine.JRDataSource ds, java.util.Map parameters, java.util.Map exporterParams) Generates the report as HTML and setups everything for a clean response (serving images as well).
protected static DynamicJasperDesign	generateJasperDesign(DynamicReport dr)
static net.sf.jasperreports.engine.JasperPrint	generateJasperPrint(DynamicReport dr, LayoutManager layoutManager, java.util.Collection collection)
static net.sf.jasperreports.engine.JasperPrint	generateJasperPrint(DynamicReport dr, LayoutManager layoutManager, java.sql.Connection con, java.util.Map _parameters) For running queries embebed in the report design
static net.sf.jasperreports.engine.JasperPrint	generateJasperPrint(DynamicReport dr, LayoutManager layoutManager, net.sf.jasperreports.engine.JRDataSource ds)
static net.sf.jasperreports.engine.JasperPrint	generateJasperPrint(DynamicReport dr, LayoutManager layoutManager, net.sf.jasperreports.engine.JRDataSource ds, java.util.Map _parameters) Compiles and fills the reports design.
static net.sf.jasperreports.engine.JasperPrint	generateJasperPrint(DynamicReport dr, LayoutManager layoutManager, java.util.Map _parameters) For compiling and filling reports whose datasource is passed as parameter (e.g.
static net.sf.jasperreports.engine.JasperPrint	generateJasperPrint(DynamicReport dr, LayoutManager layoutManager, java.sql.ResultSet resultSet)
static net.sf.jasperreports.engine.JasperReport	generateJasperReport(DynamicReport dr, LayoutManager layoutManager, java.util.Map generatedParams) Compiles the report and applies the layout.
static java.lang.String	generateJRXML(DynamicReport dr, LayoutManager layoutManager, java.util.Map _parameters, java.lang.String xmlEncoding) Creates a jrxml file
static void	generateJRXML(DynamicReport dr, LayoutManager layoutManager, java.util.Map _parameters, java.lang.String xmlEncoding, java.io.OutputStream outputStream) Creates a jrxml file
static void	generateJRXML(DynamicReport dr, LayoutManager layoutManager, java.util.Map _parameters, java.lang.String xmlEncoding, java.lang.String filename) Creates a jrxml file
static DJGroup	getColumnGroup(AbstractColumn col, java.util.List groups)
protected static void	registerParameters(DynamicJasperDesign jd, DynamicReport dr)
static void	registerParams(DynamicJasperDesign jd, java.util.Map _parameters) For every String key, it registers the object as a parameter to make it available in the report.
protected static void	visitSubreport(DynamicReport parentDr, Subreport subreport, java.util.Map _parameters)
protected static void	visitSubreports(DynamicReport dr, java.util.Map _parameters) Performs any needed operation on subreports after they are built like ensuring proper subreport with if "fitToParentPrintableArea" flag is set to true

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_XML_ENCODING

public static final java.lang.String DEFAULT_XML_ENCODING

See Also:

Constant Field Values

Constructor Detail

DynamicJasperHelper

public DynamicJasperHelper()

Method Detail

generateJasperDesign

protected static DynamicJasperDesign generateJasperDesign(DynamicReport dr)
                                                   throws CoreException

Throws:

CoreException

registerParameters

protected static void registerParameters(DynamicJasperDesign jd,
                                         DynamicReport dr)

generateJasperPrint

public static net.sf.jasperreports.engine.JasperPrint generateJasperPrint(DynamicReport dr,
                                                                          LayoutManager layoutManager,
                                                                          net.sf.jasperreports.engine.JRDataSource ds)
                                                                   throws net.sf.jasperreports.engine.JRException

Throws:

net.sf.jasperreports.engine.JRException

generateJasperPrint

public static net.sf.jasperreports.engine.JasperPrint generateJasperPrint(DynamicReport dr,
                                                                          LayoutManager layoutManager,
                                                                          java.util.Collection collection)
                                                                   throws net.sf.jasperreports.engine.JRException

Throws:

net.sf.jasperreports.engine.JRException

generateJasperPrint

public static net.sf.jasperreports.engine.JasperPrint generateJasperPrint(DynamicReport dr,
                                                                          LayoutManager layoutManager,
                                                                          java.sql.ResultSet resultSet)
                                                                   throws net.sf.jasperreports.engine.JRException

Throws:

net.sf.jasperreports.engine.JRException

generateJasperPrint

public static net.sf.jasperreports.engine.JasperPrint generateJasperPrint(DynamicReport dr,
                                                                          LayoutManager layoutManager,
                                                                          net.sf.jasperreports.engine.JRDataSource ds,
                                                                          java.util.Map _parameters)
                                                                   throws net.sf.jasperreports.engine.JRException

Compiles and fills the reports design.

Parameters:

dr - the DynamicReport

layoutManager - the object in charge of doing the layout

ds - The datasource

_parameters - Map with parameters that the report may need

Returns:

Throws:

net.sf.jasperreports.engine.JRException

generateJasperPrint

public static net.sf.jasperreports.engine.JasperPrint generateJasperPrint(DynamicReport dr,
                                                                          LayoutManager layoutManager,
                                                                          java.sql.Connection con,
                                                                          java.util.Map _parameters)
                                                                   throws net.sf.jasperreports.engine.JRException

For running queries embebed in the report design

Parameters:

dr -

layoutManager -

con -

_parameters -

Returns:

Throws:

net.sf.jasperreports.engine.JRException

generateJasperPrint

public static net.sf.jasperreports.engine.JasperPrint generateJasperPrint(DynamicReport dr,
                                                                          LayoutManager layoutManager,
                                                                          java.util.Map _parameters)
                                                                   throws net.sf.jasperreports.engine.JRException

For compiling and filling reports whose datasource is passed as parameter (e.g. Hibernate, Mondrean, etc.)

Parameters:

dr -

layoutManager -

_parameters -

Returns:

Throws:

net.sf.jasperreports.engine.JRException

generateJRXML

public static java.lang.String generateJRXML(DynamicReport dr,
                                             LayoutManager layoutManager,
                                             java.util.Map _parameters,
                                             java.lang.String xmlEncoding)
                                      throws net.sf.jasperreports.engine.JRException

Creates a jrxml file

Parameters:

dr -

layoutManager -

_parameters -

xmlEncoding - (default is UTF-8 )

Returns:

Throws:

net.sf.jasperreports.engine.JRException

generateJRXML

public static void generateJRXML(DynamicReport dr,
                                 LayoutManager layoutManager,
                                 java.util.Map _parameters,
                                 java.lang.String xmlEncoding,
                                 java.io.OutputStream outputStream)
                          throws net.sf.jasperreports.engine.JRException

Creates a jrxml file

Parameters:

dr -

layoutManager -

_parameters -

xmlEncoding - (default is UTF-8 )

outputStream -

Throws:

net.sf.jasperreports.engine.JRException

generateJRXML

public static void generateJRXML(DynamicReport dr,
                                 LayoutManager layoutManager,
                                 java.util.Map _parameters,
                                 java.lang.String xmlEncoding,
                                 java.lang.String filename)
                          throws net.sf.jasperreports.engine.JRException

Creates a jrxml file

Parameters:

dr -

layoutManager -

_parameters -

xmlEncoding - (default is UTF-8 )

filename - the path to the destination file

Throws:

net.sf.jasperreports.engine.JRException

compileOrLoadSubreports

protected static void compileOrLoadSubreports(DynamicReport dr,
                                              java.util.Map _parameters)
                                       throws net.sf.jasperreports.engine.JRException

Throws:

net.sf.jasperreports.engine.JRException

registerParams

public static void registerParams(DynamicJasperDesign jd,
                                  java.util.Map _parameters)

For every String key, it registers the object as a parameter to make it available in the report.

Parameters:

jd -

_parameters -

generateJasperReport

public static final net.sf.jasperreports.engine.JasperReport generateJasperReport(DynamicReport dr,
                                                                                  LayoutManager layoutManager,
                                                                                  java.util.Map generatedParams)
                                                                           throws net.sf.jasperreports.engine.JRException

Compiles the report and applies the layout. generatedParams MUST NOT BE NULL All the key objects from the generatedParams map that are String, will be registered as parameters of the report.

Parameters:

dr -

layoutManager -

generatedParams -

Returns:

Throws:

net.sf.jasperreports.engine.JRException

visitSubreports

protected static void visitSubreports(DynamicReport dr,
                                      java.util.Map _parameters)
                               throws net.sf.jasperreports.engine.JRException

Performs any needed operation on subreports after they are built like ensuring proper subreport with if "fitToParentPrintableArea" flag is set to true

Parameters:

dr -

_parameters -

Throws:

net.sf.jasperreports.engine.JRException

visitSubreport

protected static void visitSubreport(DynamicReport parentDr,
                                     Subreport subreport,
                                     java.util.Map _parameters)

getColumnGroup

public static DJGroup getColumnGroup(AbstractColumn col,
                                     java.util.List groups)

existsGroupWithColumnNames

public static boolean existsGroupWithColumnNames(java.util.List groups)

Returns true if at least one group is configured to show the column name in its header

Parameters:

groups -

Returns:

exportToHtml

public static void exportToHtml(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                java.lang.String imageServletUrl,
                                DynamicReport dynamicReport,
                                LayoutManager layoutManager,
                                net.sf.jasperreports.engine.JRDataSource ds,
                                java.util.Map parameters,
                                java.util.Map exporterParams)
                         throws net.sf.jasperreports.engine.JRException,
                                java.io.IOException

Generates the report as HTML and setups everything for a clean response (serving images as well). You have to declare JasperReport servlet in web.xml (net.sf.jasperreports.j2ee.servlets.ImageServlet)

Web XML must be configured somehow like this:

<servlet>
<servlet-name>image</servlet-name>
<servlet-class>net.sf.jasperreports.j2ee.servlets.ImageServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>image</servlet-name>
<url-pattern>/reports/image</url-pattern>
</servlet-mapping>


Parameters:

request -

response -

imageServletUrl - the URI to reach net.sf.jasperreports.j2ee.servlets.ImageServlet servlet (in example it would be "reports/image")

dynamicReport -

layoutManager -

ds -

parameters - Parameters for the DynamicReport

exporterParams - Extra parameters for JasperReport's HTML exporter (HTMLJRHtmlExporter)

Throws:

net.sf.jasperreports.engine.JRException

java.io.IOException