ar.com.fdvs.dj.domain.DynamicReport Maven / Gradle / Ivy

Go to download
/*
 * 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.domain;

import ar.com.fdvs.dj.core.DJConstants;
import ar.com.fdvs.dj.domain.builders.StyleBuilder;
import ar.com.fdvs.dj.domain.constants.Stretching;
import ar.com.fdvs.dj.domain.entities.DJVariable;
import ar.com.fdvs.dj.domain.entities.Entity;
import ar.com.fdvs.dj.domain.entities.Parameter;
import ar.com.fdvs.dj.domain.entities.columns.AbstractColumn;
import ar.com.fdvs.dj.domain.entities.columns.ExpressionColumn;
import ar.com.fdvs.dj.domain.entities.columns.SimpleColumn;

import java.util.*;

/**
 * One of the main classes of this product. It represents the report itself.
 */
public class DynamicReport extends DJBaseElement {

	private static final long serialVersionUID = Entity.SERIAL_VERSION_UID;
	
	private String reportName;


    /**
     Sets the language of the expressions used in the report
     * (can be one of java, groovy, or javascript).
     *
     * Default is DJConstants#REPORT_LANGUAGE_JAVA
     *
     * @see DJConstants#REPORT_LANGUAGE_JAVA
     *      DJConstants#REPORT_LANGUAGE_GROOVY
     *      DJConstants#REPORT_LANGUAGE_JAVASCRIPT
     *
     */
    private String language = DJConstants.REPORT_LANGUAGE_JAVA;

    private String title;
	private boolean titleIsJrExpression = false;
	
	private String subtitle;
	private Style titleStyle = new StyleBuilder(false,"reportTitleStyle")
								.setStretching(Stretching.NO_STRETCH)
								.build();
	private Style subtitleStyle = new StyleBuilder(false,"reportSubtitleStyle")
									.setStretching(Stretching.NO_STRETCH)
									.build();

	private Locale reportLocale = Locale.getDefault();
	private String resourceBundle = null;

	protected Map fontsMap = new HashMap(); //

	private List columns = new ArrayList();

	//
	private List columnsGroups = new ArrayList();

	//
	private List charts = new ArrayList();

	//
	private List newCharts = new ArrayList();
	
	private DynamicReportOptions options;

	/**
	 * List of ColumnProperty
	 * Other fields to register, not necessary assigned to columns
	 */
	private List fields = new ArrayList();

	//Other parameters needed (E.g. Subreports)
	private List parameters = new ArrayList();
	
	private List variables = new ArrayList();

	private Map properties = new HashMap();

	private String templateFileName = null;
	private boolean templateImportDatasets = false;
	private boolean templateImportFields = false;
	private boolean templateImportVariables = false;
	private boolean templateImportParameters = true;

	private List autoTexts = new ArrayList();

	private Map styles = new LinkedHashMap();

	private DJQuery query;

	private String whenNoDataText;
	private Style  whenNoDataStyle;
	private boolean whenNoDataShowTitle = true;
	private boolean whenNoDataShowColumnHeader = true;

	private boolean allowDetailSplit = true;

	/**
	 * Defines the behaviour when the datasource is empty.
	 * Valid values are:
	 * DJConstants.WHEN_NO_DATA_TYPE_NO_PAGES
	 * DJConstants.WHEN_NO_DATA_TYPE_BLANK_PAGE
	 * DJConstants.WHEN_NO_DATA_TYPE_ALL_SECTIONS_NO_DETAIL
	 * DJConstants.WHEN_NO_DATA_TYPE_NO_DATA_SECTION
	 *
	 * Defatul is: DJConstants.WHEN_NO_DATA_TYPE_NO_PAGES
	 */
	private byte whenNoDataType = DJConstants.WHEN_NO_DATA_TYPE_NO_PAGES;

