ar.com.fdvs.dj.domain.builders.FastReportBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of DynamicJasper Show documentation
DynamicJasper (DJ) is an API that hides the complexity of Jasper Reports, it helps developers to save time when designing simple/medium complexity reports generating the layout of the report elements automatically. It creates reports dynamically, defining at runtime the columns, column width (auto width), groups, variables, fonts, charts, crosstabs, sub reports (that can also be dynamic), page size and everything else that you can define at design time. DJ keeps full compatibility with Jasper Reports since it's a tool that helps create reports programmatically in a easy way (it only interferes with the creation of the report design doing the layout of the elements). You can use the classic .jrxml files as templates while the content and layout of the report elements are handled by the DJ API. http://dynamicjasper.com
There is a newer version: 5.3.9
Show newest version
/*
 * 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.domain.builders;

import ar.com.fdvs.dj.core.BarcodeTypes;
import ar.com.fdvs.dj.domain.ColumnProperty;
import ar.com.fdvs.dj.domain.ColumnsGroupVariableOperation;
import ar.com.fdvs.dj.domain.DJCrosstab;
import ar.com.fdvs.dj.domain.DynamicReport;
import ar.com.fdvs.dj.domain.Style;
import ar.com.fdvs.dj.domain.constants.Border;
import ar.com.fdvs.dj.domain.constants.Font;
import ar.com.fdvs.dj.domain.constants.GroupLayout;
import ar.com.fdvs.dj.domain.constants.HorizontalAlign;
import ar.com.fdvs.dj.domain.constants.ImageScaleMode;
import ar.com.fdvs.dj.domain.constants.Transparency;
import ar.com.fdvs.dj.domain.constants.VerticalAlign;
import ar.com.fdvs.dj.domain.entities.ColumnsGroup;
import ar.com.fdvs.dj.domain.entities.ColumnsGroupVariable;
import ar.com.fdvs.dj.domain.entities.columns.AbstractColumn;
import ar.com.fdvs.dj.domain.entities.columns.PropertyColumn;

import java.awt.Color;
import java.io.InputStream;
import java.math.BigDecimal;
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.Date;

/**
 * Builder created to give users a friendly way of creating a DynamicReport.

 * 

 * Usage example: 

 * DynamicReportBuilder drb = new DynamicReportBuilder();
 * Integer margin = new Integer(20);
 * drb.addTitle("Clients List").addTitleStyle(titleStyle)
 * .addSubtitle("Clients without debt")
 * .addDetailHeight(new Integer(15))
 * .addLeftMargin(margin).addRightMargin(margin).addTopMargin(margin)
 * .addBottomMargin(margin)
 * .addPrintBackgroundOnOddRows(true).addOddRowBackgroundStyle(oddRowStyle)
 * .addColumnsPerPage(new Integer(1)).addColumnSpace(new Integer(5))
 * .addColumn(column1).addColumn(column2).build();
 * 

 * Like with all DJ's builders, it's usage must end with a call to build() mehtod.
 * 

 */
public class FastReportBuilder extends DynamicReportBuilder {

	Style currencyStyle;
	Style numberStyle;
	Style subtitleStyle;

	protected int groupCount = 0;

//	protected Map headerGroupVariables = new TreeMap();
//	protected Map footerGroupVariables = new TreeMap();

	public FastReportBuilder(){
		currencyStyle = new Style("currencyStyle");
		currencyStyle.setHorizontalAlign(HorizontalAlign.RIGHT);

		numberStyle = new Style("numberStyle");
		numberStyle.setHorizontalAlign(HorizontalAlign.RIGHT);

		Style defaultHeaderStyle = options.getDefaultHeaderStyle();
		defaultHeaderStyle.setFont(Font.ARIAL_MEDIUM_BOLD);
		defaultHeaderStyle.setHorizontalAlign(HorizontalAlign.CENTER);
		defaultHeaderStyle.setBorderBottom(Border.THIN);
		defaultHeaderStyle.setVerticalAlign(VerticalAlign.MIDDLE);
		defaultHeaderStyle.setBackgroundColor(Color.LIGHT_GRAY);
		defaultHeaderStyle.setTransparency(Transparency.OPAQUE);

		Style titleStyle2 = report.getTitleStyle();
		titleStyle2.setFont(Font.ARIAL_BIG_BOLD);
		titleStyle2.setHorizontalAlign(HorizontalAlign.CENTER);
		titleStyle2.setVerticalAlign(VerticalAlign.TOP);
	}

	public DynamicReport build(){

		return super.build();
	}

