GraphApplicationComponentAccess.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.squalecommon.enterpriselayer.applicationcomponent.display;

import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Map;

import org.squale.jraf.commons.exception.JrafEnterpriseException;
import org.squale.jraf.provider.accessdelegate.DefaultExecuteComponent;
import org.squale.squalecommon.datatransfertobject.component.ComponentDTO;
import org.squale.squalecommon.datatransfertobject.result.RoiDTO;
import org.squale.squalecommon.enterpriselayer.facade.quality.MeasureFacade;
import org.squale.squalecommon.enterpriselayer.facade.roi.RoiFacade;
import org.squale.squalecommon.util.messages.CommonMessages;

/**
 * <p>
 * Title : GraphApplicationComponentAccess.java
 * </p>
 * <p>
 * Description : Application component graph
 * </p>
 * Classe permettant de recuperer des objets de type GraphDTO stock�s en base ou encore g�n�r� � la vol�e
 */
public class GraphApplicationComponentAccess
    extends DefaultExecuteComponent
{

    /**
     * Date a partir de laquelle on recupere les audits
     */
    private static final Integer AUDIT_TIME = new Integer( CommonMessages.getInt( "audit.historic.nombre.jour" ) );

    /**
     * Permet de r�cup�rer l'historique pour un composant donn�, une date et une collection de tres
     * 
     * @param pComponent ComponentDTO avec identifiant renseign�
     * @param pTreLabel label du tre
     * @param pTreKey tre sur lequel se basera l'historique
     * @param pAuditTime Date en nombre de jours sur lesquels aura lieu l'historique
     * @param pRuleId id de la r�gle ou nul s'il s'agit d'une m�trique. Dans le cas d'une r�gle, pTreKey donne le nom
     *            qui figurera sur le graphique
     * @return Collection de GraphDTO
     * @throws JrafEnterpriseException Exception JRAF
     */
    public Object[] getHistoricGraph( ComponentDTO pComponent, String pTreKey, String pTreLabel, Date pAuditTime,
                                      Long pRuleId )
        throws JrafEnterpriseException
    {

        Date newAuditTime = pAuditTime;

        if ( !( pAuditTime instanceof Date ) )
        {
            GregorianCalendar gc = (GregorianCalendar) GregorianCalendar.getInstance();
            gc.add( GregorianCalendar.DAY_OF_MONTH, -AUDIT_TIME.intValue() );
            newAuditTime = gc.getTime();
        }

        // Initialisation
        Object[] result = null; // retour de la methode

        // Recuperation dans la facade du GraphDTO
        if ( pComponent != null )
        {
            result = MeasureFacade.getHistoricGraph( pComponent, pTreKey, pTreLabel, newAuditTime, pRuleId );
        }

        return result;
    }

    /**
     * R�cup�re l'histogramme repr�sentant le roi sur une ann�e glissante
     * 
     * @param pRoi le roi g�n�ral
     * @throws JrafEnterpriseException Exception JRAF
     * @return le graphe repr�sentant le ROI
     */
    public Map getRoiGraph( RoiDTO pRoi )
        throws JrafEnterpriseException
    {
        return RoiFacade.getRoiGraph( pRoi );
    }

    /**
     * R�cup�re le Kiviat d'une application
     * 
     * @param pAuditId l'audit
     * @throws JrafEnterpriseException Exception JRAF
     * @return graphe de type Kiviat de l'application audit�e
     */
    public Map getApplicationKiviatGraph( Long pAuditId )
        throws JrafEnterpriseException
    {
        return MeasureFacade.getApplicationKiviat( pAuditId, "false" );
    }

    /**
     * R�cup�re le Kiviat d'une application
     * 
     * @param pAuditId l'audit
     * @param pAllFactors tous les facteurs (= "true") ou bien seulement ceux ayant une note
     * @throws JrafEnterpriseException Exception JRAF
     * @return graphe de type Kiviat de l'application audit�e
     */
    public Map getApplicationKiviatGraph( Long pAuditId, String pAllFactors )
        throws JrafEnterpriseException
    {
        return MeasureFacade.getApplicationKiviat( pAuditId, pAllFactors );
    }

    /**
     * R�cup�re le Kiviat d'un projet
     * 
     * @param pProjectId le projet
     * @param pAuditId l'audit
     * @param pAllFactors tous les facteurs (= "true") ou bien seulement ceux ayant une note
     * @throws JrafEnterpriseException Exception JRAF
     * @return tableau d'objets : la map des donn�es Kiviat du projet audit� + le bool�en pour affichage de la case �
     *         cocher tous les facteurs
     */
    public Object[] getProjectKiviatGraph( Long pProjectId, Long pAuditId, String pAllFactors )
        throws JrafEnterpriseException
    {
        return MeasureFacade.getProjectKiviat( pProjectId, pAuditId, pAllFactors );
    }

    /**
     * R�cup�re le PieChart d'une application
     * 
     * @param pAuditId l'audit
     * @throws JrafEnterpriseException Exception JRAF
     * @return graphe de type PieChart pour l'application audit�e
     */
    public Object[] getApplicationPieChartGraph( Long pAuditId )
        throws JrafEnterpriseException
    {
        return MeasureFacade.getApplicationPieChart( pAuditId );
    }

    /**
     * R�cup�re le Scatterplot d'un projet
     * 
     * @param pProjectId le projet
     * @param pAuditId l'audit
     * @throws JrafEnterpriseException Exception JRAF
     * @return Map contenant les donn�es format�es, n�cessaires � la constitution du graphe
     */
    public Object[] getProjectBubbleGraph( Long pProjectId, Long pAuditId )
        throws JrafEnterpriseException
    {
        return MeasureFacade.getProjectBubble( pProjectId, pAuditId );
    }

    /**
     * Constructeur par d�faut
     * 
     * @roseuid 42CBFBFA0216
     */
    public GraphApplicationComponentAccess()
    {
    }
}