RuleSetBO.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.rulechecking;

import java.io.Serializable;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.HashMap;
import java.util.Map;

/**
 * Jeu de r�gles Un ensemble de r�gles est li� � un outil, il d�finit les r�gles qui sont v�rifi�es par cet outil.
 * 
 * @hibernate.class table="RuleSet" mutable="true"
 * @hibernate.discriminator column="subclass"
 */

public abstract class RuleSetBO
    implements Serializable
{
    /**
     * Identifiant (au sens technique) de l'objet
     */
    protected long mId = -1;

    /**
     * Nom du jeu de r�gles
     */
    protected String mName;

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

    /**
     * Liste des r�gles
     */
    protected Map mRules = new HashMap();

    /**
     * Constucteur par d�faut
     */
    public RuleSetBO()
    {
        mId = -1;
        setDateOfUpdate( new GregorianCalendar().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="RuleSetId" unsaved-value="-1" length="19"
     * @hibernate.generator-param name="sequence" value="RuleSet_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;
    }

    /**
     * Ajout d'une r�gle
     * 
     * @param pRule r�gle
     */
    public void addRule( RuleBO pRule )
    {
        getRules().put( pRule.getCode(), pRule );
    }

    /**
     * Access method for the mRules property.
     * 
     * @return the current value of the mRules property
     * @hibernate.map lazy="true" cascade="all" sort="unsorted" inverse="true"
     * @hibernate.index column="Code" type="string"
     * @hibernate.key column="RuleSetId" on-delete="cascade"
     * @hibernate.one-to-many class="org.squale.squalecommon.enterpriselayer.businessobject.rulechecking.RuleBO"
     */

    public Map getRules()
    {
        return mRules;
    }

    /**
     * Sets the value of the mRules property.
     * 
     * @param pRules the new value of the mRules property
     */
    public void setRules( Map pRules )
    {
        mRules = pRules;
    }

    /**
     * Access method for the mVersion property.
     * 
     * @return the current value of the Version property
     * @hibernate.property name="name" column="Name" not-null="false" type="string" unique="false" update="true"
     *                     insert="true"
     */
    public String getName()
    {
        return mName;
    }

    /**
     * Sets the value of the mName property.
     * 
     * @param pName the new value of the mVersion property
     */
    public void setName( String pName )
    {
        mName = pName;
    }

    /**
     * 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;
    }
}