Refactored identities.

Entities have the method sameValueAs(otherEntity)
Value Objects have the method sameIdentiyAs(otherValueObject)
Events have the method sameEventAs(otherEvent)

dddsample/src/main/java/se/citerus/dddsample/domain/Cargo.java

@@ -121,6 +121,20 @@ public class Cargo {
   }
 
   /**
+   * Entities compare by identity, therefore the trackingId field is the only basis of comparison. For persistence we
+   * have an id field, but it is not used for identiy comparison.
+   *
+   * Compare this behavior to the value object {@link se.citerus.dddsample.domain.Leg#sameValueAs(Leg)}
+   *
+   * @param other The other cargo.
+   * @return <code>true</code> if the given cargo's and this cargos's trackingId is the same, regardles of other
+   * attributes.
+   */
+  private boolean sameIdentityAs(Cargo other) {
+    return trackingId.equals(other.trackingId);
+  }
+
+  /**
    * @param object to compare
    * @return True if tracking ids are equal.
    */
@@ -130,7 +144,7 @@ public class Cargo {
       return false;
     }
     Cargo other = (Cargo) object;
-    return trackingId.equals(other.trackingId);
+    return sameIdentityAs(other);
   }
 
   /**

dddsample/src/main/java/se/citerus/dddsample/domain/CarrierMovement.java

@@ -5,7 +5,6 @@ import javax.persistence.*;
 
 /**
  * A carrier movement is a vessel voyage from one location to another.
- *
  */
 @Entity
 public class CarrierMovement {
@@ -42,6 +41,44 @@ public class CarrierMovement {
   }
 
   // Needed by Hibernate
-  CarrierMovement() {}
+  CarrierMovement() {
+  }
+
+
+  /**
+   * Entities compare by identity, therefore the carrierMovementId field is the only basis of comparison. For
+   * persistence we have an id field, but it is not used for identiy comparison.
+   * <p/>
+   * Compare this behavior to the value object {@link se.citerus.dddsample.domain.Leg#sameValueAs(Leg)}
+   *
+   * @param other The other cargo.
+   * @return <code>true</code> if the given carrier movement's and this carrier movement's carrierId is the same,
+   *         regardles of other attributes.
+   */
+  public boolean sameIdentityAs(CarrierMovement other) {
+    if (carrierMovementId != null ? !carrierMovementId.equals(other.carrierMovementId) : other.carrierMovementId != null)
+      return false;
+
+    return true;
+  }
 
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (o == null || getClass() != o.getClass()) return false;
+
+    CarrierMovement that = (CarrierMovement) o;
+
+    return sameIdentityAs(that);
+  }
+
+  @Override
+  public int hashCode() {
+    int result;
+    result = (id != null ? id.hashCode() : 0);
+    result = 31 * result + (carrierMovementId != null ? carrierMovementId.hashCode() : 0);
+    result = 31 * result + (from != null ? from.hashCode() : 0);
+    result = 31 * result + (to != null ? to.hashCode() : 0);
+    return result;
+  }
 }

dddsample/src/main/java/se/citerus/dddsample/domain/DeliveryHistory.java

