com.greenpepper.confluence.macros.historic.AggregationExecutionChartBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of greenpepper-confluence-code Show documentation
There is a newer version: 4.2.4
Show newest version

/**
 * Copyright (c) 2008 Pyxis Technologies inc.
 *
 * This is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This software 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA,
 * or see the FSF site: http://www.fsf.org.
 *
 * @author oaouattara
 * @version $Id: $Id
 */
package com.greenpepper.confluence.macros.historic;

import java.awt.Color;
import java.awt.image.BufferedImage;
import java.io.IOException;
import java.text.DecimalFormat;
import java.text.NumberFormat;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.jfree.chart.ChartFactory;
import org.jfree.chart.JFreeChart;
import org.jfree.chart.axis.CategoryAxis;
import org.jfree.chart.axis.CategoryLabelPositions;
import org.jfree.chart.axis.NumberAxis;
import org.jfree.chart.axis.NumberTickUnit;
import org.jfree.chart.axis.ValueAxis;
import org.jfree.chart.labels.AbstractCategoryItemLabelGenerator;
import org.jfree.chart.labels.CategoryToolTipGenerator;
import org.jfree.chart.plot.CategoryPlot;
import org.jfree.chart.plot.PlotOrientation;
import org.jfree.chart.renderer.category.StackedBarRenderer;
import org.jfree.chart.title.TextTitle;
import org.jfree.chart.urls.CategoryURLGenerator;
import org.jfree.data.DataUtilities;
import org.jfree.data.category.CategoryDataset;
import org.jfree.data.category.DefaultCategoryDataset;

import com.greenpepper.server.GreenPepperServerException;
import com.greenpepper.server.domain.Execution;
public class AggregationExecutionChartBuilder
		extends AbstractChartBuilder
{

	private static final NumberFormat PERCENT_FORMATTER = new DecimalFormat("0%");

	private final List executions;

	private AggregationExecutionChartBuilder(HistoricParameters settings, List executions)
	{
		super(settings);

		this.executions = executions;
	}

	/**
	 * newInstance.
	 *
	 * @param settings a {@link com.greenpepper.confluence.macros.historic.HistoricParameters} object.
	 * @param executions a {@link java.util.List} object.
	 * @return a {@link com.greenpepper.confluence.macros.historic.AggregationExecutionChartBuilder} object.
	 */
	public static AggregationExecutionChartBuilder newInstance(HistoricParameters settings, List executions)
	{
		return new AggregationExecutionChartBuilder(settings, executions);
	}

	/**
	 * generateChart.
	 *
	 * @return a {@link java.lang.String} object.
	 * @throws com.greenpepper.server.GreenPepperServerException if any.
	 */
	public String generateChart()
			throws GreenPepperServerException
	{
		try
		{
			CategoryDataset dataset = generateDataset();

			JFreeChart chart = createChart(dataset);

			BufferedImage chartImage = createChartImage(chart);

			return getDownloadPath(chartImage);
		}
		catch (IOException e)
		{
			throw new GreenPepperServerException("greenpepper.server.generalexeerror", e.getMessage(), e);
		}
	}

	private CategoryDataset generateDataset()
	{
		final String successLabel = gpUtil.getText("greenpepper.historic.success");
		final String failuresLabel = gpUtil.getText("greenpepper.historic.failures");
		final String ignoredLabel = gpUtil.getText("greenpepper.historic.ignored");

		DefaultCategoryDataset dataset = new DefaultCategoryDataset();

		for (Execution exec : executions)
		{
			String category = exec.getSpecification().getName();

			ChartLongValue value = new ChartLongValue(category, exec.getId());

			double failureCount = exec.getErrors() + exec.getFailures()  + (exec.hasException() ? 1 : 0);

			dataset.addValue(new Double(exec.getSuccess()), successLabel, value);

			if (settings.isShowIgnored())
			{
				dataset.addValue(new Double(exec.getIgnored()), ignoredLabel, value);
			}

			dataset.addValue(new Double(failureCount), failuresLabel, value);
		}

		return dataset;
	}

	private JFreeChart createChart(CategoryDataset dataset)
			throws IOException
	{
		JFreeChart chart = ChartFactory.createAreaChart(settings.getTitle(), null, null, dataset,
														PlotOrientation.VERTICAL, true, false, false);

		customizeChart(chart);

		return chart;
	}

	private void customizeChart(JFreeChart chart)
			throws IOException
	{
		chart.setBackgroundPaint(Color.white);
		chart.setBorderVisible(settings.isBorder());

		TextTitle chartTitle = chart.getTitle();
		customizeTitle(chartTitle, DEFAULT_TITLE_FONT);

		addSubTitle(chart, settings.getSubTitle(), DEFAULT_SUBTITLE_FONT);
		addSubTitle(chart, settings.getSubTitle2(), DEFAULT_SUBTITLE2_FONT);

		CategoryPlot plot = (CategoryPlot)chart.getPlot();
		plot.setNoDataMessage(gpUtil.getText("greenpepper.historic.nodata"));

		StackedBarRenderer renderer = new StackedBarRenderer(true);
		plot.setRenderer(renderer);

		int index = 0;
		renderer.setSeriesPaint(index++, GREEN_COLOR);
		if (settings.isShowIgnored()) renderer.setSeriesPaint(index++, Color.yellow);
		renderer.setSeriesPaint(index, Color.red);

		renderer.setToolTipGenerator(new DefaultTooltipGenerator());
		renderer.setItemURLGenerator(new CategoryURLGenerator() {

			public String generateURL(CategoryDataset data, int series, int category)
			{
				Comparable valueKey = data.getColumnKey(category);
				ChartLongValue value = (ChartLongValue)valueKey;
				return "javascript:" + settings.getExecutionUID() + "_showHistoricChart('" + value.getId() + "');";
			}
		});

		CategoryAxis domainAxis = plot.getDomainAxis();
		customizeAxis(domainAxis);
		domainAxis.setCategoryLabelPositions(CategoryLabelPositions.UP_90);
		domainAxis.setCategoryMargin(0.01);

		ValueAxis rangeAxis = plot.getRangeAxis();
		customizeAxis(rangeAxis);
		rangeAxis.setLowerBound(0);
		rangeAxis.setUpperBound(1.0);

		if (rangeAxis instanceof NumberAxis)
		{
			NumberAxis numberAxis = (NumberAxis)rangeAxis;
			numberAxis.setTickUnit(new NumberTickUnit(.10));
			numberAxis.setNumberFormatOverride(PERCENT_FORMATTER);
		}

		plot.setForegroundAlpha(0.8f);
	}

	private class DefaultTooltipGenerator
			extends AbstractCategoryItemLabelGenerator
			implements CategoryToolTipGenerator
	{
		private final Map totals = new HashMap();
		
		public DefaultTooltipGenerator()
		{
			super("", PERCENT_FORMATTER);
		}

		public String generateToolTip(CategoryDataset dataset, int row, int column)
		{
			final double base = getColumnTotal(dataset, column);
			final Number value = dataset.getValue(row, column);
			final double v = value.doubleValue();

			return String.valueOf(dataset.getColumnKey(column)) + " - " + dataset.getRowKey(row) +
				   " - " + getNumberFormat().format(v / base);
		}

		private double getColumnTotal(CategoryDataset dataset, int column)
		{
			Double total = totals.get(column);

			if (total == null)
			{
				total = DataUtilities.calculateColumnTotal(dataset, column);
				totals.put(column, total);
			}

			return total;
		}
	}
}