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

Constructor Summary

DynamicJasperHelper()

Method Summary

protected static void	compileOrLoadSubreports(DynamicReport dr, java.util.Map _parameters)
protected static DynamicJasperDesign	downCast(net.sf.jasperreports.engine.design.JasperDesign jd)
static boolean	existsGroupWithColumnNames(java.util.List groups) Returns true if at least one group is configured to show the column name in its header
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) Deprecated. use the overloaded version that needs a parameters Map
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 ColumnsGroup	getColumnGroup(AbstractColumn col, java.util.List groups)
protected static DynamicJasperDesign	getNewDesign(DynamicReport dr)
protected static void	populateReportOptionsFromDesign(DynamicJasperDesign jd, DynamicReport dr) Becasuse all the layout calculations are made from the Domain Model of DynamicJasper, when loading a template file, we have to populate the "ReportOptions" with the settings from the template file (ie: margins, etc)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicJasperHelper

public DynamicJasperHelper()

Method Detail

getNewDesign

protected static DynamicJasperDesign getNewDesign(DynamicReport dr)

generateJasperDesign

protected static DynamicJasperDesign generateJasperDesign(DynamicReport dr)
                                                   throws CoreException

Throws:

CoreException

registerParameters

protected static void registerParameters(DynamicJasperDesign jd,
                                         DynamicReport dr)

populateReportOptionsFromDesign

protected static void populateReportOptionsFromDesign(DynamicJasperDesign jd,
                                                      DynamicReport dr)

Becasuse all the layout calculations are made from the Domain Model of DynamicJasper, when loading a template file, we have to populate the "ReportOptions" with the settings from the template file (ie: margins, etc)

Parameters:

jd -

dr -

downCast

protected static DynamicJasperDesign downCast(net.sf.jasperreports.engine.design.JasperDesign jd)
                                       throws CoreException

Throws:

CoreException

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 net.sf.jasperreports.engine.JasperReport generateJasperReport(DynamicReport dr,
                                                                            LayoutManager layoutManager)
                                                                     throws net.sf.jasperreports.engine.JRException

Deprecated. use the overloaded version that needs a parameters Map

Generates a JasperReport object. If you have unregistered parameters (ie: inside a query) you should the overloaded version of this method passing in a parameter map the objects expected in order for DJ to register them.

Parameters:

dr -

layoutManager -

Returns:

Throws:

net.sf.jasperreports.engine.JRException

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

getColumnGroup

public static ColumnsGroup 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: