HRPlanningEntryDO.java

/////////////////////////////////////////////////////////////////////////////
//
// Project ProjectForge Community Edition
//         www.projectforge.org
//
// Copyright (C) 2001-2014 Kai Reinhard (k.reinhard@micromata.de)
//
// ProjectForge is dual-licensed.
//
// This community edition is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as published
// by the Free Software Foundation; version 3 of the License.
//
// This community edition 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 General Public License along
// with this program; if not, see http://www.gnu.org/licenses/.
//
/////////////////////////////////////////////////////////////////////////////

package org.projectforge.humanresources;

import java.math.BigDecimal;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.FetchType;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.Table;
import javax.persistence.Transient;

import org.apache.commons.lang.ObjectUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.hibernate.search.annotations.Field;
import org.hibernate.search.annotations.Index;
import org.hibernate.search.annotations.Indexed;
import org.hibernate.search.annotations.IndexedEmbedded;
import org.hibernate.search.annotations.Store;
import org.projectforge.common.ObjectHelper;
import org.projectforge.core.DefaultBaseDO;
import org.projectforge.core.Priority;
import org.projectforge.core.ShortDisplayNameCapable;
import org.projectforge.fibu.KundeDO;
import org.projectforge.fibu.ProjektDO;
import org.projectforge.fibu.ProjektFormatter;
import org.projectforge.user.PFUserContext;


/**
 * 
 * @author Mario Groß (m.gross@micromata.de)
 * 
 */
@Entity
@Indexed
@Table(name = "T_HR_PLANNING_ENTRY")
public class HRPlanningEntryDO extends DefaultBaseDO implements ShortDisplayNameCapable
{
  private static final long serialVersionUID = -7788797217095084177L;

  @IndexedEmbedded(depth = 3)
  private HRPlanningDO planning;

  @IndexedEmbedded(depth = 2)
  private ProjektDO projekt;

  @Field(index = Index.TOKENIZED, store = Store.NO)
  private HRPlanningEntryStatus status;

  @Field(index = Index.UN_TOKENIZED, store = Store.NO)
  private Priority priority;

  @Field(index = Index.UN_TOKENIZED, store = Store.NO)
  private Integer probability;

  /**
   * Ohne Wochentagszuordnung.
   */
  @Field(index = Index.UN_TOKENIZED, store = Store.NO)
  private BigDecimal unassignedHours;

  @Field(index = Index.UN_TOKENIZED, store = Store.NO)
  private BigDecimal mondayHours;

  @Field(index = Index.UN_TOKENIZED, store = Store.NO)
  private BigDecimal tuesdayHours;

  @Field(index = Index.UN_TOKENIZED, store = Store.NO)
  private BigDecimal wednesdayHours;

  @Field(index = Index.UN_TOKENIZED, store = Store.NO)
  private BigDecimal thursdayHours;

  @Field(index = Index.UN_TOKENIZED, store = Store.NO)
  private BigDecimal fridayHours;

  @Field(index = Index.UN_TOKENIZED, store = Store.NO)
  private BigDecimal weekendHours;

  @Field(index = Index.TOKENIZED, store = Store.NO)
  private String description;

  @ManyToOne(fetch = FetchType.EAGER)
  @JoinColumn(name = "planning_fk", nullable = false)
  public HRPlanningDO getPlanning()
  {
    return planning;
  }

  public void setPlanning(HRPlanningDO planning)
  {
    this.planning = planning;
  }

  @Transient
  public Integer getPlanningId()
  {
    if (this.planning == null) {
      return null;
    }
    return this.planning.getId();
  }

  @Enumerated(EnumType.STRING)
  @Column(length = 20)
  public Priority getPriority()
  {
    return priority;
  }

  public void setPriority(Priority priority)
  {
    this.priority = priority;
  }

  @Column
  public Integer getProbability()
  {
    return probability;
  }

  public void setProbability(Integer probability)
  {
    this.probability = probability;
  }

  /**
   * @return Hours without assigned day of week (unspecified). This means, it doesn't matter on which day of week the job will be done.
   */
  @Column(scale = 2, precision = 5)
  public BigDecimal getUnassignedHours()
  {
    return unassignedHours;
  }

  public void setUnassignedHours(BigDecimal unassignedHours)
  {
    this.unassignedHours = unassignedHours;
  }

  @Column(scale = 2, precision = 5)
  public BigDecimal getMondayHours()
  {
    return mondayHours;
  }

  public void setMondayHours(BigDecimal mondayHours)
  {
    this.mondayHours = mondayHours;
  }

  @Column(scale = 2, precision = 5)
  public BigDecimal getTuesdayHours()
  {
    return tuesdayHours;
  }

  public void setTuesdayHours(BigDecimal tuesdayHours)
  {
    this.tuesdayHours = tuesdayHours;
  }

  @Column(scale = 2, precision = 5)
  public BigDecimal getWednesdayHours()
  {
    return wednesdayHours;
  }

  public void setWednesdayHours(BigDecimal wednesdayHours)
  {
    this.wednesdayHours = wednesdayHours;
  }