@@ -7,6 +7,8 @@ import java.util.*;
 
 /**
  * The delivery history of a cargo.
+ *
+ * Is this an entiy or a value object?
  */
 public class DeliveryHistory {
 

dddsample/src/main/java/se/citerus/dddsample/domain/HandlingEvent.java

@@ -1,7 +1,5 @@
 package se.citerus.dddsample.domain;
 
-import org.apache.commons.lang.builder.HashCodeBuilder;
-
 import javax.persistence.*;
 import java.util.Comparator;
 import java.util.Date;
@@ -80,9 +78,9 @@ public class HandlingEvent {
    * Constructor for events that do not have a carrier movement associated.
    *
    * @param cargo            cargo
-   * @param completionTime   completion time
-   * @param registrationTime registration time
-   * @param type             type of event. Legal values are CLAIM, RECIEVE and CUSTOMS
+   * @param completionTime   completion time, the reported time that the event actually happened (e.g. the receive took place).
+   * @param registrationTime registration time, the time the message is received
+   * @param type             type of event. Legal values are CLAIM, RECEIVE and CUSTOMS
    * @param location         where the event took place
    */
   public HandlingEvent(Cargo cargo, Date completionTime, Date registrationTime, Type type, Location location) {
@@ -102,8 +100,8 @@ public class HandlingEvent {
    * is the end point.
    *
    * @param cargo            cargo
-   * @param completionTime   completion time
-   * @param registrationTime registration time
+   * @param completionTime   completion time, the reported time that the event actually happened (e.g. the receive took place).
+   * @param registrationTime registration time, the time the message is received
    * @param type             type of event. Legal values are LOAD and UNLOAD
    * @param location         where the event took place
    * @param carrierMovement  carrier movement.
@@ -116,7 +114,6 @@ public class HandlingEvent {
     this.location = location;
     this.carrierMovement = carrierMovement;
 
-
     validateType();
   }
 
@@ -149,42 +146,46 @@ public class HandlingEvent {
     return this.cargo;
   }
 
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (o == null || getClass() != o.getClass()) return false;
+
+    HandlingEvent event = (HandlingEvent) o;
+
+    return sameEventAs(event);
+  }
+
   /**
-   * @param object to compare
-   * @return True if location, completion time and type are equal.
+   * Events compare by the attributes that identify the underlying event as opposed to the report of the event.
+   * Therefore the completion time is part of the comparison but not the registration time.
+   *
+   * Compare this behavior to the value object {@link se.citerus.dddsample.domain.Leg#sameValueAs(Leg)}
+   * Compare this behavior to the entity {@link se.citerus.dddsample.domain.Cargo#sameIdentityAs(Cargo)}
+   *
+   * @param other The other hanling event.
+   * @return <code>true</code> if the given handling event and this event are regarded as the same.
    */
-  @Override
-  public boolean equals(Object object) {
-    if (object == null) {
+  public boolean sameEventAs(HandlingEvent other) {
+    if (cargo != null ? !cargo.equals(other.cargo) : other.cargo != null) return false;
+    if (carrierMovement != null ? !carrierMovement.equals(other.carrierMovement) : other.carrierMovement != null)
       return false;
-    }
-    if (!(object instanceof HandlingEvent)) {
+    if (completionTime != null ? !completionTime.equals(other.completionTime) : other.completionTime != null)
       return false;
-    }
-    HandlingEvent other = (HandlingEvent) object;
-    return this.location.equals(other.location) &&
-            this.completionTime.equals(other.completionTime) &&
-            this.type.equals(other.type);
+    if (location != null ? !location.equals(other.location) : other.location != null) return false;
+    if (type != other.type) return false;
+
+    return true;
   }
 
-  /**
-   * @return Hash code calculated from the same properties as equals().
-   */
   @Override
   public int hashCode() {
-    return new HashCodeBuilder(7, 39).
-            append(this.location).
-            append(this.completionTime).
-            append(this.type).
-            toHashCode();
-  }
-
-  /**
-   * @param other to compare
-   * @return True if the ids are equal.
-   */
-  public boolean sameIdentityAs(HandlingEvent other) {
-    return other != null && id.equals(other.id);
+    int result;
+    result = (type != null ? type.hashCode() : 0);
+    result = 31 * result + (carrierMovement != null ? carrierMovement.hashCode() : 0);
+    result = 31 * result + (location != null ? location.hashCode() : 0);
+    result = 31 * result + (completionTime != null ? completionTime.hashCode() : 0);
+    result = 31 * result + (cargo != null ? cargo.hashCode() : 0);
+    return result;
   }
 
   /**

dddsample/src/main/java/se/citerus/dddsample/domain/Itinerary.java

@@ -75,8 +75,28 @@ public class Itinerary {
       return (leg.to().equals(event.location()));
     }
 
-
     //HandlingEvent.Type.CUSTOMS;
     return true;
   }
+
+  private boolean sameValueAs(Itinerary other) {
+    if (!legs.equals(other.legs)) return false;
+
+    return true;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (o == null || getClass() != o.getClass()) return false;
+
+    Itinerary itinerary = (Itinerary) o;
+
+    return sameValueAs(itinerary);
+  }
+
+  @Override
+  public int hashCode() {
+    return legs.hashCode();
+  }
 }

dddsample/src/main/java/se/citerus/dddsample/domain/Leg.java

@@ -22,4 +22,42 @@ public class Leg {
   public CarrierMovementId carrierMovementId() {
     return carrierMovementId;
   }
+
+  
+  /**
+   * Value objects compare by value, therefore the id field which must be part of the class in order to support
+   * persistence is ignored in the comparison.
+   * <p/>
+   * Compare this behavior to the entity {@link se.citerus.dddsample.domain.Cargo#sameIdentityAs(Cargo)}
+   *
+   * @param other The other leg.
+   * @return <code>true</code> if the given leg's and this leg's attributes are the same.
+   */
+  public boolean sameValueAs(Leg other) {
+    if (carrierMovementId != null ? !carrierMovementId.equals(other.carrierMovementId) : other.carrierMovementId != null)
+      return false;
+    if (from != null ? !from.equals(other.from) : other.from != null) return false;
+    if (to != null ? !to.equals(other.to) : other.to != null) return false;
+
+    return true;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (o == null || getClass() != o.getClass()) return false;
+
+    Leg leg = (Leg) o;
+
+    return sameValueAs(leg);
+  }
+
+  @Override
+  public int hashCode() {
+    int result;
+    result = (carrierMovementId != null ? carrierMovementId.hashCode() : 0);
+    result = 31 * result + (from != null ? from.hashCode() : 0);
+    result = 31 * result + (to != null ? to.hashCode() : 0);
+    return result;
+  }
 }

dddsample/src/main/java/se/citerus/dddsample/domain/Location.java

@@ -23,12 +23,12 @@ public class Location {
    * Special Location object that marks an unknown location.
    */
   public static final Location UNKNOWN = new Location(
-    new UnLocode("XX","XXX"), "Unknown location"
+     new UnLocode("XX", "XXX"), "Unknown location"
   );
 
   /**
    * @param unLocode UN Locode
-   * @param name location name
+   * @param name     location name
    * @throws IllegalArgumentException if the UN Locode or name is null
    */
   public Location(UnLocode unLocode, String name) {
@@ -57,7 +57,7 @@ public class Location {
 
   /**
    * @param object to compare
-   * @return True iff UN locodes are equal.
+   * @return Since this is an entiy this will be true iff UN locodes are equal.
    */
   @Override
   public boolean equals(Object object) {
@@ -71,6 +71,20 @@ public class Location {
       return false;
     }
     Location other = (Location) object;
+    return sameIdentityAs(other);
+  }
+
+  /**
+   * Entities compare by identity, therefore the unLocode field is the only basis of comparison. For persistence we
+   * have an id field, but it is not used for identiy comparison.
+   *
+   * Compare this behavior to the value object {@link se.citerus.dddsample.domain.Leg#sameValueAs(Leg)}
+   *
+   * @param other The other location.
+   * @return <code>true</code> if the given location's and this locations's unLocode is the same, regardles of other
+   * attributes.
+   */
+  public boolean sameIdentityAs(Location other) {
     return this.unLocode.equals(other.unLocode);
   }
 
@@ -91,6 +105,7 @@ public class Location {
   }
 
   // Needed by Hibernate
-  Location() {}
+  Location() {
+  }
 
 }

dddsample/src/main/java/se/citerus/dddsample/domain/TrackingId.java

@@ -9,7 +9,8 @@ import javax.persistence.Embeddable;
 
 /**
  * Identifies a particular cargo.
- *
+ * <p>
+ * Make sure to put a constraint in the database to make sure TrackingId is unique.
  */
 @Embeddable
 public class TrackingId {