AbstractGraphMaker.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/>.
 */
package org.squale.squaleweb.util.graph;

import java.awt.image.BufferedImage;
import java.io.IOException;

import org.jfree.chart.ChartFrame;
import org.jfree.chart.JFreeChart;
import org.jfree.chart.encoders.ImageEncoder;
import org.jfree.chart.encoders.ImageEncoderFactory;
import org.jfree.chart.encoders.ImageFormat;

import org.squale.squaleweb.resources.WebMessages;

/**
 * @author M400843
 */
public abstract class AbstractGraphMaker
{
    /**
     * Titre du graph (peut etre <code>null</code>)
     */
    protected String mTitle;

    /**
     * <code>true</code> pour afficher la l�gende (valeur par d�faut)
     */
    protected boolean mShowLegend = WebMessages.getBool( "default.abstract.show_legend" ); // true; // Valeur par
                                                                                            // d�faut

    /**
     * Hauteur de l'image
     */
    protected int mHeight = getDefaultHeight(); // Valeur par d�faut

    /**
     * Largeur de l'image
     */
    protected int mWidth = getDefaultWidth(); // Valeur par d�faut

    /**
     * Format de l'imgae (png par d�faut)
     */
    protected String mFormat = ImageFormat.PNG; // Valeur par d�faut

    /**
     * Objet JFreeChart contenant le graph
     */
    private JFreeChart mChart;

    /**
     * Id du projet
     */
    protected String mProjectId;

    /**
     * Id de l'audit courant
     */
    protected String mCurrentAuditId;

    /**
     * Id de l'audit pr�c�dent
     */
    protected String mPreviousAuditId;

    /**
     * Etiquete figurant sur l'axe des abscisses
     */
    protected String mXLabel;

    /**
     * Etiquete figurant sur l'axe des ordonn�es
     */
    protected String mYLabel;

    /**
     * Permet de fabriquer l'image sous forme d'un tableau de byte <b>Attention : </b> la m�thode de la classe fille
     * doit v�rifier que mChart est initialis�
     * 
     * @return un tableau de byte contenant une BufferedImage
     * @throws IOException si une erreur a lieu
     */
    public byte[] getImageInBytes()
        throws IOException
    {
        BufferedImage bufImage = getChart().createBufferedImage( mWidth, mHeight );
        ImageEncoder encoder = ImageEncoderFactory.newInstance( mFormat );

        return encoder.encode( bufImage );
    }

    /**
     * Cette m�thode retourne le diagramme. Dans les classes concr�tes, cette m�thode est responsable de la construction
     * du diagramme s'il n'est pas encore construit.
     * 
     * @return le diagramme JFreeChart
     */
    protected JFreeChart getChart()
    {
        return mChart;
    }

    /**
     * mettre <code>null</code> pour que le diagramme soit recalcul�
     * 
     * @param pChart le diagramme JFreeChart
     */
    protected void setChart( JFreeChart pChart )
    {
        mChart = pChart;
    }

    /**
     * Pour deboguer
     * 
     * @param pTitle un titre de frame
     * @return une frame (ChartFrame) contenant le diagramme
     */
    public ChartFrame getImageInFrame( String pTitle )
    {
        return new ChartFrame( pTitle, getChart() );
    }

    /**
     * Permet de d�finir la hauteur et la largeur de l'image souhait�e
     * 
     * @param pHeight hauteur du diagramme
     * @param pWidth largeur du diagramme
     */
    public void setSize( int pHeight, int pWidth )
    {
        mHeight = pHeight;
        mWidth = pWidth;
        // Pour �tre sur de recalculer le diagramme (s'il a deja �t� calcul�) :
        setChart( null );
    }

    /**
     * @return la hauteur par d�faut
     */
    protected abstract int getDefaultHeight();

    /**
     * @return la largeur par d�faut
     */
    protected abstract int getDefaultWidth();

    /**
     * @return l'id de l'audit courant
     */
    public String getCurrentAuditId()
    {
        return mCurrentAuditId;
    }

    /**
     * @return l'id de l'audit pr�c�dent
     */
    public String getPreviousAuditId()
    {
        return mPreviousAuditId;
    }

    /**
     * @return l'id du projet
     */
    public String getProjectId()
    {
        return mProjectId;
    }
}