    public FastReportBuilder addColumn(String title, String property, String className, int width, Style style) throws ColumnBuilderException, ClassNotFoundException {
		AbstractColumn column = ColumnBuilder.getInstance()
			.setColumnProperty(new ColumnProperty(property, className))
			.setWidth(new Integer(width))
			.setTitle(title)
			.build();

		column.setStyle(style);

		addColumn(column);

		return this;
	}

    public FastReportBuilder addColumn(String title, String property, String className, int width) throws ColumnBuilderException, ClassNotFoundException {
		AbstractColumn column = ColumnBuilder.getInstance()
			.setColumnProperty(new ColumnProperty(property, className))
			.setWidth(new Integer(width))
			.setTitle(title)
			.build();

		guessStyle(className, column);

		addColumn(column);

		return this;
	}

	public FastReportBuilder addColumn(String title, String property, String className, int width, boolean fixedWidth) throws ColumnBuilderException, ClassNotFoundException {
		AbstractColumn column = ColumnBuilder.getInstance()
			.setColumnProperty(property, className)
			.setWidth(new Integer(width))
			.setTitle(title)
			.setFixedWidth(Boolean.valueOf(fixedWidth))
			.build();

		guessStyle(className, column);

		addColumn(column);

		return this;
	}

	public FastReportBuilder addImageColumn(String title, String property, int width, boolean fixedWidth, ImageScaleMode imageScaleMode) throws ColumnBuilderException, ClassNotFoundException {
		String className = InputStream.class.getName();
		AbstractColumn column = ColumnBuilder.getInstance()
			.setColumnProperty(property, className)
			.setWidth(new Integer(width))
			.setTitle(title)
			.setFixedWidth(Boolean.valueOf(fixedWidth))
			.setColumnType(ColumnBuilder.COLUMN_TYPE_IMAGE)
			.setImageScaleMode(imageScaleMode)
			.build();

		guessStyle(className, column);

		addColumn(column);

		return this;
	}

	/**
	 * By default uses InputStream as the type of the image
	 * @param title
	 * @param property
	 * @param width
	 * @param fixedWidth
	 * @param imageScaleMode
	 * @param style
	 * @return
	 * @throws ColumnBuilderException
	 * @throws ClassNotFoundException
	 */
	public FastReportBuilder addImageColumn(String title, String property, int width, boolean fixedWidth,ImageScaleMode imageScaleMode, Style style) throws ColumnBuilderException, ClassNotFoundException {
		String className = InputStream.class.getName();
		AbstractColumn column = ColumnBuilder.getInstance()
		.setColumnProperty(property, className)
		.setWidth(new Integer(width))
		.setTitle(title)
		.setFixedWidth(Boolean.valueOf(fixedWidth))
		.setColumnType(ColumnBuilder.COLUMN_TYPE_IMAGE)
		.setStyle(style)
		.build();

		guessStyle(className, column);

		addColumn(column);

		return this;
	}

	/**
	 *
	 * @param title
	 * @param property
	 * @param className valid class names are: InputStream and java.awt.Image
	 * @param width
	 * @param fixedWidth
	 * @param imageScaleMode
	 * @param style
	 * @return
	 * @throws ColumnBuilderException
	 * @throws ClassNotFoundException
	 */
	public FastReportBuilder addImageColumn(String title, String property, String className, int width, boolean fixedWidth,ImageScaleMode imageScaleMode, Style style) throws ColumnBuilderException, ClassNotFoundException {
		AbstractColumn column = ColumnBuilder.getInstance()
		.setColumnProperty(property, className)
		.setWidth(new Integer(width))
		.setTitle(title)
		.setFixedWidth(Boolean.valueOf(fixedWidth))
		.setColumnType(ColumnBuilder.COLUMN_TYPE_IMAGE)
		.setStyle(style)
		.build();

		if (style == null)
			guessStyle(className, column);

		addColumn(column);

		return this;
	}

	public FastReportBuilder addBarcodeColumn(String title, String property, String className, int barcodeType, boolean showText, int width, boolean fixedWidth, ImageScaleMode imageScaleMode) throws ColumnBuilderException, ClassNotFoundException {
		AbstractColumn column = ColumnBuilder.getInstance()
		.setColumnProperty(property, className)
		.setWidth(new Integer(width))
		.setTitle(title)
		.setFixedWidth(Boolean.valueOf(fixedWidth))
		.setColumnType(ColumnBuilder.COLUMN_TYPE_BARCODE)
		.setImageScaleMode(imageScaleMode)
		.setBarcodeType(barcodeType)
		.setShowText(showText)
		.build();

//		guessStyle(className, column); //NOT FOR BARCODE!!!

		addColumn(column);

		return this;
	}

