QualityGridBO.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.businessobject.rule;

import java.io.Serializable;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.HashSet;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;

import org.squale.squalecommon.enterpriselayer.businessobject.config.ProjectProfileBO;

/**
 * Grille qualit� Une grille qualit� est compos�e d'un ensemble de facteurs.
 * 
 * @hibernate.class table="QualityGrid" mutable="true" lazy="true"
 */
public class QualityGridBO
    implements Serializable
{
    /**
     * Identifiant (au sens technique) de l'objet
     */
    private long mId;

    /**
     * Liste des crit�res permettant de calculer le facteur
     */
    private SortedSet mFactors;

    /**
     * Date de la creation de la regle de calcul d'un r�sultat qualit�
     */
    private Date mDateOfUpdate;

    /**
     * Nom de la grille
     */
    private String mName;

    /** les profils associ�s */
    private Set mProfiles = new HashSet();

    /**
     * Constructeur
     */
    public QualityGridBO()
    {
        mFactors = new TreeSet();
        mId = -1;
        Calendar cal = new GregorianCalendar();
        setDateOfUpdate( cal.getTime() );
    }

    /**
     * Access method for the mId property.
     * 
     * @return the current value of the mId property Note: unsaved-value An identifier property value that indicates
     *         that an instance is newly instantiated (unsaved), distinguishing it from transient instances that were
     *         saved or loaded in a previous session. If not specified you will get an exception like this: another
     *         object associated with the session has the same identifier
     * @hibernate.id generator-class="native" type="long" column="QualityGridId" unsaved-value="-1" length="19"
     * @hibernate.generator-param name="sequence" value="qualitygrid_sequence"
     */
    public long getId()
    {
        return mId;
    }

    /**
     * Sets the value of the mId property.
     * 
     * @param pId the new value of the mId property
     */
    public void setId( long pId )
    {
        mId = pId;
    }

    /**
     * @hibernate.property name="name" column="Name" type="string" not-null="true" unique="false" update="true"
     *                     insert="true"
     * @return nom
     */
    public String getName()
    {
        return mName;
    }

    /**
     * @param pName nom
     */
    public void setName( String pName )
    {
        mName = pName;
    }

    /**
     * R�cup�re les profils li�s � cette grille
     * 
     * @return les profils
     * @hibernate.set table="Profiles_Grids" lazy="true" inverse="true" cascade="none" sort="unsorted"
     * @hibernate.key column="GridId"
     * @hibernate.many-to-many class="org.squale.squalecommon.enterpriselayer.businessobject.config.ProjectProfileBO"
     *                         column="ProfileId" outer-join="auto"
     */
    public Set getProfiles()
    {
        return mProfiles;
    }

    /**
     * R�cup�re la date de mise � jour
     * 
     * @return la date de mise � jour
     * @hibernate.property name="dateOfUpdate" column="DateOfUpdate" type="timestamp" not-null="true" unique="false"
     *                     update="true" insert="true"
     */
    public Date getDateOfUpdate()
    {
        return mDateOfUpdate;
    }

    /**
     * Affecte la date de mise � jour
     * 
     * @param pDate la date de mise � jour
     */
    private void setDateOfUpdate( Date pDate )
    {
        mDateOfUpdate = pDate;
    }

    /**
     * Access method for the mFactors property.
     * 
     * @return the current value of the mFactors property
     * @hibernate.set table="GridFactor_Rule" lazy="true" cascade="all" inverse="false" sort="natural"
     * @hibernate.key column="QualityGridId"
     * @hibernate.many-to-many class="org.squale.squalecommon.enterpriselayer.businessobject.rule.FactorRuleBO"
     *                         column="FactorRuleId" outer-join="auto"
     */
    public SortedSet getFactors()
    {
        return mFactors;
    }

    /**
     * Affectation des facteurs
     * 
     * @param pFactors facteurs
     */
    public void setFactors( SortedSet pFactors )
    {
        mFactors = pFactors;
    }

    /**
     * Ajout d'un facteur
     * 
     * @param pFactor facteur
     */
    public void addFactor( FactorRuleBO pFactor )
    {
        mFactors.add( pFactor );
    }

    /**
     * @param pProfiles les profils disponibles pour cette grille
     */
    public void setProfiles( Set pProfiles )
    {
        mProfiles = pProfiles;
    }

    /**
     * @param pProfile le profil � ajouter
     */
    public void addProfile( ProjectProfileBO pProfile )
    {
        mProfiles.add( pProfile );
    }

}