	/**********************
	 * Defines what to show if a missing resource is referenced
	 * Possible values are:

	 * DJConstants.WHEN_RESOURCE_MISSING_TYPE_EMPTY: Leaves and empty field.

	 * DJConstants.WHEN_RESOURCE_MISSING_TYPE_ERROR: Throwns and exception.

	 * DJConstants.WHEN_RESOURCE_MISSING_TYPE_KEY: Shows the key of the missing resource.

	 * DJConstants.WHEN_RESOURCE_MISSING_TYPE_NULL: returns NULL
	 **********************/
	private byte whenResourceMissing = DJConstants.WHEN_RESOURCE_MISSING_TYPE_KEY;


	public void addStyle(Style style) {
		styles.put(style.getName(), style);
	}

	public Map getStyles() {
		return styles;
	}

	public void setStyles(Map styles) {
		this.styles = styles;
	}

	public void setProperty(String name, String value) {
		properties.put(name, value);
	}

	public DynamicReport() {}

	public DynamicReport(String title, List columns, List columnsGroups, List charts, DynamicReportOptions options) {
		this.title = title;
		this.columns = columns;
		this.columnsGroups = columnsGroups;
		this.charts = charts;
		this.options = options;
	}

	public String getTitle() {
		return title;
	}

	public void setTitle(String title) {
		this.title = title;
	}

	public List getColumns() {
		return columns;
	}

	public void setColumns(List columns) {
		this.columns = columns;
	}

	public List getColumnsGroups() {
		return columnsGroups;
	}

	public void setColumnsGroups(List columnsGroups) {
		this.columnsGroups = columnsGroups;
	}

	public DynamicReportOptions getOptions() {
		return options;
	}

	public void setOptions(DynamicReportOptions options) {
		this.options = options;
	}

	public String getSubtitle() {
		return subtitle;
	}

	public void setSubtitle(String subtitle) {
		this.subtitle = subtitle;
	}

	public Style getSubtitleStyle() {
		return subtitleStyle;
	}

	public void setSubtitleStyle(Style subtitleStyle) {
		this.subtitleStyle = subtitleStyle;
	}

	public Style getTitleStyle() {
		return titleStyle;
	}

	public void setTitleStyle(Style titleStyle) {
		this.titleStyle = titleStyle;
	}

	public void setTitleStyle(Style titleStyle, boolean isExp) {
		this.titleStyle = titleStyle;
		this.titleIsJrExpression = isExp;
	}

	public String getTemplateFileName() {
		return templateFileName;
	}

	public void setTemplateFileName(String templateFileName) {
		this.templateFileName = templateFileName;
	}

	public List getFields() {
		return fields;
	}

	public void setFields(List fields) {
		this.fields = fields;
	}

	public List getCharts() {
		return charts;
	}

	public void setCharts(List charts) {
		this.charts = charts;
	}

	public List getNewCharts() {
		return newCharts;
	}

	public void setNewCharts(List charts) {
		this.newCharts = charts;
	}
	
	public List getAutoTexts() {
		return autoTexts;
	}

	public void setAutoTexts(List autoTexts) {
		this.autoTexts = autoTexts;
	}

	public Locale getReportLocale() {
		return reportLocale;
	}

	public void setReportLocale(Locale reportLocale) {
		this.reportLocale = reportLocale;
	}

	public String getResourceBundle() {
		return resourceBundle;
	}

	public void setResourceBundle(String resourceBundle) {
		this.resourceBundle = resourceBundle;
	}

	public DJQuery getQuery() {
		return query;
	}

	public void setQuery(DJQuery query) {
		this.query = query;
	}

	public Map getFontsMap() {
		return fontsMap;
	}

	public void setFontsMap(Map fontsMap) {
		this.fontsMap = fontsMap;
	}

	public byte getWhenNoDataType() {
		return whenNoDataType;
	}

	public void setWhenNoDataType(byte whenNoDataType) {
		this.whenNoDataType = whenNoDataType;
	}

