CheckstyleConfiguration.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.squalix.tools.ruleschecking;

import java.io.InputStream;

import org.apache.commons.digester.Digester;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.squale.squalecommon.util.xml.XmlImport;
import org.squale.squalix.configurationmanager.ConfigUtility;
import org.squale.squalix.core.exception.ConfigurationException;

/**
 * Configuration Checkstyle La configuration Checkstyle est d�finie dans un fichier XML, celui-ci est lu par cette
 * classe.
 */
public class CheckstyleConfiguration
    extends XmlImport
{
    /**
     * Logger.
     */
    private static final Log LOGGER = LogFactory.getLog( CheckstyleConfiguration.class );

    /** R�pertoire de g�n�ration de rapport */
    private String mReportDirectory;

    /** R�pertoire contenant les jars */
    private String mJarDirectory;

    /** Temporary directory which contains the source to analyze */
    private String mTempSourceDir;

    /**
     * Constructeur
     */
    public CheckstyleConfiguration()
    {
        super( LOGGER );
    }

    /**
     * Lecture du fichier de configuration
     * 
     * @param pStream flux
     * @throws ConfigurationException si erreur
     */
    public void parse( InputStream pStream )
        throws ConfigurationException
    {
        StringBuffer errors = new StringBuffer();
        Digester digester =
            preSetupDigester( "-//Squale //DTD Checkstyle Configuration 1.1//EN",
                              "/org/squale/squalix/tools/ruleschecking/checkstyle-config-1.1.dtd", errors );
        // Traitement du r�pertoire de g�n�ration des reports
        digester.addCallMethod( "checkstyle-configuration/reportDirectory", "setReportDirectory", 1,
                                new Class[] { String.class } );
        digester.addCallParam( "checkstyle-configuration/reportDirectory", 0 );
        // Traitement du r�pertoire des jars
        digester.addCallMethod( "checkstyle-configuration/jarDirectory", "setJarDirectory", 1,
                                new Class[] { String.class } );
        digester.addCallParam( "checkstyle-configuration/jarDirectory", 0 );
        //
        digester.addCallMethod( "checkstyle-configuration/tempSourceDir", "setTempSourceDir", 1,
                                new Class[] { String.class } );
        digester.addCallParam( "checkstyle-configuration/tempSourceDir", 0 );
        digester.push( this );
        // Appel du parser
        parse( digester, pStream, errors );
        if ( errors.length() > 0 )
        {
            throw new ConfigurationException( RulesCheckingMessages.getString( "error.configuration",
                                                                               new Object[] { errors.toString() } ) );
        }
    }

    /**
     * @return directory
     */
    public String getReportDirectory()
    {
        return mReportDirectory;
    }

    /**
     * @param pDirectory r�pertoire
     */
    public void setReportDirectory( String pDirectory )
    {
        mReportDirectory = ConfigUtility.filterStringWithSystemProps( pDirectory );
    }

    /**
     * @return r�pertoire des jars
     */
    public String getJarDirectory()
    {
        return mJarDirectory;
    }

    /**
     * @param pJarDirectory r�pertoire des jars
     */
    public void setJarDirectory( String pJarDirectory )
    {
        mJarDirectory = ConfigUtility.filterStringWithSystemProps( pJarDirectory );
    }

    /**
     * Getter method for the attribute mTempSourceDir
     * 
     * @return The location of the temporary source directory
     */
    public String getTempSourceDir()
    {
        return mTempSourceDir;
    }

    /**
     * Setter method for the attribute mTempSourceDir
     * 
     * @param tempSourceDir The new location of the temporary source directory
     */
    public void setTempSourceDir( String tempSourceDir )
    {
        mTempSourceDir = ConfigUtility.filterStringWithSystemProps( tempSourceDir );
    }

}