	/**
	 * By default uses InputStream as the type of the image
	 * @param title
	 * @param property
	 * @param width
	 * @param fixedWidth
	 * @param imageScaleMode
	 * @param style
	 * @return
	 * @throws ColumnBuilderException
	 * @throws ClassNotFoundException
	 */
	public FastReportBuilder addBarcodeColumn(String title, String property,String className, int  barcodeType,boolean showText, int width, boolean fixedWidth,ImageScaleMode imageScaleMode, Style style) throws ColumnBuilderException, ClassNotFoundException {
		AbstractColumn column = ColumnBuilder.getInstance()
		.setColumnProperty(property, className)
		.setWidth(new Integer(width))
		.setTitle(title)
		.setFixedWidth(Boolean.valueOf(fixedWidth))
		.setColumnType(ColumnBuilder.COLUMN_TYPE_BARCODE)
		.setStyle(style)
		.setBarcodeType(barcodeType)
		.setShowText(showText)
		.build();

		if (style == null)
			guessStyle(className, column);

		addColumn(column);

		return this;
	}

/**
 *
 * @param title
 * @param property
 * @param className  valid class names are: InputStream and java.awt.Image
 * @param barcodeType use constansts from {@link BarcodeTypes}
 * @param showText
 * @param checkSum
 * @param applicationIdentifier Only for barcodeType = UCCEAN128, this value must point to a property (it register the property)
 * @param width
 * @param fixedWidth
 * @param imageScaleMode
 * @param style
 * @return
 * @throws ColumnBuilderException
 * @throws ClassNotFoundException
 */
	public FastReportBuilder addBarcodeColumn(String title, String property, String className, int barcodeType, boolean showText, boolean checkSum, String applicationIdentifier, int width, boolean fixedWidth, ImageScaleMode imageScaleMode, Style style) throws ColumnBuilderException, ClassNotFoundException {
		AbstractColumn column = ColumnBuilder.getInstance()
		.setColumnProperty(property, className)
		.setWidth(new Integer(width))
		.setTitle(title)
		.setFixedWidth(Boolean.valueOf(fixedWidth))
		.setColumnType(ColumnBuilder.COLUMN_TYPE_BARCODE)
		.setBarcodeType(barcodeType)
		.setApplicationIdentifier(applicationIdentifier)
		.setStyle(style)
		.setShowText(showText)
		.setCheckSum(checkSum)
		.build();

		if (applicationIdentifier != null){
			addField(applicationIdentifier,  Object.class.getName());
		}

		if (style == null)
			guessStyle(className, column);

		addColumn(column);

		return this;
	}

	public FastReportBuilder addColumn(String title, String property, String className, int width, boolean fixedWidth, String pattern) throws ColumnBuilderException, ClassNotFoundException {
		AbstractColumn column = ColumnBuilder.getInstance()
		.setColumnProperty(new ColumnProperty(property, className))
		.setWidth(new Integer(width))
		.setTitle(title)
		.setFixedWidth(Boolean.valueOf(fixedWidth))
		.setPattern(pattern)
		.build();

		guessStyle(className, column);

		addColumn(column);

		return this;
	}

	public FastReportBuilder addColumn(String title, String property, String className, int width, boolean fixedWidth, String pattern, Style style) throws ColumnBuilderException, ClassNotFoundException {
		AbstractColumn column = ColumnBuilder.getInstance()
		.setColumnProperty(new ColumnProperty(property, className))
		.setWidth(new Integer(width))
		.setTitle(title)
		.setFixedWidth(Boolean.valueOf(fixedWidth))
		.setPattern(pattern)
		.setStyle(style)
		.build();

		if (style == null)
			guessStyle(className, column);

		addColumn(column);

		return this;
	}
	
	public FastReportBuilder addColumn(String title, String property, String className, int width, boolean fixedWidth, String pattern, Style style, String fieldDescription) throws ColumnBuilderException, ClassNotFoundException {
		AbstractColumn column = ColumnBuilder.getInstance()
		.setColumnProperty(new ColumnProperty(property, className))
		.setWidth(new Integer(width))
		.setTitle(title)
		.setFixedWidth(Boolean.valueOf(fixedWidth))
		.setPattern(pattern)
		.setStyle(style)
		.setFieldDescription(fieldDescription)
		.build();
		
		if (style == null)
			guessStyle(className, column);
		
		addColumn(column);
		
		return this;
	}