	public byte getWhenResourceMissing() {
		return whenResourceMissing;
	}

	public void setWhenResourceMissing(byte whenResourceMissing) {
		this.whenResourceMissing = whenResourceMissing;
	}

	public String getWhenNoDataText() {
		return whenNoDataText;
	}

	public void setWhenNoDataText(String whenNoDataText) {
		this.whenNoDataText = whenNoDataText;
	}

	public Style getWhenNoDataStyle() {
		return whenNoDataStyle;
	}

	public void setWhenNoDataStyle(Style whenNoDataStyle) {
		this.whenNoDataStyle = whenNoDataStyle;
	}

	public boolean isWhenNoDataShowTitle() {
		return whenNoDataShowTitle;
	}

	public void setWhenNoDataShowTitle(boolean whenNoDataShowTitle) {
		this.whenNoDataShowTitle = whenNoDataShowTitle;
	}

	public boolean isWhenNoDataShowColumnHeader() {
		return whenNoDataShowColumnHeader;
	}

	public void setWhenNoDataShowColumnHeader(boolean whenNoDataShowColumnHeader) {
		this.whenNoDataShowColumnHeader = whenNoDataShowColumnHeader;
	}

	public List getParameters() {
		return parameters;
	}
	
	public void addParameter(String name, String className){
		this.parameters.add(new Parameter(name, className));
	}

	public void setParameters(List parameters) {
		this.parameters = parameters;
	}

	public boolean isAllowDetailSplit() {
		return allowDetailSplit;
	}

	public void setAllowDetailSplit(boolean allowDetailSplit) {
		this.allowDetailSplit = allowDetailSplit;
	}

   public boolean isTemplateImportDatasets() {
		return templateImportDatasets;
	}

	public void setTemplateImportDatasets(boolean templateImportDatasets) {
		this.templateImportDatasets = templateImportDatasets;
	}

	public boolean isTemplateImportFields() {
		return templateImportFields;
	}

	public void setTemplateImportFields(boolean templateImportFields) {
		this.templateImportFields = templateImportFields;
	}

	public boolean isTemplateImportVariables() {
		return templateImportVariables;
	}

	public void setTemplateImportVariables(boolean templateImportVariables) {
		this.templateImportVariables = templateImportVariables;
	}

	public boolean isTemplateImportParameters() {
		return templateImportParameters;
	}

	public void setTemplateImportParameters(boolean templateImportParameters) {
		this.templateImportParameters = templateImportParameters;
	}

	public Map getProperties() {
		return properties;
	}

	/**
	 * Must be a Map
	 * @param properties
	 */
	public void setProperties(Map properties) {
		this.properties = properties;
	}

	public String getReportName() {
		return reportName;
	}

	public void setReportName(String reportName) {
		this.reportName = reportName;
	}
	
	/**
	 * 
	 * @return List
	 */
	public List getAllFields(){
		ArrayList l = new ArrayList();
		for (Iterator iter = this.columns.iterator(); iter.hasNext();) {
			Object o = iter.next();
			ColumnProperty columnProperty = null;

			if (o instanceof SimpleColumn && !(o instanceof ExpressionColumn)) {
				SimpleColumn propcol = (SimpleColumn)o;
				columnProperty = propcol.getColumnProperty();
				l.add(columnProperty);
			}
		}
		
		l.addAll(this.getFields());

		return l;
		
	}

	public boolean isTitleIsJrExpression() {
		return titleIsJrExpression;
	}

	public void setTitleIsJrExpression(boolean titleIsJrExpression) {
		this.titleIsJrExpression = titleIsJrExpression;
	}

	public List getVariables() {
		return variables;
	}

	public void setVariables(List variables) {
		this.variables = variables;
	}

    public String getLanguage() {
        return language;
    }

    /**
     * @see DynamicReport#language
     * @param language
     */
    public void setLanguage(String language) {
        this.language = language;
    }

}