CheckstyleImport.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.facade.checkstyle.xml;

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.enterpriselayer.businessobject.rulechecking.checkstyle.CheckstyleRuleSetBO;
import org.squale.squalecommon.util.xml.XmlImport;

/**
 * Parser de configuration de Checkstyle
 */
public class CheckstyleImport
    extends XmlImport
{

    /**
     * Logger
     */
    private static final Log LOGGER = LogFactory.getLog( CheckstyleImport.class );

    /** The public ID for version 1_1 of the configuration dtd */
    private static final String DTD_PUBLIC_ID_1_1 = "-//Puppy Crawl//DTD Check Configuration 1.1//EN";

    /** The resource for version 1_1 of the configuration dtd */
    private static final String DTD_RESOURCE_NAME_1_1 = "/com/puppycrawl/tools/checkstyle/configuration_1_1.dtd";

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

    /**
     * Importation d'un fichier de configuration checkstyle
     * 
     * @param pStream flux du fichier de configuration checkstyle
     * @param pErrors erreurs de traitement ou vide si aucune erreur n'est rencontr�e
     * @return collection de Rules checkstyle import��s sous la forme de CheckstyleRuleSetBO
     */
    public CheckstyleRuleSetBO importCheckstyle( InputStream pStream, StringBuffer pErrors )
    {

        CheckstyleRuleSetFactory ruleSetFactory = new CheckstyleRuleSetFactory();
        Digester configDigester = setupDigester( ruleSetFactory, pErrors );
        // lancement du parsing
        parse( configDigester, pStream, pErrors );

        return ruleSetFactory.getCheckstyleRuleSets();

    }

    /**
     * Configuration du digester Le digester est utilis� pour le chargement du fichier XML de r�gles
     * 
     * @param pRuleSetFactory factory
     * @param pErrors erreurs de traitement
     * @return digester
     */
    protected Digester setupDigester( CheckstyleRuleSetFactory pRuleSetFactory, StringBuffer pErrors )
    {
        Digester configDigester = preSetupDigester( DTD_PUBLIC_ID_1_1, DTD_RESOURCE_NAME_1_1, pErrors );
        // Traitement des RuleSet
        configDigester.addFactoryCreate( "module/metadata", pRuleSetFactory );

        // Initialisation des caract�ristiques de la r�gle, � r�cup�rer dans la seconde balise "metadata"
        CheckstyleRulePractice checkstyleRulePractice = new CheckstyleRulePractice();
        configDigester.addFactoryCreate( "module/module/metadata", checkstyleRulePractice );

        // Traitement des Modules (rules)
        CheckstyleModuleFactory checkstyleModuleFactory = new CheckstyleModuleFactory();

        configDigester.addFactoryCreate( "module/module/module", checkstyleModuleFactory );
        // Traitement des propri�t�s du Module
        configDigester.addCallMethod( "module/module/module/property", "addProperty", 2, new Class[] { String.class,
            String.class } );

        configDigester.addCallParam( "module/module/module/property", 0, "name" );
        configDigester.addCallParam( "module/module/module/property", 1, "value" );

        // Traitement des Rules
        CheckstyleRuleFactory checkstyleRuleFactory =
            new CheckstyleRuleFactory( pRuleSetFactory, checkstyleRulePractice );
        configDigester.addFactoryCreate( "module/module/module/metadata", checkstyleRuleFactory );

        configDigester.addSetTop( "module/module/module/metadata", "addModule" );

        return configDigester;
    }

}