  @Column(scale = 2, precision = 5)
  public BigDecimal getThursdayHours()
  {
    return thursdayHours;
  }

  public void setThursdayHours(BigDecimal thursdayHours)
  {
    this.thursdayHours = thursdayHours;
  }

  @Column(scale = 2, precision = 5)
  public BigDecimal getFridayHours()
  {
    return fridayHours;
  }

  public void setFridayHours(BigDecimal fridayHours)
  {
    this.fridayHours = fridayHours;
  }

  @Column(scale = 2, precision = 5)
  public BigDecimal getWeekendHours()
  {
    return weekendHours;
  }

  public void setWeekendHours(BigDecimal weekendHours)
  {
    this.weekendHours = weekendHours;
  }

  @Column(length = 4000)
  public String getDescription()
  {
    return description;
  }

  public void setDescription(String description)
  {
    this.description = description;
  }

  @Transient
  public String getShortDescription()
  {
    return StringUtils.abbreviate(getDescription(), 50);
  }

  @ManyToOne(fetch = FetchType.EAGER)
  @JoinColumn(name = "projekt_fk")
  public ProjektDO getProjekt()
  {
    return projekt;
  }

  public void setProjekt(ProjektDO projekt)
  {
    this.projekt = projekt;
  }

  @Transient
  public Integer getProjektId()
  {
    if (this.projekt == null) {
      return null;
    }
    return this.projekt.getId();
  }

  @Transient
  public String getProjektName()
  {
    if (this.projekt == null) {
      return "";
    }
    return this.projekt.getName();
  }

  @Transient
  public String getProjektNameOrStatus()
  {
    if (this.status != null) {
      return PFUserContext.getLocalizedString(status.getI18nKey());
    } else {
      return getProjektName();
    }
  }

  /**
   * Gets the customer of the project.
   * @see ProjektFormatter#formatProjektKundeAsString(ProjektDO, KundeDO, String)
   */
  @Transient
  public String getProjektKundeAsString()
  {
    return ProjektFormatter.formatProjektKundeAsString(this.projekt, null, null);
  }

  @Enumerated(EnumType.STRING)
  @Column(name = "status", length = 20)
  public HRPlanningEntryStatus getStatus()
  {
    return status;
  }

  public void setStatus(HRPlanningEntryStatus status)
  {
    this.status = status;
  }

  /**
   * @return The total duration of all assigned hours (unassigned hours, monday, tuesday...)
   */
  @Transient
  public BigDecimal getTotalHours()
  {
    BigDecimal duration = BigDecimal.ZERO;
    if (this.unassignedHours != null) {
      duration = duration.add(this.unassignedHours);
    }
    if (this.mondayHours != null) {
      duration = duration.add(this.mondayHours);
    }
    if (this.tuesdayHours != null) {
      duration = duration.add(this.tuesdayHours);
    }
    if (this.wednesdayHours != null) {
      duration = duration.add(this.wednesdayHours);
    }
    if (this.thursdayHours != null) {
      duration = duration.add(this.thursdayHours);
    }
    if (this.fridayHours != null) {
      duration = duration.add(this.fridayHours);
    }
    if (this.weekendHours != null) {
      duration = duration.add(this.weekendHours);
    }
    return duration;
  }

  @Transient
  public boolean isEmpty()
  {
    return ObjectHelper.isEmpty(this.description, this.mondayHours, this.tuesdayHours, this.wednesdayHours, this.thursdayHours,
        this.fridayHours, this.weekendHours, this.priority, this.probability, this.projekt);
  }

  @Override
  public boolean equals(Object o)
  {
    if (o instanceof HRPlanningEntryDO) {
      HRPlanningEntryDO other = (HRPlanningEntryDO) o;
      if (this.getId() != null || other.getId() != null) {
        return ObjectUtils.equals(this.getId(), other.getId());
      }
      if (ObjectUtils.equals(this.getPlanningId(), other.getPlanningId()) == false)
        return false;
      if (ObjectUtils.equals(this.getProjektId(), other.getProjektId()) == false)
        return false;
      if (ObjectUtils.equals(this.getStatus(), other.getStatus()) == false)
        return false;
      return true;
    }
    return false;
  }

  @Override
  public int hashCode()
  {
    HashCodeBuilder hcb = new HashCodeBuilder();
    if (getId() != null) {
      hcb.append(getId());
    } else {
      if (getPlanningId() != null) {
        hcb.append(getPlanningId());
      }
      if (getProjektId() != null) {
        hcb.append(getProjektId());
      }
      if (getStatus() != null) {
        hcb.append(getStatus());
      }
    }
    return hcb.toHashCode();
  }

  @Transient
  public String getShortDisplayName()
  {
    return getProjekt() != null ? getProjekt().getName() : "";
  }
  
  /**
   * Clones this entry (without id's).
   * @return
   */
  public HRPlanningEntryDO newClone()
  {
    final HRPlanningEntryDO entry = new HRPlanningEntryDO();
    entry.copyValuesFrom(this, "id");
    return entry;
  }
}