PmdForm.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.applicationlayer.formbean.component.parameters;

import javax.servlet.http.HttpServletRequest;

import org.apache.struts.action.ActionError;
import org.apache.struts.action.ActionMapping;

import org.squale.squalecommon.enterpriselayer.businessobject.component.parameters.ParametersConstants;
import org.squale.squaleweb.transformer.component.parameters.PmdConfTransformer;

/**
 * Formulaire de configuration de PMD
 */
public class PmdForm
    extends AbstractParameterForm
{

    /** Indication de la n�cessite des sources JSP */
    private boolean mJspSourcesRequired;

    /**
     * Les rulesets disponibles en java
     */
    private String[] mJavaRuleSets;

    /**
     * Les rulesets disponibles en jsp
     */
    private String[] mJspRuleSets;

    /**
     * La version selectionn�e en java
     */
    private String mSelectedJavaRuleSet;

    /**
     * La version selectionn�e en jsp
     */
    private String mSelectedJspRuleSet;

    /**
     * Constructeur par d�faut
     */
    public PmdForm()
    {
    }

    /**
     * @return les ruleset disponibles en java
     */
    public String[] getJavaRuleSets()
    {
        return mJavaRuleSets;
    }

    /**
     * @param pSelectedJavaRuleSet la version s�lectionn�e
     */
    public void setSelectedJavaRuleSet( String pSelectedJavaRuleSet )
    {
        mSelectedJavaRuleSet = pSelectedJavaRuleSet;
    }

    /**
     * @return ruleset java s�lectionn�
     */
    public String getSelectedJavaRuleSet()
    {
        return mSelectedJavaRuleSet;
    }

    /**
     * @param pJavaRuleSets les versions
     */
    public void setJavaRuleSets( String[] pJavaRuleSets )
    {
        mJavaRuleSets = pJavaRuleSets;
    }

    /**
     * @return les ruleset disponibles en jsp
     */
    public String[] getJspRuleSets()
    {
        return mJspRuleSets;
    }

    /**
     * @param pSelectedJspRuleSet la version s�lectionn�e
     */
    public void setSelectedJspRuleSet( String pSelectedJspRuleSet )
    {
        mSelectedJspRuleSet = pSelectedJspRuleSet;
    }

    /**
     * @return ruleset jsp s�lectionn�
     */
    public String getSelectedJspRuleSet()
    {
        return mSelectedJspRuleSet;
    }

    /**
     * @param pJspRuleSets les versions
     */
    public void setJspRuleSets( String[] pJspRuleSets )
    {
        mJspRuleSets = pJspRuleSets;
    }

    /**
     * @return true si les sources JSP sont requises
     */
    public boolean isJspSourcesRequired()
    {
        return mJspSourcesRequired;
    }

    /**
     * @param pJspSourcesRequired indicateur de sources JSP requises
     */
    public void setJspSourcesRequired( boolean pJspSourcesRequired )
    {
        mJspSourcesRequired = pJspSourcesRequired;
    }

    /**
     * @see org.squale.squaleweb.applicationlayer.formbean.component.parameters.AbstractParameterForm#getTransformer()
     *      {@inheritDoc}
     */
    public Class getTransformer()
    {
        return PmdConfTransformer.class;
    }

    /**
     * @see org.squale.squaleweb.applicationlayer.formbean.component.parameters.AbstractParameterForm#getNameInSession()
     *      {@inheritDoc}
     */
    public String getNameInSession()
    {
        return "pmdForm";
    }

    /**
     * @see org.squale.squaleweb.applicationlayer.formbean.component.parameters.AbstractParameterForm#getParametersConstants()
     *      {@inheritDoc}
     */
    public String[] getParametersConstants()
    {
        return new String[] { ParametersConstants.PMD };
    }

    /**
     * @see org.apache.struts.action.ActionForm#reset(org.apache.struts.action.ActionMapping,
     *      javax.servlet.http.HttpServletRequest) {@inheritDoc}
     */
    public void reset( ActionMapping mapping, HttpServletRequest request )
    {
        setSelectedJavaRuleSet( "" );
        setSelectedJspRuleSet( "" );
        setJavaRuleSets( new String[0] );
        setJspRuleSets( new String[0] );
        setJspSourcesRequired( false );
    }

    /**
     * @see org.squale.squaleweb.applicationlayer.formbean.component.parameters.AbstractParameterForm#getTaskName()
     *      {@inheritDoc}
     */
    public String getTaskName()
    {
        return "PmdTask";
    }

    /**
     * @see org.squale.squaleweb.applicationlayer.formbean.component.parameters.AbstractParameterForm#validateConf(org.apache.struts.action.ActionMapping,
     *      javax.servlet.http.HttpServletRequest) {@inheritDoc}
     */
    protected void validateConf( ActionMapping pMapping, HttpServletRequest pRequest )
    {
        // V�rification de la version java choisie
        setSelectedJavaRuleSet( getSelectedJavaRuleSet().trim() );
        if ( getSelectedJavaRuleSet().length() == 0 )
        {
            addError( "selectedJavaRuleSet", new ActionError( "error.field.required" ) );
        }
        // V�rification de la version jsp choisie
        if ( isJspSourcesRequired() )
        {
            setSelectedJspRuleSet( getSelectedJspRuleSet().trim() );
            if ( getSelectedJspRuleSet().length() == 0 )
            {
                addError( "selectedJspRuleSet", new ActionError( "error.field.required" ) );
            }
        }
    }
}