Domain model persisted using Hibernate annotations.

Repository test against an actual database.

Hibernate needs package-protected no-args constructors, which blocks the use of final in many places.

"Long id" properties are excluded from equals and hashcode builders, to enforce the use of natural business keys that are separate from persistence details.

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

@@ -3,17 +3,35 @@ package se.citerus.dddsample.domain;
 import org.apache.commons.lang.builder.ReflectionToStringBuilder;
 import org.apache.commons.lang.builder.ToStringStyle;
 
+import javax.persistence.*;
+
 
 /**
  * A Cargo an entity identifed by TrackingId and is capable of getting its DeliveryHistory plus a number
  * of convenience operation for finding current destination etc.
  */
+@Entity
+@Table(name = "cargo")
 public class Cargo {
-  private final TrackingId trackingId;
-  private final Location origin;
-  private final Location finalDestination;
+
+  @EmbeddedId
+  private TrackingId trackingId;
+
+  @ManyToOne(fetch = FetchType.EAGER)
+  @JoinColumn(name = "origin_location_fk")
+  private Location origin;
+
+  @ManyToOne(fetch = FetchType.EAGER)
+  @JoinColumn(name = "final_destination_location_fk")
+  private Location finalDestination;
+
+  @OneToOne(fetch = FetchType.LAZY)
+  @JoinColumn(name = "delivery_history_fk")
   private DeliveryHistory history;
 
+  // Needed by Hibernate
+  Cargo() {}
+
   public Cargo(TrackingId trackingId, Location origin, Location finalDestination) {
     this.trackingId = trackingId;
     this.origin = origin;
@@ -58,6 +76,14 @@ public class Cargo {
     return trackingId;
   }
 
+  public Location origin() {
+    return origin;
+  }
+
+  public Location finalDestination() {
+    return finalDestination;
+  }
+
   @Override
   public String toString() {
     return ReflectionToStringBuilder.toString(this, ToStringStyle.MULTI_LINE_STYLE);

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

@@ -1,7 +1,20 @@
 package se.citerus.dddsample.domain;
 
+import javax.persistence.*;
+
+@Entity
+@Table(name = "carrier_movement")
 public class CarrierMovement {
+
+  @Id
+  private Long id;
+
+  @ManyToOne(fetch = FetchType.EAGER)
+  @JoinColumn(name = "from_location_fk")
   private final Location from;
+
+  @ManyToOne(fetch = FetchType.EAGER)
+  @JoinColumn(name = "to_location_fk")
   private final Location to;
 
   public CarrierMovement(Location from, Location to) {

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

@@ -1,17 +1,28 @@
 package se.citerus.dddsample.domain;
 
-import java.util.SortedSet;
-import java.util.TreeSet;
-
 import org.apache.commons.lang.builder.ReflectionToStringBuilder;
 import org.apache.commons.lang.builder.ToStringStyle;
+import org.hibernate.annotations.Sort;
+import org.hibernate.annotations.SortType;
+
+import javax.persistence.*;
+import java.util.SortedSet;
+import java.util.TreeSet;
 
 /**
  * A wrapper class that holds a sorted set of HandlingEvents. The set can not contain events with the same timestamp.
  * 
  */
+@Entity
+@Table(name = "delivery_history")
 public class DeliveryHistory {
 
+  @Id
+  private Long id;
+
+  @OneToMany(fetch = FetchType.EAGER)
+  @JoinColumn(name = "delivery_history_fk")
+  @Sort(type = SortType.NATURAL)
   private final SortedSet<HandlingEvent> events = new TreeSet<HandlingEvent>();
 
   public SortedSet<HandlingEvent> getEvents() {

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

@@ -3,6 +3,7 @@ package se.citerus.dddsample.domain;
 import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.builder.HashCodeBuilder;
 
+import javax.persistence.*;
 import java.util.Date;
 
 /**
@@ -13,16 +14,34 @@ import java.util.Date;
  * in correct order.
  * 
  */
+@Entity
+@Table(name = "handling_events")
 public class HandlingEvent implements Comparable<HandlingEvent> {
 
-  private final Type type;
-  private final CarrierMovement carrierMovement;
-  private final Date time;
+  @Id
+  private Long id;
+
+  @Enumerated(value = EnumType.STRING)
+  @Column(name = "type")
+  private Type type;
+
+  @ManyToOne(fetch = FetchType.EAGER)
+  @JoinColumn(name = "carrier_movement_fk")
+  private CarrierMovement carrierMovement;
+  
+  @Column(name = "time")
+  private Date time;
 
   public enum Type {
     LOAD, UNLOAD, RECEIVE, CLAIM
   }
 
+  // Exclude the id field from equals() and hashcode()
+  private static final String[] excludedFields = {"id"};
+
+  // Needed by Hibernate
+  HandlingEvent() {}
+
   public HandlingEvent(Date time, Type type, CarrierMovement carrierMovement) {
     this.time = time;
     this.type = type;
@@ -77,12 +96,12 @@ public class HandlingEvent implements Comparable<HandlingEvent> {
   
   @Override
   public boolean equals(Object obj) {
-    return EqualsBuilder.reflectionEquals(this, obj);
+    return EqualsBuilder.reflectionEquals(this, obj, excludedFields);
   }
 
   @Override
   public int hashCode() {
-    return HashCodeBuilder.reflectionHashCode(this);
+    return HashCodeBuilder.reflectionHashCode(this, excludedFields);
   }
 
   public int compareTo(HandlingEvent o) {

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

@@ -3,13 +3,30 @@ package se.citerus.dddsample.domain;
 import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.builder.HashCodeBuilder;
 
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.Id;
+import javax.persistence.Table;
+
+@Entity
+@Table(name = "locations")
 public class Location {
   /**
    * The NULL Location object
    */
-  public static final Location NULL = new Location("");
-  
-  private final String unlocode;
+  public static final Location NULL = new Location(Location.class.getName() + ".NULL");
+
+  @Id
+  private Long id;
+
+  @Column(name = "unlocode")
+  private String unlocode;
+
+  // Exclude the id field from equals() and hashcode()
+  private static final String[] excludedFields = {"id"};
+
+  // Needed by Hibernate
+  Location() {}
 
   public Location(String unlocode) {
     this.unlocode = unlocode;
@@ -21,12 +38,15 @@ public class Location {
 
   @Override
   public boolean equals(Object obj) {
-    return EqualsBuilder.reflectionEquals(this, obj);
+    if (this == NULL || obj == NULL) {
+      return this == obj;
+    }
+    return EqualsBuilder.reflectionEquals(this, obj, excludedFields);
   }
 
   @Override
   public int hashCode() {
-    return HashCodeBuilder.reflectionHashCode(this);
+    return HashCodeBuilder.reflectionHashCode(this, excludedFields);
   }
 
   @Override

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

@@ -1,19 +1,26 @@
 package se.citerus.dddsample.domain;
 
-import java.io.Serializable;
-
 import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.builder.HashCodeBuilder;
 
+import javax.persistence.Column;
+import javax.persistence.Embeddable;
+import java.io.Serializable;
+
 /**
  * TrackingId is a simple ID wrapper which implements Serializable for easier
- * integration with persistens frameworks.
+ * integration with persistence frameworks.
  * 
  */
+@Embeddable
 public class TrackingId implements Serializable {
 
   private static final long serialVersionUID = 6273117599327914522L;
-  private final String id;
+
+  @Column(name = "tracking_id")
+  private String id;
+
+  TrackingId() {}
 
   public TrackingId(String id) {
     this.id = id;

dddsample/src/main/java/se/citerus/dddsample/repository/CargoRepositoryHibernate.java

@@ -1,9 +1,11 @@
 package se.citerus.dddsample.repository;
 
 import org.hibernate.SessionFactory;
+import org.springframework.stereotype.Repository;
 import se.citerus.dddsample.domain.Cargo;
 import se.citerus.dddsample.domain.TrackingId;
 
+@Repository
 public class CargoRepositoryHibernate implements CargoRepository {
 
   private SessionFactory sessionFactory;

dddsample/src/main/resources/context-persistence.xml

@@ -15,8 +15,17 @@
     <property name="password" value="${jdbc.password}"/>
   </bean>
 
-  <bean id="sessionFactory" class="org.springframework.orm.hibernate3.LocalSessionFactoryBean">
+  <bean id="sessionFactory" class="org.springframework.orm.hibernate3.annotation.AnnotationSessionFactoryBean">
     <property name="dataSource" ref="dataSource"/>
+    <property name="annotatedClasses">
+      <list>
+        <value>se.citerus.dddsample.domain.Cargo</value>
+        <value>se.citerus.dddsample.domain.Location</value>
+        <value>se.citerus.dddsample.domain.DeliveryHistory</value>
+        <value>se.citerus.dddsample.domain.HandlingEvent</value>
+        <value>se.citerus.dddsample.domain.CarrierMovement</value>
+      </list>
+    </property>
     <property name="hibernateProperties">
       <props>
         <!-- These are properties that are common for test and production -->
@@ -30,7 +39,8 @@
     <property name="sessionFactory" ref="sessionFactory"/>
   </bean>
 
-  <bean id="cargoRepository" class="se.citerus.dddsample.repository.CargoRepositoryInMem">
+  <bean id="cargoRepository" class="se.citerus.dddsample.repository.CargoRepositoryHibernate">
+    <property name="sessionFactory" ref="sessionFactory"/>
   </bean>
 
 </beans>

dddsample/src/test/java/se/citerus/dddsample/domain/CargoRepositoryTest.java

@@ -12,14 +12,29 @@ public class CargoRepositoryTest extends AbstractTransactionalDataSourceSpringCo
   }
 
   protected String[] getConfigLocations() {
-    return new String[] {"context-persistence.xml"};
+    return new String[]{"context-persistence.xml"};
+  }
+
+  protected void onSetUpInTransaction() throws Exception {
+    String[] testData = {
+            "INSERT INTO locations (id, unlocode) VALUES (1, 'SESTO')",
+            "INSERT INTO locations (id, unlocode) VALUES (2, 'CNHKG')",
+
+            "INSERT INTO cargo (tracking_id, origin_location_fk, final_destination_location_fk) " +
+                    "VALUES ('XYZ', 1, 2)"
+    };
+    jdbcTemplate.batchUpdate(testData);
   }
 
   public void testFindByCargoId() {
     final TrackingId trackingId = new TrackingId("XYZ");
+    final Location origin = new Location("SESTO");
+    final Location finalDestination = new Location("CNHKG");
     Cargo cargo = cargoRepository.find(trackingId);
 
     assertEquals(trackingId, cargo.trackingId());
+    assertEquals(origin, cargo.origin());
+    assertEquals(finalDestination, cargo.finalDestination());
   }
 
 }

dddsample/src/test/java/se/citerus/dddsample/domain/LocationTest.java

@@ -0,0 +1,31 @@
+package se.citerus.dddsample.domain;
+
+import junit.framework.TestCase;
+
+public class LocationTest extends TestCase {
+
+  public void testEquals() {
+    // Same location string - equal
+    assertTrue(new Location("TEST").equals(new Location("TEST")));
+
+    // Different location strings - not equal
+    assertFalse(new Location("TEST").equals(new Location("ANOTHER_TEST")));
+
+    // Always equal to itself
+    Location location = new Location("TEST");
+    assertTrue(location.equals(location));
+
+    // Never equal to null
+    assertFalse(location.equals(null));
+
+    // Special NULL location is equal to itself
+    assertTrue(Location.NULL.equals(Location.NULL));
+
+    // No other location should be equal to the NULL location
+    assertFalse(new Location(null).equals(Location.NULL));
+    assertFalse(new Location("").equals(Location.NULL));
+    assertFalse(new Location("   ").equals(Location.NULL));
+    assertFalse(new Location("   FOO  BAR ").equals(Location.NULL));
+  }
+
+}