/*
 * file:       CostRateTableEntry.java
 * author:     Jon Iles
 * copyright:  (c) Packwood Software 2009
 * date:       08/06/2009
 */

/*
 * This library 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 2.1 of the License, or (at your
 * option) any later version.
 *
 * This library 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 Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
 */

package net.sf.mpxj;

import java.util.Date;

import net.sf.mpxj.common.DateHelper;
import net.sf.mpxj.common.NumberHelper;

/** 
 * This class represents a row from a resource's cost rate table.
 * Note that MS Project always represents costs as an hourly rate,
 * it holds an additional field to indicate the format used when 
 * displaying the rate.
 */
public final class CostRateTableEntry implements Comparable<CostRateTableEntry>
{
   /**
    * Constructor. Used to construct singleton default table entry. 
    */
   private CostRateTableEntry()
   {
      m_endDate = DateHelper.LAST_DATE;
      m_standardRate = new Rate(0, TimeUnit.HOURS);
      m_standardRateFormat = TimeUnit.HOURS;
      m_overtimeRate = m_standardRate;
      m_overtimeRateFormat = TimeUnit.HOURS;
      m_costPerUse = NumberHelper.getDouble(0);
   }

   /**
    * Constructor.
    * 
    * @param standardRate standard rate
    * @param standardRateFormat standard rate format
    * @param overtimeRate overtime rate
    * @param overtimeRateFormat overtime rate format
    * @param costPerUse cost per use
    * @param endDate end date
    */
   public CostRateTableEntry(Rate standardRate, TimeUnit standardRateFormat, Rate overtimeRate, TimeUnit overtimeRateFormat, Number costPerUse, Date endDate)
   {
      m_endDate = endDate;
      m_standardRate = standardRate;
      m_standardRateFormat = standardRateFormat;
      m_overtimeRate = overtimeRate;
      m_overtimeRateFormat = overtimeRateFormat;
      m_costPerUse = costPerUse;
   }

   /**
    * Retrieves the end date after which this table entry is not valid.
    * 
    * @return end date
    */
   public Date getEndDate()
   {
      return m_endDate;
   }

   /**
    * Retrieves the standard rate represented by this entry.
    * 
    * @return standard rate
    */
   public Rate getStandardRate()
   {
      return m_standardRate;
   }

   /**
    * Retrieves the format used when displaying the standard rate.
    * 
    * @return standard rate format
    */
   public TimeUnit getStandardRateFormat()
   {
      return m_standardRateFormat;
   }

   /**
    * Retrieves the overtime rate represented by this entry.
    * 
    * @return overtime rate
    */
   public Rate getOvertimeRate()
   {
      return m_overtimeRate;
   }

   /**
    * Retrieves the format used when displaying the overtime rate.
    * 
    * @return overtime rate format
    */
   public TimeUnit getOvertimeRateFormat()
   {
      return m_overtimeRateFormat;
   }

   /**
    * Retrieves the cost per use represented by this entry.
    * 
    * @return per use rate
    */
   public Number getCostPerUse()
   {
      return m_costPerUse;
   }

   /**
    * {@inheritDoc}
    */
   @Override public int compareTo(CostRateTableEntry o)
   {
      return DateHelper.compare(m_endDate, o.m_endDate);
   }

   /**
    * {@inheritDoc}
    */
   @Override public String toString()
   {
      return "[CostRateTableEntry standardRate=" + m_standardRate + " overtimeRate=" + m_overtimeRate + " costPerUse=" + m_costPerUse + " endDate=" + m_endDate + "]";
   }

   private Date m_endDate;
   private Rate m_standardRate;
   private TimeUnit m_standardRateFormat;
   private Rate m_overtimeRate;
   private TimeUnit m_overtimeRateFormat;
   private Number m_costPerUse;

   public static final CostRateTableEntry DEFAULT_ENTRY = new CostRateTableEntry();
}