PieChartMaker.java

/**
 * Copyright (C) 2008-2010, Squale Project - http://www.squale.org
 *
 * This file is part of Squale.
 *
 * Squale 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 any later version.
 *
 * Squale 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 Lesser General Public License
 * along with Squale.  If not, see <http://www.gnu.org/licenses/>.
 */
/*
 * Cr�� le 16 ao�t 05
 *
 * Pour changer le mod�le de ce fichier g�n�r�, allez � :
 * Fen�tre>Pr�f�rences>Java>G�n�ration de code>Code et commentaires
 */

package org.squale.squaleweb.util.graph;

import java.text.NumberFormat;
import java.util.Iterator;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.jfree.chart.ChartFactory;
import org.jfree.chart.JFreeChart;
import org.jfree.chart.labels.StandardPieSectionLabelGenerator;
import org.jfree.chart.plot.PiePlot3D;
import org.jfree.data.general.DefaultPieDataset;
import org.jfree.util.Rotation;

import org.squale.squaleweb.util.SqualeWebActionUtils;

/**
 * @author M400843
 */
public class PieChartMaker
    extends AbstractGraphMaker
{
    /**
     * Hauteur du diagramme par d�faut
     */
    public static final int DEFAULT_HEIGHT = 300;

    /**
     * Hauteur du diagramme par d�faut
     */
    public static final int DEFAULT_WIDTH = 400;

    /**
     * dataset contenant les valeurs � mettre dans le diagramme
     */
    private DefaultPieDataset mDataSet;

    /**
     * constructeur par d�faut
     */
    private PieChartMaker()
    {
        mDataSet = new DefaultPieDataset();
    }

    /**
     * Constructeur avec le titre du diagramme
     * 
     * @param pTitle titre du diagramme (peut etre <code>null</code>)
     * @param pCurrentAuditId l'id de l'audit courant
     * @param pPreviousAuditId l'id de l'audit pr�c�dent
     */
    public PieChartMaker( String pTitle, String pCurrentAuditId, String pPreviousAuditId )
    {
        mDataSet = new DefaultPieDataset();
        mTitle = pTitle;
        mCurrentAuditId = pCurrentAuditId;
        mPreviousAuditId = pPreviousAuditId;
    }

    /**
     * @see org.squale.squalecommon.util.graph.AbstractGraphMaker#getDefaultHeight() {@inheritDoc}
     */
    protected int getDefaultHeight()
    {
        return DEFAULT_HEIGHT;
    }

    /**
     * @see org.squale.squalecommon.util.graph.AbstractGraphMaker#getDefaultWidth() {@inheritDoc}
     */
    protected int getDefaultWidth()
    {
        return DEFAULT_WIDTH;
    }

    /**
     * Ajoute une valeur au camembert
     * 
     * @param pTitle le titre correspondant � la part.
     * @param pValue la valeur
     */
    public void addValue( String pTitle, double pValue )
    {
        Number number = new Double( pValue );
        addValue( pTitle, number );
    }

    /**
     * Ajoute une valeur au camembert
     * 
     * @param pTitle le titre correspondant � la part.
     * @param pValue la valeur
     */
    public void addValue( String pTitle, Number pValue )
    {
        mDataSet.setValue( pTitle, pValue );
    }

    /**
     * Affecte les valeurs du camembert (les anciennes valeurs sont effac�es.
     * 
     * @param pValues Map contenant en cl� les titres (String) des part du camembert et en valeurs les valeurs (Number)
     *            correspondantes
     */
    public void setValues( Map pValues )
    {
        mDataSet = new DefaultPieDataset();
        Iterator it = pValues.keySet().iterator();
        while ( it.hasNext() )
        {
            String title = (String) it.next();
            addValue( title, (Long) pValues.get( title ) );
        }
    }

    /**
     * @param pRequest la requ�te
     * @return le diagramme JFreeChart
     */
    protected JFreeChart getChart( HttpServletRequest pRequest )
    {
        JFreeChart retChart = super.getChart();
        if ( null == retChart )
        {
            retChart = getCommonChart( pRequest );
            super.setChart( retChart );
        }
        return retChart;
    }

    /**
     * Restitution du diagramme de type Pie Chart
     * 
     * @param pUrls les sections du graphe (Id et libell� projet)
     * @param pRequest la requ�te
     * @return le diagramme JFreeChart
     */
    public JFreeChart getChart( Map pUrls, HttpServletRequest pRequest )
    {
        JFreeChart retChart = super.getChart();
        if ( null == retChart )
        {
            retChart = getCommonChart( pRequest );
            PieChartUrlGenerator generator = new PieChartUrlGenerator( pUrls, mCurrentAuditId, mPreviousAuditId );
            ( (PiePlot3D) retChart.getPlot() ).setURLGenerator( generator );
            super.setChart( retChart );
        }
        return retChart;
    }

    /**
     * Factorisation du code commun � la g�n�ration du graphe
     * 
     * @param pRequest la requ�te
     * @return graphe de type Bubble
     */
    private JFreeChart getCommonChart( HttpServletRequest pRequest )
    {
        JFreeChart chart = ChartFactory.createPieChart3D( mTitle, mDataSet, false, false, false );
        PiePlot3D pieplot3d = (PiePlot3D) chart.getPlot();
        final double startAngle = 290D;
        pieplot3d.setStartAngle( startAngle );
        final float depthFactor = 0.1f;
        pieplot3d.setDepthFactor( depthFactor );
        pieplot3d.setDirection( Rotation.CLOCKWISE );
        final float foregroundAlpha = 0.5f;
        pieplot3d.setForegroundAlpha( foregroundAlpha );
        // Si on est en anglais, on laisse les nombre format�es avec des "," pour s�parer les milliers
        // Si on est en francais on remplace les "," par des points
        NumberFormat numberFormat = SqualeWebActionUtils.getNumberFormat( pRequest );
        // Pour le formatter de %, on laisse celui par d�faut
        pieplot3d.setLabelGenerator( new StandardPieSectionLabelGenerator( "{0} = {1} loc ({2})", numberFormat,
                                                                           NumberFormat.getPercentInstance() ) );
        return chart;
    }
}