/*
* DynamicJasper: 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.lang.reflect.InvocationTargetException;
import java.util.Iterator;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRField;
import net.sf.jasperreports.engine.JRParameter;
import net.sf.jasperreports.engine.JRQuery;
import net.sf.jasperreports.engine.JRStyle;
import net.sf.jasperreports.engine.JRVariable;
import net.sf.jasperreports.engine.JasperReport;
import net.sf.jasperreports.engine.design.JRDesignBand;
import net.sf.jasperreports.engine.design.JRDesignDataset;
import net.sf.jasperreports.engine.design.JRDesignQuery;
import net.sf.jasperreports.engine.design.JRDesignVariable;
import net.sf.jasperreports.engine.design.JasperDesign;
import org.apache.commons.beanutils.BeanUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import ar.com.fdvs.dj.domain.DJQuery;
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;
public class DJJRDesignHelper {
private static final Log log = LogFactory.getLog(DJJRDesignHelper.class);
public 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);
byte orientation = page.isOrientationPortrait() ? JasperReport.ORIENTATION_PORTRAIT : JasperReport.ORIENTATION_LANDSCAPE;
des.setOrientation(orientation);
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);
}
for (Iterator iterator = dr.getProperties().keySet().iterator(); iterator.hasNext();) {
String name = (String) iterator.next();
des.setProperty(name, (String) dr.getProperties().get(name));
}
des.setName(dr.getReportName() != null ? dr.getReportName() : "DynamicReport");
return des;
}
protected static JRDesignQuery getJRDesignQuery(DynamicReport dr) {
JRDesignQuery query = new JRDesignQuery();
query.setText(dr.getQuery().getText());
query.setLanguage(dr.getQuery().getLanguage());
return query;
}
public static DynamicJasperDesign downCast(JasperDesign jd, DynamicReport dr) 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
if (dr.isTemplateImportParameters()){
for (Iterator iter = jd.getParametersList().iterator(); iter.hasNext();) {
JRParameter element = (JRParameter) iter.next();
try {
djd.addParameter(element);
} catch (JRException e) {
if (log.isDebugEnabled()){
log.warn(e.getMessage());
}
}
}
}
//BeanUtils.copyProperties does not perform deep copy,
//adding original fields definitions manually
if (dr.isTemplateImportFields()){
for (Iterator iter = jd.getFieldsList().iterator(); iter.hasNext();) {
JRField element = (JRField) iter.next();
try {
djd.addField(element);
} catch (JRException e) {
if (log.isDebugEnabled()){
log.warn(e.getMessage());
}
}
}
}
//BeanUtils.copyProperties does not perform deep copy,
//adding original variables definitions manually
if (dr.isTemplateImportVariables()){
for (Iterator iter = jd.getVariablesList().iterator(); iter.hasNext();) {
JRVariable element = (JRVariable) iter.next();
try {
if (element instanceof JRDesignVariable){
djd.addVariable((JRDesignVariable) element);
}
} catch (JRException e) {
if (log.isDebugEnabled()){
log.warn(e.getMessage());
}
}
}
}
//BeanUtils.copyProperties does not perform deep copy,
//adding original dataset definitions manually
if (dr.isTemplateImportDatasets()) {
// also copy query
JRQuery query = jd.getQuery();
if (query instanceof JRDesignQuery) {
djd.setQuery((JRDesignQuery) query);
dr.setQuery(new DJQuery(query.getText(), query
.getLanguage()));
}
for (Iterator iter = jd.getDatasetsList().iterator(); iter.hasNext();) {
JRDesignDataset dataset = (JRDesignDataset) iter.next();
try {
djd.addDataset(dataset);
} catch (JRException e) {
if (log.isDebugEnabled()) {
log.warn(e.getMessage());
}
}
}
}
//BeanUtils.copyProperties does not perform deep copy,
//adding original properties definitions manually
String[] properties = jd.getPropertyNames();
for (int i = 0; i < properties.length; i++) {
String propName = properties[i];
String propValue = jd.getProperty(propName);
djd.setProperty(propName, propValue);
}
//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) {
if (log.isDebugEnabled()){
log.warn("Duplicated style (style name \""+ style.getName()+"\") when loading design: " + e.getMessage(), e);
}
}
}
} catch (IllegalAccessException e) {
throw new CoreException(e.getMessage(),e);
} catch (InvocationTargetException e) {
throw new CoreException(e.getMessage(),e);
}
return djd;
}
/**
* Because 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 = DJJRDesignHelper.getJRDesignQuery(dr);
jd.setQuery(query);
}
}
}