/*
* Dynamic Jasper: A library for creating reports dynamically by specifying
* columns, groups, styles, etc. at runtime. It also saves a lot of development
* time in many cases! (http://sourceforge.net/projects/dynamicjasper)
*
* Copyright (C) 2008 FDV Solutions (http://www.fdvsolutions.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
*
* License as published by the Free Software Foundation; either
*
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
*
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
*
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
*
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
*
*/
package ar.com.fdvs.dj.core;
import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.lang.reflect.InvocationTargetException;
import java.net.URL;
import java.sql.Connection;
import java.sql.ResultSet;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.MissingResourceException;
import java.util.ResourceBundle;
import net.sf.jasperreports.engine.JRDataSource;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRParameter;
import net.sf.jasperreports.engine.JRResultSetDataSource;
import net.sf.jasperreports.engine.JRStyle;
import net.sf.jasperreports.engine.JasperCompileManager;
import net.sf.jasperreports.engine.JasperFillManager;
import net.sf.jasperreports.engine.JasperPrint;
import net.sf.jasperreports.engine.JasperReport;
import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource;
import net.sf.jasperreports.engine.design.JRDesignBand;
import net.sf.jasperreports.engine.design.JRDesignField;
import net.sf.jasperreports.engine.design.JRDesignParameter;
import net.sf.jasperreports.engine.design.JRDesignQuery;
import net.sf.jasperreports.engine.design.JasperDesign;
import net.sf.jasperreports.engine.util.JRProperties;
import net.sf.jasperreports.engine.xml.JRXmlLoader;
import net.sf.jasperreports.engine.xml.JRXmlWriter;
import org.apache.commons.beanutils.BeanUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import ar.com.fdvs.dj.core.layout.LayoutManager;
import ar.com.fdvs.dj.core.registration.ColumnRegistrationManager;
import ar.com.fdvs.dj.core.registration.ColumnsGroupRegistrationManager;
import ar.com.fdvs.dj.domain.ColumnProperty;
import ar.com.fdvs.dj.domain.DynamicJasperDesign;
import ar.com.fdvs.dj.domain.DynamicReport;
import ar.com.fdvs.dj.domain.DynamicReportOptions;
import ar.com.fdvs.dj.domain.constants.Page;
import ar.com.fdvs.dj.domain.entities.ColumnsGroup;
import ar.com.fdvs.dj.domain.entities.Parameter;
import ar.com.fdvs.dj.domain.entities.Subreport;
import ar.com.fdvs.dj.domain.entities.columns.AbstractColumn;
import ar.com.fdvs.dj.util.DJCompilerFactory;
/**
* Helper class for running a report and some other DJ related stuff
*/
public final class DynamicJasperHelper {
private static final Log log = LogFactory.getLog(DynamicJasperHelper.class);
private static final String DJ_RESOURCE_BUNDLE ="dj-messages";
private final static void registerEntities(DynamicJasperDesign jd, DynamicReport dr) {
new ColumnRegistrationManager(jd,dr).registerEntities(dr.getColumns());
new ColumnsGroupRegistrationManager(jd,dr).registerEntities(dr.getColumnsGroups());
registerOtherFields(jd,dr.getFields());
Locale locale = dr.getReportLocale() == null ? Locale.getDefault() : dr.getReportLocale();
ResourceBundle messages = null;
if (dr.getResourceBundle() != null ){
try {
messages = ResourceBundle.getBundle(dr.getResourceBundle(), locale);
} catch (MissingResourceException e){ log.warn(e.getMessage() + ", usign defaut (dj-messages)");}
}
if (messages == null) {
try {
messages = ResourceBundle.getBundle(DJ_RESOURCE_BUNDLE, locale);
} catch (MissingResourceException e){ log.warn(e.getMessage() + ", usign defaut (dj-messages)");}
finally {
messages = ResourceBundle.getBundle(DJ_RESOURCE_BUNDLE, Locale.ENGLISH); //this cannot fail because is included in the DJ jar
}
}
jd.getParametersWithValues().put(JRDesignParameter.REPORT_RESOURCE_BUNDLE, messages);
jd.getParametersWithValues().put(JRDesignParameter.REPORT_LOCALE, locale);
// JRDesignParameter.REPORT_RESOURCE_BUNDLE
// report.
}
private static void registerOtherFields(DynamicJasperDesign jd, List fields) {
for (Iterator iter = fields.iterator(); iter.hasNext();) {
ColumnProperty element = (ColumnProperty) iter.next();
JRDesignField field = new JRDesignField();
field.setValueClassName(element.getValueClassName());
field.setName(element.getProperty());
try {
jd.addField(field);
} catch (JRException e) {
// e.printStackTrace();
//if the field is already registered, it's not a problem
log.warn(e.getMessage(),e);
}
}
}
protected static DynamicJasperDesign getNewDesign(DynamicReport dr) {
log.info("obtaining DynamicJasperDesign instance");
DynamicJasperDesign des = new DynamicJasperDesign();
DynamicReportOptions options = dr.getOptions();
Page page = options.getPage();
des.setColumnCount(options.getColumnsPerPage().intValue());
des.setPrintOrder(JasperDesign.PRINT_ORDER_VERTICAL);
des.setPageWidth(page.getWidth());
des.setPageHeight(page.getHeight());
des.setColumnWidth(options.getColumnWidth());
des.setColumnSpacing(options.getColumnSpace().intValue());
des.setLeftMargin(options.getLeftMargin().intValue());
des.setRightMargin(options.getRightMargin().intValue());
des.setTopMargin(options.getTopMargin().intValue());
des.setBottomMargin(options.getBottomMargin().intValue());
des.setWhenNoDataType(dr.getWhenNoDataType());
des.setWhenResourceMissingType(dr.getWhenResourceMissing());
des.setTitleNewPage(false);
des.setSummaryNewPage(false);
des.setDetail(new JRDesignBand());
des.getDetail().setSplitAllowed(dr.isAllowDetailSplit());
des.setPageHeader(new JRDesignBand());
des.setPageFooter(new JRDesignBand());
des.setSummary(new JRDesignBand());
des.setTitleNewPage(options.isTitleNewPage());
des.setIgnorePagination(options.isIgnorePagination());
if (dr.getQuery() != null){
JRDesignQuery query = getJRDesignQuery(dr);
des.setQuery(query);
}
des.setName("DynamicReport");
return des;
}
protected static DynamicJasperDesign generateJasperDesign(DynamicReport dr) throws CoreException {
DynamicJasperDesign jd = null;
try {
if (dr.getTemplateFileName() != null) {
log.info("loading template file: "+dr.getTemplateFileName());
log.info("Attemping to find the file directly in the file system...");
File file = new File(dr.getTemplateFileName());
if (file.exists()){
JasperDesign jdesign = JRXmlLoader.load(file);
jd = downCast(jdesign);
} else {
log.info("Not found: Attemping to find the file in the classpath...");
URL url = DynamicJasperHelper.class.getClassLoader().getResource(
dr.getTemplateFileName());
JasperDesign jdesign = JRXmlLoader.load(url.openStream());
jd = downCast(jdesign);
}
populateReportOptionsFromDesign(jd,dr);
} else {
//Create new JasperDesign from the scratch
jd = getNewDesign(dr);
}
registerParameters(jd,dr);
} catch (JRException e) {
throw new CoreException(e.getMessage(),e);
} catch (IOException e) {
throw new CoreException(e.getMessage(),e);
}
return jd;
}
protected static void registerParameters(DynamicJasperDesign jd, DynamicReport dr) {
for (Iterator iterator = dr.getParameters().iterator(); iterator.hasNext();) {
Parameter param= (Parameter) iterator.next();
JRDesignParameter jrparam = new JRDesignParameter();
jrparam.setName(param.getName());
jrparam.setValueClassName(param.getClassName());
try {
jd.addParameter(jrparam);
} catch (JRException e) {
throw new CoreException(e.getMessage(),e);
}
}
}
/**
* 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)
* @param jd
* @param dr
*/
protected static void populateReportOptionsFromDesign(DynamicJasperDesign jd, DynamicReport dr) {
DynamicReportOptions options = dr.getOptions();
options.setBottomMargin(new Integer(jd.getBottomMargin()));
options.setTopMargin(new Integer(jd.getTopMargin()));
options.setLeftMargin(new Integer(jd.getLeftMargin()));
options.setRightMargin(new Integer(jd.getRightMargin()));
options.setColumnSpace(new Integer(jd.getColumnSpacing()));
options.setColumnsPerPage(new Integer(jd.getColumnCount()));
options.setPage(new Page(jd.getPageHeight(),jd.getPageWidth()));
if (dr.getQuery() != null){
JRDesignQuery query = getJRDesignQuery(dr);
jd.setQuery(query);
}
}
/**
* @param dr
* @return
*/
private static JRDesignQuery getJRDesignQuery(DynamicReport dr) {
JRDesignQuery query = new JRDesignQuery();
query.setText(dr.getQuery().getText());
query.setLanguage(dr.getQuery().getLanguage());
return query;
}
protected static DynamicJasperDesign downCast(JasperDesign jd) throws CoreException {
DynamicJasperDesign djd = new DynamicJasperDesign();
log.info("downcasting JasperDesign");
try {
BeanUtils.copyProperties(djd, jd);
//BeanUtils.copyProperties does not perform deep copy,
//adding original parameter definitions manually
for (Iterator iter = jd.getParametersList().iterator(); iter.hasNext();) {
JRParameter element = (JRParameter) iter.next();
try {
djd.addParameter(element);
} catch (JRException e) { }
}
//Add all existing styles in the design to the new one
for (Iterator iterator = jd.getStylesList().iterator(); iterator.hasNext();) {
JRStyle style = (JRStyle) iterator.next();
try {
djd.addStyle(style);
} catch (JRException e) {
log.warn("Duplicated style (style name \""+ style.getName()+"\") when loading design: " + e.getMessage(), e);
}
}
} catch (IllegalAccessException e) {
throw new CoreException(e.getMessage());
} catch (InvocationTargetException e) {
throw new CoreException(e.getMessage());
}
return djd;
}
public static JasperPrint generateJasperPrint(DynamicReport dr, LayoutManager layoutManager, JRDataSource ds) throws JRException {
return generateJasperPrint(dr, layoutManager, ds, new HashMap());
}
public static JasperPrint generateJasperPrint(DynamicReport dr, LayoutManager layoutManager, Collection collection) throws JRException {
JRDataSource ds = new JRBeanCollectionDataSource(collection);
return generateJasperPrint(dr, layoutManager, ds, new HashMap());
}
public static JasperPrint generateJasperPrint(DynamicReport dr, LayoutManager layoutManager, ResultSet resultSet) throws JRException {
JRDataSource ds = new JRResultSetDataSource(resultSet);
return generateJasperPrint(dr, layoutManager, ds, new HashMap());
}
/**
* Compiles and fills the reports design.
*
* @param dr the DynamicReport
* @param layoutManager the object in charge of doing the layout
* @param ds The datasource
* @param _parameters Map with parameters that the report may need
* @return
* @throws JRException
*/
public static JasperPrint generateJasperPrint(DynamicReport dr, LayoutManager layoutManager, JRDataSource ds, Map _parameters) throws JRException {
log.info("generating JasperPrint");
JasperPrint jp = null;
if (_parameters == null)
_parameters = new HashMap();
compileOrLoadSubreports(dr, _parameters);
DynamicJasperDesign jd = generateJasperDesign(dr);
Map params = new HashMap();
if (!_parameters.isEmpty()){
registerParams(jd,_parameters);
params.putAll(_parameters);
}
registerEntities(jd, dr);
layoutManager.applyLayout(jd, dr);
JRProperties.setProperty(JRProperties.COMPILER_CLASS, DJCompilerFactory.getCompilerClassName());
// JRDesignReportFont reportFont = new JRDesignReportFont();
// reportFont.setName("Cocaine Sans Normal");
// reportFont.setFontSize(28);
// jd.addFont(reportFont);
JasperReport jr = JasperCompileManager.compileReport(jd);
params.putAll(jd.getParametersWithValues());
jp = JasperFillManager.fillReport(jr, params, ds);
return jp;
}
/**
* For running queries embebed in the report design
* @param dr
* @param layoutManager
* @param con
* @param _parameters
* @return
* @throws JRException
*/
public static JasperPrint generateJasperPrint(DynamicReport dr, LayoutManager layoutManager, Connection con, Map _parameters) throws JRException {
log.info("generating JasperPrint");
JasperPrint jp = null;
if (_parameters == null)
_parameters = new HashMap();
compileOrLoadSubreports(dr, _parameters);
DynamicJasperDesign jd = generateJasperDesign(dr);
Map params = new HashMap();
if (!_parameters.isEmpty()){
registerParams(jd,_parameters);
params.putAll(_parameters);
}
registerEntities(jd, dr);
layoutManager.applyLayout(jd, dr);
JRProperties.setProperty(JRProperties.COMPILER_CLASS, DJCompilerFactory.getCompilerClassName());
JasperReport jr = JasperCompileManager.compileReport(jd);
params.putAll(jd.getParametersWithValues());
jp = JasperFillManager.fillReport(jr, params, con);
return jp;
}
/**
* For compiling and filling reports whose datasource is passed as parameter (e.g. Hibernate, Mondrean, etc.)
* @param dr
* @param layoutManager
* @param _parameters
* @return
* @throws JRException
*/
public static JasperPrint generateJasperPrint(DynamicReport dr, LayoutManager layoutManager, Map _parameters) throws JRException {
log.info("generating JasperPrint");
JasperPrint jp = null;
if (_parameters == null)
_parameters = new HashMap();
compileOrLoadSubreports(dr, _parameters);
DynamicJasperDesign jd = generateJasperDesign(dr);
Map params = new HashMap();
if (!_parameters.isEmpty()){
registerParams(jd,_parameters);
params.putAll(_parameters);
}
registerEntities(jd, dr);
layoutManager.applyLayout(jd, dr);
JRProperties.setProperty(JRProperties.COMPILER_CLASS, DJCompilerFactory.getCompilerClassName());
JasperReport jr = JasperCompileManager.compileReport(jd);
params.putAll(jd.getParametersWithValues());
jp = JasperFillManager.fillReport(jr, params);
return jp;
}
/**
* Creates a jrxml file
* @param dr
* @param layoutManager
* @param _parameters
* @param xmlEncoding (default is UTF-8 )
* @return
* @throws JRException
*/
public static String generateJRXML(DynamicReport dr, LayoutManager layoutManager, Map _parameters, String xmlEncoding) throws JRException {
JasperReport jr = generateJasperReport(dr, layoutManager, _parameters);
if (xmlEncoding == null)
xmlEncoding = "UTF-8";
return JRXmlWriter.writeReport(jr, xmlEncoding);
}
/**
* Creates a jrxml file
* @param dr
* @param layoutManager
* @param _parameters
* @param xmlEncoding (default is UTF-8 )
* @param outputStream
* @throws JRException
*/
public static void generateJRXML(DynamicReport dr, LayoutManager layoutManager, Map _parameters, String xmlEncoding, OutputStream outputStream) throws JRException {
JasperReport jr = generateJasperReport(dr, layoutManager, _parameters);
if (xmlEncoding == null)
xmlEncoding = "UTF-8";
JRXmlWriter.writeReport(jr, outputStream, xmlEncoding);
}
/**
* Creates a jrxml file
* @param dr
* @param layoutManager
* @param _parameters
* @param xmlEncoding (default is UTF-8 )
* @param filename the path to the destination file
* @throws JRException
*/
public static void generateJRXML(DynamicReport dr, LayoutManager layoutManager, Map _parameters, String xmlEncoding, String filename) throws JRException {
JasperReport jr = generateJasperReport(dr, layoutManager, _parameters);
if (xmlEncoding == null)
xmlEncoding = "UTF-8";
JRXmlWriter.writeReport(jr, filename, xmlEncoding);
}
protected static void compileOrLoadSubreports(DynamicReport dr, Map _parameters) throws JRException {
for (Iterator iterator = dr.getColumnsGroups().iterator(); iterator.hasNext();) {
ColumnsGroup group = (ColumnsGroup) iterator.next();
//Header Subreports
for (Iterator iterator2 = group.getHeaderSubreports().iterator(); iterator2.hasNext();) {
Subreport subreport = (Subreport) iterator2.next();
if (subreport.getDynamicReport() != null){
compileOrLoadSubreports(subreport.getDynamicReport(),_parameters);
JasperReport jp = generateJasperReport(subreport.getDynamicReport(), subreport.getLayoutManager(), _parameters);
_parameters.put(jp.toString(), jp);
subreport.setReport(jp);
}
}
//Footer Subreports
for (Iterator iterator2 = group.getFooterSubreports().iterator(); iterator2.hasNext();) {
Subreport subreport = (Subreport) iterator2.next();
if (subreport.getDynamicReport() != null){
compileOrLoadSubreports(subreport.getDynamicReport(),_parameters);
JasperReport jp = generateJasperReport(subreport.getDynamicReport(), subreport.getLayoutManager(), _parameters);
_parameters.put(jp.toString(), jp);
subreport.setReport(jp);
}
}
}
}
/**
* For every String key, it registers the object as a parameter to make it available
* in the report.
* @param jd
* @param _parameters
*/
public static void registerParams(DynamicJasperDesign jd, Map _parameters) {
for (Iterator iterator = _parameters.keySet().iterator(); iterator.hasNext();) {
Object key = iterator.next();
if (key instanceof String){
try {
if (jd.getParametersMap().get(key) != null){
log.warn("Parameter \"" + key + "\" already registered, skipping this one.");
continue;
}
JRDesignParameter parameter = new JRDesignParameter();
Object value = _parameters.get(key);
// parameter.setValueClassName(value.getClass().getCanonicalName());
Class clazz = value.getClass().getComponentType();
if (clazz == null)
clazz = value.getClass();
parameter.setValueClass(clazz); //NOTE this is very strange
//when using an array as subreport-data-source, I must pass the parameter class name like this: value.getClass().getComponentType()
parameter.setName((String)key);
jd.addParameter(parameter);
} catch (JRException e) {
//nothing to do
}
}
}
}
/**
* 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.
* @param dr
* @param layoutManager
* @return
* @throws JRException
*
* @deprecated use the overloaded version that needs a parameters Map
*/
public static JasperReport generateJasperReport(DynamicReport dr, LayoutManager layoutManager) throws JRException {
log.info("generating JasperReport");
JasperReport jr = null;
DynamicJasperDesign jd = generateJasperDesign(dr);
registerEntities(jd, dr);
layoutManager.applyLayout(jd, dr);
JRProperties.setProperty(JRProperties.COMPILER_CLASS, "ar.com.fdvs.dj.util.DJJRJdtCompiler");
jr = JasperCompileManager.compileReport(jd);
return jr;
}
/**
* Compiles the report and applies the layout. <b>generatedParams</b> MUST NOT BE NULL
* All the key objects from the generatedParams map that are String, will be registered as parameters of the report.
* @param dr
* @param layoutManager
* @param generatedParams
* @return
* @throws JRException
*/
public final static JasperReport generateJasperReport(DynamicReport dr, LayoutManager layoutManager, Map generatedParams) throws JRException {
log.info("generating JasperReport");
JasperReport jr = null;
if (generatedParams == null)
generatedParams = new HashMap();
compileOrLoadSubreports(dr, generatedParams);
DynamicJasperDesign jd = generateJasperDesign(dr);
registerEntities(jd, dr);
registerParams(jd, generatedParams); //if we have parameters from the outside, we register them
layoutManager.applyLayout(jd, dr);
JRProperties.setProperty(JRProperties.COMPILER_CLASS, "ar.com.fdvs.dj.util.DJJRJdtCompiler");
jr = JasperCompileManager.compileReport(jd);
generatedParams.putAll(jd.getParametersWithValues());
return jr;
}
public static ColumnsGroup getColumnGroup(AbstractColumn col, List groups) {
Iterator it = groups.iterator();
while (it.hasNext()) {
ColumnsGroup group = (ColumnsGroup) it.next();
if (group.getColumnToGroupBy().equals(col))
return group;
}
return null;
}
/**
* Returns true if at least one group is configured to show the column name in its header
* @param groups
* @return
*/
public static boolean existsGroupWithColumnNames(List groups) {
Iterator it = groups.iterator();
while (it.hasNext()) {
ColumnsGroup group = (ColumnsGroup) it.next();
if (group.getLayout().isShowColumnName())
return true;
}
return false;
}
}