Cargo now requires a route specification on creation.

dddsample/src/main/java/se/citerus/dddsample/application/util/SampleDataGenerator.java

@@ -120,16 +120,16 @@ public class SampleDataGenerator implements ServletContextListener {
 
   private static void loadCargoData(JdbcTemplate jdbcTemplate) {
     String cargoSql =
-      "insert into Cargo (id, tracking_id, origin_id, destination_id, arrival_deadline) " +
-      "values (?, ?, ?, ?, ?)";
+      "insert into Cargo (id, tracking_id, origin_id, spec_origin_id, spec_destination_id, spec_arrival_deadline) " +
+      "values (?, ?, ?, ?, ?, ?)";
 
     Object[][] cargoArgs = {
-      {1, "XYZ", 1, 2, ts(10)},
-      {2, "ABC", 1, 5, ts(20)},
-      {3, "ZYX", 2, 1, ts(30)},
-      {4, "CBA", 5, 1, ts(40)},
-      {5, "FGH", 3, 5, ts(50)},
-      {6, "JKL", 6, 4, ts(60)}
+      {1, "XYZ", 1, 1, 2, ts(10)},
+      {2, "ABC", 1, 1, 5, ts(20)},
+      {3, "ZYX", 2, 2, 1, ts(30)},
+      {4, "CBA", 5, 5, 1, ts(40)},
+      {5, "FGH", 1, 3, 5, ts(50)},  // Cargo origin differs from spec origin
+      {6, "JKL", 6, 6, 4, ts(60)}
     };
     executeUpdate(jdbcTemplate, cargoSql, cargoArgs);
   }

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

@@ -7,8 +7,6 @@ import se.citerus.dddsample.domain.model.handling.HandlingEvent;
 import se.citerus.dddsample.domain.model.location.Location;
 import se.citerus.dddsample.domain.shared.DomainObjectUtils;
 
-import java.util.Date;
-
 /**
  * A Cargo. This is the central class in the domain model,
  * and it is the root of the Cargo-Itinerary-Leg-DeliveryHistory aggregate.
@@ -40,27 +38,22 @@ import java.util.Date;
 public class Cargo implements Entity<Cargo> {
 
   private TrackingId trackingId;
+  private Location origin;
   private Itinerary itinerary;
   private Delivery delivery;
   private RouteSpecification routeSpecification;
 
+  // TODO origin can be taken from route spec on creation, even if the origin never changes
+  public Cargo(final TrackingId trackingId, final Location origin, final RouteSpecification routeSpecification) {
+    Validate.notNull(trackingId, "Tracking id is required");
+    Validate.notNull(origin, "Origin location is required");
+    Validate.notNull(routeSpecification, "Route specification is required");
 
-  /**
-   * @param trackingId tracking id
-   * @param routeSpecification route specification
-   */
-  public Cargo(TrackingId trackingId, RouteSpecification routeSpecification) {
-    Validate.notNull(trackingId);
-    Validate.notNull(routeSpecification);
     this.trackingId = trackingId;
+    this.origin = origin;
     this.routeSpecification = routeSpecification;
   }
 
-  // TODO remove this, only present during migration to other ctor
-  public Cargo(TrackingId trackingId, Location origin, Location destination) {
-    this(trackingId, new RouteSpecification(origin, destination, new Date()));
-  }
-
 
   /**
    * The tracking id is the identity of this entity, and is unique.
@@ -75,14 +68,7 @@ public class Cargo implements Entity<Cargo> {
    * @return Origin location.
    */
   public Location origin() {
-    return routeSpecification.origin();
-  }
-
-  /**
-   * @return Destination of the cargo.
-   */
-  public Location destination() {
-    return routeSpecification.destination();
+    return origin;
   }
 
   /**
@@ -100,10 +86,17 @@ public class Cargo implements Entity<Cargo> {
   }
 
   /**
+   * @return The route specification.
+   */
+  public RouteSpecification routeSpecification() {
+    return routeSpecification;
+  }
+  
+  /**
    * @return True if the cargo has arrived at its destination.
    */
   public boolean hasArrived() {
-    return destination().equals(delivery.lastKnownLocation());
+    return routeSpecification.destination().equals(delivery.lastKnownLocation());
   }
 
   /**
@@ -180,13 +173,14 @@ public class Cargo implements Entity<Cargo> {
   public boolean isUnloadedAtDestination() {
     for (HandlingEvent event : delivery().history()) {
       if (HandlingEvent.Type.UNLOAD.equals(event.type())
-        && destination().equals(event.location())) {
+        && routeSpecification.destination().equals(event.location())) {
         return true;
       }
     }
     return false;
   }
 
+  @Override
   public boolean sameIdentityAs(final Cargo other) {
     return other != null && trackingId.sameValueAs(other.trackingId);
   }
@@ -213,6 +207,11 @@ public class Cargo implements Entity<Cargo> {
     return trackingId.hashCode();
   }
 
+  @Override
+  public String toString() {
+    return trackingId.toString();
+  }
+
   Cargo() {
     // Needed by Hibernate
   }

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

@@ -53,6 +53,11 @@ public final class TrackingId implements ValueObject<TrackingId> {
     return new TrackingId(id);
   }
 
+  @Override
+  public String toString() {
+    return id;
+  }
+
   TrackingId() {
     // Needed by Hibernate
   }

dddsample/src/main/resources/se/citerus/dddsample/infrastructure/persistence/hibernate/Cargo.hbm.xml

@@ -11,6 +11,8 @@
       <generator class="org.hibernate.id.IdentityGenerator"/>
     </id>
 
+    <many-to-one name="origin" column="origin_id" not-null="false" cascade="none" update="false" foreign-key="origin_fk"/>
+
     <component name="trackingId" unique="true" update="false">
       <property name="id" column="tracking_id"/>
     </component>
@@ -23,9 +25,9 @@
     </component>
 
     <component name="routeSpecification">
-      <many-to-one name="origin" column="origin_id" cascade="none" update="false" foreign-key="origin_fk"/>
-      <many-to-one name="destination" column="destination_id" cascade="none" foreign-key="destination_fk"/>
-      <property name="arrivalDeadline" column="arrival_deadline" not-null="true"/>
+      <many-to-one name="origin" column="spec_origin_id" cascade="none" update="false" foreign-key="spec_origin_fk"/>
+      <many-to-one name="destination" column="spec_destination_id" cascade="none" foreign-key="spec_destination_fk"/>
+      <property name="arrivalDeadline" column="spec_arrival_deadline" not-null="true"/>
     </component>
 
     <component name="itinerary">

dddsample/src/test/java/se/citerus/dddsample/domain/model/cargo/CargoTest.java

@@ -29,10 +29,10 @@ public class CargoTest extends TestCase {
   }
 
   public void testRoutingStatus() throws Exception {
-    final Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, MELBOURNE);
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
     final Itinerary good = new Itinerary();
     final Itinerary bad = new Itinerary();
-    final RouteSpecification acceptOnlyGood = new RouteSpecification(cargo.origin(), cargo.destination(), new Date()) {
+    final RouteSpecification acceptOnlyGood = new RouteSpecification(cargo.origin(), cargo.routeSpecification().destination(), new Date()) {
       @Override
       public boolean isSatisfiedBy(Itinerary itinerary) {
         return itinerary == good;
@@ -51,7 +51,7 @@ public class CargoTest extends TestCase {
   }
 
   public void testlastKnownLocationUnknownWhenNoEvents() throws Exception {
-    Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, MELBOURNE);
+    Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
 
     assertEquals(Location.UNKNOWN, cargo.delivery().lastKnownLocation());
   }
@@ -93,10 +93,12 @@ public class CargoTest extends TestCase {
   }
 
   public void testEquality() throws Exception {
-    Cargo c1 = new Cargo(new TrackingId("ABC"), STOCKHOLM, HONGKONG);
-    Cargo c2 = new Cargo(new TrackingId("CBA"), STOCKHOLM, HONGKONG);
-    Cargo c3 = new Cargo(new TrackingId("ABC"), STOCKHOLM, MELBOURNE);
-    Cargo c4 = new Cargo(new TrackingId("ABC"), STOCKHOLM, HONGKONG);
+    RouteSpecification spec1 = new RouteSpecification(STOCKHOLM, HONGKONG, new Date());
+    RouteSpecification spec2 = new RouteSpecification(STOCKHOLM, MELBOURNE, new Date());
+    Cargo c1 = new Cargo(new TrackingId("ABC"), STOCKHOLM, spec1);
+    Cargo c2 = new Cargo(new TrackingId("CBA"), STOCKHOLM, spec1);
+    Cargo c3 = new Cargo(new TrackingId("ABC"), STOCKHOLM, spec2);
+    Cargo c4 = new Cargo(new TrackingId("ABC"), STOCKHOLM, spec1);
 
     assertTrue("Cargos should be equal when TrackingIDs are equal", c1.equals(c4));
     assertTrue("Cargos should be equal when TrackingIDs are equal", c1.equals(c3));
@@ -163,7 +165,7 @@ public class CargoTest extends TestCase {
 
   // TODO: Generate test data some better way
   private Cargo populateCargoReceivedStockholm() throws Exception {
-    final Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, MELBOURNE);
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
 
     HandlingEvent he = new HandlingEvent(cargo, getDate("2007-12-01"), new Date(), HandlingEvent.Type.RECEIVE, STOCKHOLM);
     events.add(he);
@@ -182,7 +184,7 @@ public class CargoTest extends TestCase {
   }
 
   private Cargo populateCargoOffHongKong() throws Exception {
-    final Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, MELBOURNE);
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
 
 
     events.add(new HandlingEvent(cargo, getDate("2007-12-01"), new Date(), HandlingEvent.Type.LOAD, STOCKHOLM, voyage));
@@ -196,7 +198,7 @@ public class CargoTest extends TestCase {
   }
 
   private Cargo populateCargoOnHamburg() throws Exception {
-    final Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, MELBOURNE);
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
 
     events.add(new HandlingEvent(cargo, getDate("2007-12-01"), new Date(), HandlingEvent.Type.LOAD, STOCKHOLM, voyage));
     events.add(new HandlingEvent(cargo, getDate("2007-12-02"), new Date(), HandlingEvent.Type.UNLOAD, HAMBURG, voyage));
@@ -207,7 +209,7 @@ public class CargoTest extends TestCase {
   }
 
   private Cargo populateCargoOffMelbourne() throws Exception {
-    final Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, MELBOURNE);
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
 
     events.add(new HandlingEvent(cargo, getDate("2007-12-01"), new Date(), HandlingEvent.Type.LOAD, STOCKHOLM, voyage));
     events.add(new HandlingEvent(cargo, getDate("2007-12-02"), new Date(), HandlingEvent.Type.UNLOAD, HAMBURG, voyage));
@@ -223,7 +225,7 @@ public class CargoTest extends TestCase {
   }
 
   private Cargo populateCargoOnHongKong() throws Exception {
-    final Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, MELBOURNE);
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
 
     events.add(new HandlingEvent(cargo, getDate("2007-12-01"), new Date(), HandlingEvent.Type.LOAD, STOCKHOLM, voyage));
     events.add(new HandlingEvent(cargo, getDate("2007-12-02"), new Date(), HandlingEvent.Type.UNLOAD, HAMBURG, voyage));
@@ -239,7 +241,7 @@ public class CargoTest extends TestCase {
 
   public void testIsMisdirected() throws Exception {
     //A cargo with no itinerary is not misdirected
-    Cargo cargo = new Cargo(new TrackingId("TRKID"), SHANGHAI, GOTHENBURG);
+    Cargo cargo = new Cargo(new TrackingId("TRKID"), SHANGHAI, new RouteSpecification(SHANGHAI, GOTHENBURG, new Date()));
     assertFalse(cargo.isMisdirected());
 
     cargo = setUpCargoWithItinerary(SHANGHAI, ROTTERDAM, GOTHENBURG);
@@ -249,12 +251,6 @@ public class CargoTest extends TestCase {
 
     Collection<HandlingEvent> handlingEvents = new ArrayList<HandlingEvent>();
 
-    /*
-    CarrierMovement abc = new CarrierMovement(new CarrierMovementId("ABC"), SHANGHAI, ROTTERDAM, new Date(), new Date());
-    CarrierMovement def = new CarrierMovement(new CarrierMovementId("DEF"), ROTTERDAM, GOTHENBURG, new Date(), new Date());
-    CarrierMovement ghi = new CarrierMovement(new CarrierMovementId("GHI"), ROTTERDAM, NEWYORK, new Date(), new Date());
-    */
-    
     //Happy path
     handlingEvents.add(new HandlingEvent(cargo, new Date(10), new Date(20), HandlingEvent.Type.RECEIVE, SHANGHAI));
     handlingEvents.add(new HandlingEvent(cargo, new Date(30), new Date(40), HandlingEvent.Type.LOAD, SHANGHAI, voyage));
@@ -309,7 +305,7 @@ public class CargoTest extends TestCase {
   }
 
   private Cargo setUpCargoWithItinerary(Location origin, Location midpoint, Location destination) {
-    Cargo cargo = new Cargo(new TrackingId("CARGO1"), origin, destination);
+    Cargo cargo = new Cargo(new TrackingId("CARGO1"), origin, new RouteSpecification(origin, destination, new Date()));
 
     Itinerary itinerary = new Itinerary(
       Arrays.asList(

dddsample/src/test/java/se/citerus/dddsample/domain/model/cargo/CargoTestHelper.java

@@ -4,6 +4,7 @@ import se.citerus.dddsample.domain.model.handling.HandlingEvent;
 import se.citerus.dddsample.domain.model.location.Location;
 
 import java.util.Collection;
+import java.util.Date;
 
 /**
  * For easy testdata creation.
@@ -11,11 +12,13 @@ import java.util.Collection;
  */
 public class CargoTestHelper {
 
-  public static Cargo createCargoWithDeliveryHistory(
-    TrackingId trackingId, Location origin, Location destination,
-    Collection<HandlingEvent> events) {
+  public static Cargo createCargoWithDeliveryHistory(TrackingId trackingId,
+                                                     Location origin,
+                                                     Location destination,
+                                                     Collection<HandlingEvent> events) {
 
-    final Cargo cargo = new Cargo(trackingId, origin, destination);
+    final RouteSpecification routeSpecification = new RouteSpecification(origin, destination, new Date());
+    final Cargo cargo = new Cargo(trackingId, origin, routeSpecification);
     setDeliveryHistory(cargo, events);
 
     return cargo;

dddsample/src/test/java/se/citerus/dddsample/domain/model/cargo/DeliveryTest.java

@@ -12,7 +12,7 @@ import java.util.*;
 
 public class DeliveryTest extends TestCase {
 
-  private Cargo cargo = new Cargo(new TrackingId("XYZ"), HONGKONG, NEWYORK);
+  private Cargo cargo = new Cargo(new TrackingId("XYZ"), HONGKONG, new RouteSpecification(HONGKONG, NEWYORK, new Date()));
 
   public void testEvensOrderedByTimeOccured() throws Exception {
     DateFormat df = new SimpleDateFormat("yyyy-MM-dd");

dddsample/src/test/java/se/citerus/dddsample/domain/model/cargo/ItineraryTest.java

@@ -36,7 +36,7 @@ public class ItineraryTest extends TestCase {
 
     TrackingId trackingId = new TrackingId("CARGO1");
     RouteSpecification routeSpecification = new RouteSpecification(SHANGHAI, GOTHENBURG, new Date());
-    Cargo cargo = new Cargo(trackingId, routeSpecification);
+    Cargo cargo = new Cargo(trackingId, SHANGHAI, routeSpecification);
 
     Itinerary itinerary = new Itinerary(
       Arrays.asList(