net.sf.dynamicreports.report.builder.chart.AbstractCategoryChartBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of dynamicreports-core Show documentation

DynamicReports is an open source Java reporting library based on JasperReports. It allows to create dynamic report designs and it doesn't need a visual report designer. You can very quickly create reports and produce documents that can be displayed, printed or exported into many popular formats such as PDF, Excel, Word and others.

There is a newer version: 6.20.1

Show newest version

/**
 * DynamicReports - Free Java reporting library for creating reports dynamically
 *
 * Copyright (C) 2010 - 2016 Ricardo Mariaca
 * http://www.dynamicreports.org
 *
 * This file is part of DynamicReports.
 *
 * DynamicReports 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 3 of the License, or
 * (at your option) any later version.
 *
 * DynamicReports 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 DynamicReports. If not, see .
 */

package net.sf.dynamicreports.report.builder.chart;

import java.util.Arrays;
import java.util.Comparator;
import java.util.List;

import net.sf.dynamicreports.report.base.chart.dataset.DRCategoryDataset;
import net.sf.dynamicreports.report.base.chart.plot.DRAxisPlot;
import net.sf.dynamicreports.report.builder.DynamicReports;
import net.sf.dynamicreports.report.builder.FieldBuilder;
import net.sf.dynamicreports.report.builder.HyperLinkBuilder;
import net.sf.dynamicreports.report.builder.column.ValueColumnBuilder;
import net.sf.dynamicreports.report.constant.ChartType;
import net.sf.dynamicreports.report.constant.Constants;
import net.sf.dynamicreports.report.constant.OrderType;
import net.sf.dynamicreports.report.definition.expression.DRIExpression;

import org.apache.commons.lang3.Validate;

/**
 * @author Ricardo Mariaca ([email protected])
 */
@SuppressWarnings("unchecked")
public abstract class AbstractCategoryChartBuilder, U extends DRAxisPlot> extends AbstractBaseChartBuilder {
	private static final long serialVersionUID = Constants.SERIAL_VERSION_UID;

	protected AbstractCategoryChartBuilder(ChartType chartType) {
		super(chartType);
	}

	//dataset
	public T setCategory(ValueColumnBuilder column) {
		Validate.notNull(column, "column must not be null");
		getDataset().setValueExpression(column.getColumn());
		return (T) this;
	}

	public T setCategory(String fieldName, Class valueClass) {
		return setCategory(DynamicReports.field(fieldName, valueClass));
	}

	public T setCategory(FieldBuilder field) {
		Validate.notNull(field, "field must not be null");
		getDataset().setValueExpression(field.build());
		return (T) this;
	}

	public T setCategory(DRIExpression expression) {
		getDataset().setValueExpression(expression);
		return (T) this;
	}

	public T series(AbstractCategoryChartSerieBuilder ...chartSeries) {
		return addSerie(chartSeries);
	}

	public T addSerie(AbstractCategoryChartSerieBuilder ...chartSeries) {
		Validate.notNull(chartSeries, "chartSeries must not be null");
		Validate.noNullElements(chartSeries, "chartSeries must not contains null chartSerie");
		for (AbstractCategoryChartSerieBuilder chartSerie : chartSeries) {
			getDataset().addSerie(chartSerie.build());
		}
		return (T) this;
	}

	public T setUseSeriesAsCategory(Boolean useSeriesAsCategory) {
		getDataset().setUseSeriesAsCategory(useSeriesAsCategory);
		return (T) this;
	}

	public T setItemHyperLink(HyperLinkBuilder itemHyperLink) {
		Validate.notNull(itemHyperLink, "itemHyperLink must not be null");
		getDataset().setItemHyperLink(itemHyperLink.build());
		return (T) this;
	}

	//plot
	public T setCategoryAxisFormat(AxisFormatBuilder categoryAxisFormat) {
		Validate.notNull(categoryAxisFormat, "categoryAxisFormat must not be null");
		getPlot().setXAxisFormat(categoryAxisFormat.build());
		return (T) this;
	}

	public T setValueAxisFormat(AxisFormatBuilder valueAxisFormat) {
		Validate.notNull(valueAxisFormat, "valueAxisFormat must not be null");
		getPlot().setYAxisFormat(valueAxisFormat.build());
		return (T) this;
	}

	public T setShowPercentages(Boolean showPercentages) {
		getPlot().setShowPercentages(showPercentages);
		return (T) this;
	}

	public T setSeriesOrderBy(Comparator seriesOrderBy) {
		getPlot().setSeriesOrderBy(seriesOrderBy);
		return (T) this;
	}

	public T setSeriesOrderBy(List seriesOrderByNames) {
		getPlot().setSeriesOrderBy(new SeriesOrderByNamesComparator(seriesOrderByNames));
		return (T) this;
	}

	public T seriesOrderBy(String ...seriesOrderByNames) {
		return setSeriesOrderBy(Arrays.asList(seriesOrderByNames));
	}

	public T setSeriesOrderType(OrderType seriesOrderType) {
		getPlot().setSeriesOrderType(seriesOrderType);
		return (T) this;
	}
}