JasperReportUtil.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;

import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;

import org.squale.squalecommon.util.ConstantRulesChecking;
import org.squale.squaleweb.resources.WebMessages;

/**
 * Utilitaire pour l'export PDF avec jasperReport
 */
public class JasperReportUtil
{

    /** Chemin racine de l'application */
    private static final String ROOT = "/squale";

    /**
     * @param pLocale la locale
     * @param pTreNames les noms des m�triques
     * @param pValues les valeurs des m�triques
     * @return les m�triques avec les valeurs associ�es sous forme de cha�ne pour l'afficher dans le PDF
     */
    public static String getMetrics( Locale pLocale, List pTreNames, List pValues )
    {
        List valuesStr = SqualeWebActionUtils.getAsStringsList( pValues );
        // La note de la pratique
        String result = WebMessages.getString( pLocale, "export.pdf.mark" );
        String mark = SqualeWebActionUtils.formatFloat( (String) valuesStr.get( 0 ) );
        if ( mark == null )
        {
            mark = "";
        }
        result += " : " + mark + "\n";
        // Les m�triques
        int i = 1;
        for ( Iterator it = pTreNames.iterator(); it.hasNext(); i++ )
        {
            result += WebMessages.getString( pLocale, (String) it.next() ) + "\t:";
            String curValue = (String) valuesStr.get( i );
            // curValue peut �tre nul
            if ( null == curValue )
            {
                curValue = "-";
            }
            if ( curValue.indexOf( "\n" ) > 0 )
            { // On passe le bloc � la ligne
                result += "\n";
            }
            else
            {
                result += "\t";
            }
            result += curValue + "\n";
        }
        return result;
    }

    /**
     * R�cup�re le pictogramme associ� � la s�v�rit� de la r�gle
     * 
     * @param pSeverity la s�v�rit�.
     * @return le chemin de l'image
     */
    public static String generateRulePicto( String pSeverity )
    {
        String picto = "";
        // Images en fonction de la s�v�rit� (error, warning, info)
        final HashMap severities = new HashMap();
        severities.put( ConstantRulesChecking.ERROR_LABEL, "/images/pictos/error.png" );
        severities.put( ConstantRulesChecking.WARNING_LABEL, "/images/pictos/warning.png" );
        severities.put( ConstantRulesChecking.INFO_LABEL, "/images/pictos/info.png" );
        // V�rification simpliste de la s�v�rit� pour �viter des exceptions
        // lors de sa conversion
        if ( pSeverity != null )
        {
            picto = (String) severities.get( pSeverity );
            if ( null == picto )
            {
                picto = "/images/pictos/na.gif";
            }
        }
        return picto;
    }

    /**
     * @param pNote la note
     * @return le chemin (adapt� aux rapports JASPER) vers le pictogramme associ� � la note
     */
    public static String generatePicto( String pNote )
    {
        return SqualeWebActionUtils.IMG[SqualeWebActionUtils.generatePicto( pNote )].replaceAll( ROOT, "" );
    }

    /**
     * @param currentMark la note courante
     * @param predecessorMark la note pr�c�dente
     * @return l'image repr�sentant l'�volution entre currentMark et predecessorMark
     */
    public static String getImageForTrend( String currentMark, String predecessorMark )
    {
        return SqualeWebActionUtils.getImageForTrend( currentMark, predecessorMark ).replaceAll( ROOT, "" );
    }

    /**
     * @param pText le texte � formater
     * @return le texte sans les balises html
     */
    public static String formatHTML( String pText )
    {
        String result = "";
        if ( null != pText )
        {
            // on remplace les saut de ligne
            result = pText.replaceAll( "<br/?>", "\n" );
            // les puces
            result = result.replaceAll( "<li>", "\n- " );
            result = result.replaceAll( "</li>", "\n" );
            // On supprime les autres balises
            result = result.replaceAll( "<.+>", "" );
        }
        return result;
    }
}