RoiMeasureDTO.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.datatransfertobject.result;

import java.util.Date;

/**
 * Repr�sente une mesure de ROI avec le nom de l'application concern� la date de l'audit et son r�sultat
 */
public class RoiMeasureDTO
    implements java.lang.Comparable
{

    /** Le nom de l'application concern�e par la mesure */
    private String mAppliName;

    /** La date de l'audit */
    private Date mAuditDate;

    /** La valeur du ROI pour cette application et cet audit */
    private double mValue;

    /**
     * @param pAppliName la nom de l'application
     * @param pAuditDate la date de l'audit
     * @param pValue la valeur du ROI
     */
    public RoiMeasureDTO( String pAppliName, Date pAuditDate, double pValue )
    {
        mAppliName = pAppliName;
        mAuditDate = pAuditDate;
        mValue = pValue;
    }

    /**
     * @return le nom de l'application
     */
    public String getAppliName()
    {
        return mAppliName;
    }

    /**
     * @return la date de l'audit
     */
    public Date getAuditDate()
    {
        return mAuditDate;
    }

    /**
     * @param pAppliName le nom de l'application
     */
    public void setAppliName( String pAppliName )
    {
        mAppliName = pAppliName;
    }

    /**
     * @param pDate la date de l'audit
     */
    public void setAuditDate( Date pDate )
    {
        mAuditDate = pDate;
    }

    /**
     * Comparaison sur le nom de l'appli puis la date si �galit�
     * 
     * @param pRoiMeasure la mesure du ROI
     * @return le r�sultat de la comparaison
     * @see java.lang.Comparable#compareTo(java.lang.Object)
     */
    public int compareTo( Object pRoiMeasure )
    {
        int result = 0;
        if ( pRoiMeasure instanceof RoiMeasureDTO )
        {
            RoiMeasureDTO roiMeasure = (RoiMeasureDTO) pRoiMeasure;
            if ( roiMeasure.mAppliName != null )
            {
                result = getAppliName().compareTo( roiMeasure.mAppliName );
                if ( ( 0 == result ) && ( getAuditDate() != null ) )
                {
                    result = getAuditDate().compareTo( roiMeasure.getAuditDate() );
                }
            }
        }
        return result;
    }

    /**
     * @return la valeur du ROI
     */
    public double getValue()
    {
        return mValue;
    }

    /**
     * @param pValue la valeur du ROI
     */
    public void setValue( double pValue )
    {
        mValue = pValue;
    }

}