	protected void guessStyle(String className, AbstractColumn column) throws ClassNotFoundException {

		Class clazz = Class.forName(className);
		if (BigDecimal.class.isAssignableFrom(clazz) || Float.class.isAssignableFrom(clazz) || Double.class.isAssignableFrom(clazz)) {
			if (column.getPattern() == null)
				column.setPattern("$ #.00");
			column.setStyle(currencyStyle);
		}

		if (Integer.class.isAssignableFrom(clazz) || Long.class.isAssignableFrom(clazz)) {
			column.setStyle(numberStyle);
		}

		if (Date.class.isAssignableFrom(clazz)) {
			if (column.getPattern() == null)
				column.setPattern("dd/MM/yy");
		}

		if (Timestamp.class.isAssignableFrom(clazz)) {
			if (column.getPattern() == null)
				column.setPattern("dd/MM/yy hh:mm:ss");
		}
	}

	public FastReportBuilder addGroups(int numgroups) {
		groupCount = numgroups;
		for (int i = 0; i < groupCount; i++) {
			GroupBuilder gb = new GroupBuilder();
			PropertyColumn col = (PropertyColumn) report.getColumns().get(i);
			gb.setCriteriaColumn(col);
			report.getColumnsGroups().add(gb.build());
		}
		return this;
	}

	public FastReportBuilder setGroupLayout(int groupNumber, GroupLayout layout) throws BuilderException {
		ColumnsGroup group = getGroupByNumber(groupNumber);
		group.setLayout(layout);
		return this;
	}

	public FastReportBuilder addGlobalHeaderVariable(int colNumber, ColumnsGroupVariableOperation op, Style style) {
		PropertyColumn column = (PropertyColumn) report.getColumns().get(colNumber -1);
		if (this.globalHeaderVariables == null)
			this.globalHeaderVariables = new ArrayList();
		if (style == null)
			style = numberStyle;

		this.globalHeaderVariables.add(new ColumnsGroupVariable(column, op, style));
		return this;
	}

	public FastReportBuilder addHeaderVariable(int groupNum, int colNumber, ColumnsGroupVariableOperation op, Style style) throws BuilderException {
		ColumnsGroup group = getGroupByNumber(groupNum);
		PropertyColumn column = (PropertyColumn) report.getColumns().get(colNumber -1);
		if (style == null)
			style = numberStyle;

		ColumnsGroupVariable columnsGroupVariable = new ColumnsGroupVariable(column, op, style);
		group.getHeaderVariables().add(columnsGroupVariable);
		return this;
	}

	/**
	 * @param groupNum
	 * @return
	 * @throws BuilderException
	 */
	private ColumnsGroup getGroupByNumber(int groupNum) throws BuilderException {
		ColumnsGroup group;
		try {
			group = (ColumnsGroup) report.getColumnsGroups().get(groupNum-1);
		} catch (IndexOutOfBoundsException e) {
			throw new BuilderException("No such group, use addGroups(int) first");
		}
		return group;
	}

	public FastReportBuilder addGlobalFooterVariable(int colNumber, ColumnsGroupVariableOperation op, Style style) {
		PropertyColumn column = (PropertyColumn) report.getColumns().get(colNumber -1);
		if (this.globalFooterVariables == null)
			this.globalFooterVariables = new ArrayList();
		if (style == null)
			style = numberStyle;

		this.globalFooterVariables.add(new ColumnsGroupVariable(column, op, style));
		return this;
	}

	public FastReportBuilder addFooterVariable(int groupNum, int colNumber, ColumnsGroupVariableOperation op, Style style) throws BuilderException {
		ColumnsGroup group = getGroupByNumber(groupNum);
		PropertyColumn column = (PropertyColumn) report.getColumns().get(colNumber -1);
		if (style == null)
			style = numberStyle;

		ColumnsGroupVariable columnsGroupVariable = new ColumnsGroupVariable(column, op, style);
		group.getFooterVariables().add(columnsGroupVariable);
		return this;
	}

	public FastReportBuilder addHeaderCrosstab(int groupNumber, DJCrosstab djcross) throws BuilderException {
		ColumnsGroup group = getGroupByNumber(groupNumber);
		group.getHeaderCrosstabs().add(djcross);
		return this;
	}
	public FastReportBuilder addFooterCrosstab(int groupNumber, DJCrosstab djcross) throws BuilderException {
		ColumnsGroup group = getGroupByNumber(groupNumber);
		group.getFooterCrosstabs().add(djcross);
		return this;
	}

}