Eric - Removed origin from Cargo. Now RouteSpecification is the only place with origin. Changed hibernate mappings to remove Cargo origin. Removed test that looked for case when Cargo origin was different from RouteSpecification origin. This rule isn't quite right. The rule should be that the origin cannot change after there is an event.

dddsample/src/main/java/se/citerus/dddsample/application/impl/BookingServiceImpl.java

@@ -80,9 +80,7 @@ public final class BookingServiceImpl implements BookingService {
     final Cargo cargo = cargoRepository.find(trackingId);
     final Location newDestination = locationRepository.find(unLocode);
 
-    final RouteSpecification routeSpecification = new RouteSpecification(
-      cargo.origin(), newDestination, cargo.routeSpecification().arrivalDeadline()
-    );
+    final RouteSpecification routeSpecification = cargo.routeSpecification().withDestination(newDestination);
     cargo.specifyNewRoute(routeSpecification);
 
     cargoRepository.store(cargo);

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

@@ -132,16 +132,16 @@ public class SampleDataGenerator implements ServletContextListener {
 
   private static void loadCargoData(JdbcTemplate jdbcTemplate) {
     String cargoSql =
-      "insert into Cargo (id, tracking_id, origin_id, spec_origin_id, spec_destination_id, spec_arrival_deadline, transport_status, current_voyage_id, last_known_location_id, is_misdirected, routing_status, calculated_at, unloaded_at_dest) " +
-      "values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)";
+      "insert into Cargo (id, tracking_id, spec_origin_id, spec_destination_id, spec_arrival_deadline, transport_status, current_voyage_id, last_known_location_id, is_misdirected, routing_status, calculated_at, unloaded_at_dest) " +
+      "values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)";
 
     Object[][] cargoArgs = {
-      {1, "XYZ", 1, 1, 2, ts(10), "IN_PORT", null, 1, false, "ROUTED", ts(100), false},
-      {2, "ABC", 1, 1, 5, ts(20), "IN_PORT", null, 1, false, "ROUTED", ts(100), false},
-      {3, "ZYX", 2, 2, 1, ts(30), "IN_PORT", null, 1, false, "NOT_ROUTED", ts(100), false},
-      {4, "CBA", 5, 5, 1, ts(40), "IN_PORT", null, 1, false, "MISROUTED", ts(100), false},
-      {5, "FGH", 1, 3, 5, ts(50), "IN_PORT", null, 1, false, "ROUTED", ts(100), false},  // Cargo origin differs from spec origin
-      {6, "JKL", 6, 6, 4, ts(60), "IN_PORT", null, 1, true, "ROUTED", ts(100), false}
+      {1, "XYZ", 1, 2, ts(10), "IN_PORT", null, 1, false, "ROUTED", ts(100), false},
+      {2, "ABC", 1, 5, ts(20), "IN_PORT", null, 1, false, "ROUTED", ts(100), false},
+      {3, "ZYX", 2, 1, ts(30), "IN_PORT", null, 1, false, "NOT_ROUTED", ts(100), false},
+      {4, "CBA", 5, 1, ts(40), "IN_PORT", null, 1, false, "MISROUTED", ts(100), false},
+      {5, "FGH", 3, 5, ts(50), "IN_PORT", null, 1, false, "ROUTED", ts(100), false},  // Cargo origin differs from spec origin
+      {6, "JKL", 6, 4, ts(60), "IN_PORT", null, 1, true, "ROUTED", ts(100), false}
     };
     executeUpdate(jdbcTemplate, cargoSql, cargoArgs);
   }

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

@@ -46,7 +46,6 @@ import se.citerus.dddsample.domain.shared.Entity;
 public class Cargo implements Entity<Cargo> {
 
   private TrackingId trackingId;
-  private Location origin;
   private RouteSpecification routeSpecification;
   private Itinerary itinerary;
   private Delivery delivery;
@@ -56,9 +55,6 @@ public class Cargo implements Entity<Cargo> {
     Validate.notNull(routeSpecification, "Route specification is required");
 
     this.trackingId = trackingId;
-    // Cargo origin never changes, even if the route specification changes.
-    // However, at creation, cargo orgin can be derived from the initial route specification.
-    this.origin = routeSpecification.origin();
     this.routeSpecification = routeSpecification;
 
     this.delivery = Delivery.derivedFrom(
@@ -76,13 +72,6 @@ public class Cargo implements Entity<Cargo> {
   }
 
   /**
-   * @return Origin location.
-   */
-  public Location origin() {
-    return origin;
-  }
-
-  /**
    * @return The delivery. Never null.
    */
   public Delivery delivery() {

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

@@ -96,5 +96,11 @@ public class RouteSpecification extends AbstractSpecification<Itinerary> impleme
   RouteSpecification() {
     // Needed by Hibernate
   }
+
+public RouteSpecification withDestination(Location newDestination) {
+
+	return new RouteSpecification(origin, newDestination, arrivalDeadline);
+	
+}
   
 }

dddsample/src/main/java/se/citerus/dddsample/interfaces/booking/facade/internal/assembler/CargoRoutingDTOAssembler.java

@@ -18,7 +18,7 @@ public class CargoRoutingDTOAssembler {
   public CargoRoutingDTO toDTO(final Cargo cargo) {
     final CargoRoutingDTO dto = new CargoRoutingDTO(
       cargo.trackingId().idString(),
-      cargo.origin().unLocode().idString(),
+      cargo.routeSpecification().origin().unLocode().idString(),
       cargo.routeSpecification().destination().unLocode().idString(),
       cargo.routeSpecification().arrivalDeadline(),
       cargo.delivery().routingStatus().sameValueAs(RoutingStatus.MISROUTED));

dddsample/src/main/java/se/citerus/dddsample/interfaces/tracking/CargoTrackingViewAdapter.java

@@ -90,10 +90,10 @@ public final class CargoTrackingViewAdapter {
   }
 
   /**
-   * @return Cargo osigin location.
+   * @return Cargo origin location.
    */
   public String getOrigin() {
-    return getDisplayText(cargo.origin());
+    return getDisplayText(cargo.routeSpecification().origin());
   }
 
   /**

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

@@ -11,8 +11,6 @@
       <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>

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

@@ -15,11 +15,9 @@ import java.util.*;
 
 public class CargoTest extends TestCase {
 
-  private List<HandlingEvent> events;
   private Voyage voyage;
 
   protected void setUp() throws Exception {
-    events = new ArrayList<HandlingEvent>();
 
     voyage = new Voyage.Builder(new VoyageNumber("0123"), STOCKHOLM).
       addMovement(HAMBURG, new Date(), new Date()).
@@ -28,14 +26,14 @@ public class CargoTest extends TestCase {
       build();
   }
 
-  public void testConstruction() throws Exception {
-    final TrackingId trackingId = new TrackingId("XYZ");
-    final Date arrivalDeadline = toDate("2009-03-13");
-    final RouteSpecification routeSpecification = new RouteSpecification(
+  public void testConstruction() {
+    TrackingId trackingId = new TrackingId("XYZ");
+    Date arrivalDeadline = toDate("2009-03-13");
+    RouteSpecification routeSpecification = new RouteSpecification(
       STOCKHOLM, MELBOURNE, arrivalDeadline
     );
 
-    final Cargo cargo = new Cargo(trackingId, routeSpecification);
+    Cargo cargo = new Cargo(trackingId, routeSpecification);
 
     assertEquals(NOT_ROUTED, cargo.delivery().routingStatus());
     assertEquals(NOT_RECEIVED, cargo.delivery().transportStatus());
@@ -47,7 +45,7 @@ public class CargoTest extends TestCase {
     final Cargo cargo = new Cargo(new TrackingId("XYZ"), new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
     final Itinerary good = new Itinerary();
     final Itinerary bad = new Itinerary();
-    final RouteSpecification acceptOnlyGood = new RouteSpecification(cargo.origin(), cargo.routeSpecification().destination(), new Date()) {
+    final RouteSpecification acceptOnlyGood = new RouteSpecification(cargo.routeSpecification().origin(), cargo.routeSpecification().destination(), new Date()) {
       @Override
       public boolean isSatisfiedBy(Itinerary itinerary) {
         return itinerary == good;
@@ -114,6 +112,8 @@ public class CargoTest extends TestCase {
     assertFalse(cargo.delivery().isUnloadedAtDestination());
 
     // Adding an event unrelated to unloading at final destination
+    
+    List<HandlingEvent> events = new ArrayList<HandlingEvent>();
     events.add(
       new HandlingEvent(cargo, new Date(10), new Date(), HandlingEvent.Type.RECEIVE, HANGZOU));
     cargo.deriveDeliveryProgress(HandlingHistory.fromEvents(events));
@@ -167,6 +167,7 @@ public class CargoTest extends TestCase {
     final Cargo cargo = new Cargo(new TrackingId("XYZ"), new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
 
     HandlingEvent he = new HandlingEvent(cargo, toDate("2007-12-01"), new Date(), HandlingEvent.Type.RECEIVE, STOCKHOLM);
+    List<HandlingEvent> events = new ArrayList<HandlingEvent>();
     events.add(he);
     cargo.deriveDeliveryProgress(HandlingHistory.fromEvents(events));
 
@@ -175,7 +176,7 @@ public class CargoTest extends TestCase {
 
   private Cargo populateCargoClaimedMelbourne() throws Exception {
     final Cargo cargo = populateCargoOffMelbourne();
-
+    List<HandlingEvent> events = new ArrayList<HandlingEvent>();
     events.add(new HandlingEvent(cargo, toDate("2007-12-09"), new Date(), HandlingEvent.Type.CLAIM, MELBOURNE));
     cargo.deriveDeliveryProgress(HandlingHistory.fromEvents(events));
 
@@ -185,7 +186,7 @@ public class CargoTest extends TestCase {
   private Cargo populateCargoOffHongKong() throws Exception {
     final Cargo cargo = new Cargo(new TrackingId("XYZ"), new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
 
-
+    List<HandlingEvent> events = new ArrayList<HandlingEvent>();
     events.add(new HandlingEvent(cargo, toDate("2007-12-01"), new Date(), HandlingEvent.Type.LOAD, STOCKHOLM, voyage));
     events.add(new HandlingEvent(cargo, toDate("2007-12-02"), new Date(), HandlingEvent.Type.UNLOAD, HAMBURG, voyage));
 
@@ -199,6 +200,7 @@ public class CargoTest extends TestCase {
   private Cargo populateCargoOnHamburg() throws Exception {
     final Cargo cargo = new Cargo(new TrackingId("XYZ"), new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
 
+    List<HandlingEvent> events = new ArrayList<HandlingEvent>();
     events.add(new HandlingEvent(cargo, toDate("2007-12-01"), new Date(), HandlingEvent.Type.LOAD, STOCKHOLM, voyage));
     events.add(new HandlingEvent(cargo, toDate("2007-12-02"), new Date(), HandlingEvent.Type.UNLOAD, HAMBURG, voyage));
     events.add(new HandlingEvent(cargo, toDate("2007-12-03"), new Date(), HandlingEvent.Type.LOAD, HAMBURG, voyage));
@@ -210,6 +212,7 @@ public class CargoTest extends TestCase {
   private Cargo populateCargoOffMelbourne() throws Exception {
     final Cargo cargo = new Cargo(new TrackingId("XYZ"), new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
 
+    List<HandlingEvent> events = new ArrayList<HandlingEvent>();
     events.add(new HandlingEvent(cargo, toDate("2007-12-01"), new Date(), HandlingEvent.Type.LOAD, STOCKHOLM, voyage));
     events.add(new HandlingEvent(cargo, toDate("2007-12-02"), new Date(), HandlingEvent.Type.UNLOAD, HAMBURG, voyage));
 
@@ -226,6 +229,7 @@ public class CargoTest extends TestCase {
   private Cargo populateCargoOnHongKong() throws Exception {
     final Cargo cargo = new Cargo(new TrackingId("XYZ"), new RouteSpecification(STOCKHOLM, MELBOURNE, new Date()));
 
+    List<HandlingEvent> events = new ArrayList<HandlingEvent>();
     events.add(new HandlingEvent(cargo, toDate("2007-12-01"), new Date(), HandlingEvent.Type.LOAD, STOCKHOLM, voyage));
     events.add(new HandlingEvent(cargo, toDate("2007-12-02"), new Date(), HandlingEvent.Type.UNLOAD, HAMBURG, voyage));
 
@@ -248,56 +252,47 @@ public class CargoTest extends TestCase {
     //A cargo with no handling events is not misdirected
     assertFalse(cargo.delivery().isMisdirected());
 
-    Collection<HandlingEvent> handlingEvents = new ArrayList<HandlingEvent>();
-
     //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));
-    handlingEvents.add(new HandlingEvent(cargo, new Date(50), new Date(60), HandlingEvent.Type.UNLOAD, ROTTERDAM, voyage));
-    handlingEvents.add(new HandlingEvent(cargo, new Date(70), new Date(80), HandlingEvent.Type.LOAD, ROTTERDAM, voyage));
-    handlingEvents.add(new HandlingEvent(cargo, new Date(90), new Date(100), HandlingEvent.Type.UNLOAD, GOTHENBURG, voyage));
-    handlingEvents.add(new HandlingEvent(cargo, new Date(110), new Date(120), HandlingEvent.Type.CLAIM, GOTHENBURG));
-    handlingEvents.add(new HandlingEvent(cargo, new Date(130), new Date(140), HandlingEvent.Type.CUSTOMS, GOTHENBURG));
-
-    events.addAll(handlingEvents);
+    List<HandlingEvent> events = new ArrayList<HandlingEvent>();
+    events.add(new HandlingEvent(cargo, new Date(10), new Date(20), HandlingEvent.Type.RECEIVE, SHANGHAI));
+    events.add(new HandlingEvent(cargo, new Date(30), new Date(40), HandlingEvent.Type.LOAD, SHANGHAI, voyage));
+    events.add(new HandlingEvent(cargo, new Date(50), new Date(60), HandlingEvent.Type.UNLOAD, ROTTERDAM, voyage));
+    events.add(new HandlingEvent(cargo, new Date(70), new Date(80), HandlingEvent.Type.LOAD, ROTTERDAM, voyage));
+    events.add(new HandlingEvent(cargo, new Date(90), new Date(100), HandlingEvent.Type.UNLOAD, GOTHENBURG, voyage));
+    events.add(new HandlingEvent(cargo, new Date(110), new Date(120), HandlingEvent.Type.CLAIM, GOTHENBURG));
+    events.add(new HandlingEvent(cargo, new Date(130), new Date(140), HandlingEvent.Type.CUSTOMS, GOTHENBURG));
+
     cargo.deriveDeliveryProgress(HandlingHistory.fromEvents(events));
     assertFalse(cargo.delivery().isMisdirected());
 
     //Try a couple of failing ones
 
     cargo = setUpCargoWithItinerary(SHANGHAI, ROTTERDAM, GOTHENBURG);
-    handlingEvents = new ArrayList<HandlingEvent>();
-
-    handlingEvents.add(new HandlingEvent(cargo, new Date(), new Date(), HandlingEvent.Type.RECEIVE, HANGZOU));
-    events.addAll(handlingEvents);
+    events.add(new HandlingEvent(cargo, new Date(), new Date(), HandlingEvent.Type.RECEIVE, HANGZOU));
     cargo.deriveDeliveryProgress(HandlingHistory.fromEvents(events));
 
     assertTrue(cargo.delivery().isMisdirected());
 
 
     cargo = setUpCargoWithItinerary(SHANGHAI, ROTTERDAM, GOTHENBURG);
-    handlingEvents = new ArrayList<HandlingEvent>();
 
-    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));
-    handlingEvents.add(new HandlingEvent(cargo, new Date(50), new Date(60), HandlingEvent.Type.UNLOAD, ROTTERDAM, voyage));
-    handlingEvents.add(new HandlingEvent(cargo, new Date(70), new Date(80), HandlingEvent.Type.LOAD, ROTTERDAM, voyage));
+    events.add(new HandlingEvent(cargo, new Date(10), new Date(20), HandlingEvent.Type.RECEIVE, SHANGHAI));
+    events.add(new HandlingEvent(cargo, new Date(30), new Date(40), HandlingEvent.Type.LOAD, SHANGHAI, voyage));
+    events.add(new HandlingEvent(cargo, new Date(50), new Date(60), HandlingEvent.Type.UNLOAD, ROTTERDAM, voyage));
+    events.add(new HandlingEvent(cargo, new Date(70), new Date(80), HandlingEvent.Type.LOAD, ROTTERDAM, voyage));
 
-    events.addAll(handlingEvents);
     cargo.deriveDeliveryProgress(HandlingHistory.fromEvents(events));
 
     assertTrue(cargo.delivery().isMisdirected());
 
 
     cargo = setUpCargoWithItinerary(SHANGHAI, ROTTERDAM, GOTHENBURG);
-    handlingEvents = new ArrayList<HandlingEvent>();
 
-    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));
-    handlingEvents.add(new HandlingEvent(cargo, new Date(50), new Date(60), HandlingEvent.Type.UNLOAD, ROTTERDAM, voyage));
-    handlingEvents.add(new HandlingEvent(cargo, new Date(), new Date(), HandlingEvent.Type.CLAIM, ROTTERDAM));
+    events.add(new HandlingEvent(cargo, new Date(10), new Date(20), HandlingEvent.Type.RECEIVE, SHANGHAI));
+    events.add(new HandlingEvent(cargo, new Date(30), new Date(40), HandlingEvent.Type.LOAD, SHANGHAI, voyage));
+    events.add(new HandlingEvent(cargo, new Date(50), new Date(60), HandlingEvent.Type.UNLOAD, ROTTERDAM, voyage));
+    events.add(new HandlingEvent(cargo, new Date(), new Date(), HandlingEvent.Type.CLAIM, ROTTERDAM));
 
-    events.addAll(handlingEvents);
     cargo.deriveDeliveryProgress(HandlingHistory.fromEvents(events));
 
     assertTrue(cargo.delivery().isMisdirected());

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

@@ -64,5 +64,38 @@ public class RouteSpecificationTest extends TestCase {
 
     assertFalse(routeSpecification.isSatisfiedBy(itinerary));
   }
+  
+  public void testEquals() {
+	   RouteSpecification HKG_DAL = new RouteSpecification(
+			      HONGKONG, DALLAS, toDate("2009-03-01")
+			    );
+	   RouteSpecification HKG_DAL_AGAIN = new RouteSpecification(
+			      HONGKONG, DALLAS, toDate("2009-03-01")
+			    );
+	   RouteSpecification SHA_DAL = new RouteSpecification(
+			      SHANGHAI, DALLAS, toDate("2009-03-01")
+			    );
+	   RouteSpecification HKG_CHI = new RouteSpecification(
+			      HONGKONG, CHICAGO, toDate("2009-03-01")
+			    );
+	   RouteSpecification HKG_DAL_LATERARRIVAL = new RouteSpecification(
+			      HONGKONG, DALLAS, toDate("2009-03-15")
+			    );
+	   
+	   assertEquals(HKG_DAL, HKG_DAL_AGAIN);
+	   assertFalse(HKG_DAL.equals(SHA_DAL));
+	   assertFalse(HKG_DAL.equals(HKG_CHI));
+	   assertFalse(HKG_DAL.equals(HKG_DAL_LATERARRIVAL));
+}
+  
+  public void testDeriveWithNewDestination() {
+	   RouteSpecification original = new RouteSpecification(
+			      HONGKONG, DALLAS, toDate("2009-03-01")
+			    );
+	   RouteSpecification desired = new RouteSpecification(
+			      HONGKONG, CHICAGO, toDate("2009-03-01")
+			    );
+	assertEquals(desired, original.withDestination(CHICAGO));
+  }
 
 }

dddsample/src/test/java/se/citerus/dddsample/infrastructure/persistence/hibernate/CargoRepositoryTest.java

@@ -40,7 +40,9 @@ public class CargoRepositoryTest extends AbstractRepositoryTest {
   public void testFindByCargoId() {
     final TrackingId trackingId = new TrackingId("FGH");
     final Cargo cargo = cargoRepository.find(trackingId);
-    assertEquals(STOCKHOLM, cargo.origin());
+//	TODO: Remove the database column where the cargo origin used to be stored. Only the spec has origin now.
+//			And then remove the following line from the test.    
+//  assertEquals(STOCKHOLM, cargo.origin());
     assertEquals(HONGKONG, cargo.routeSpecification().origin());
     assertEquals(HELSINKI, cargo.routeSpecification().destination());
 

dddsample/src/test/java/se/citerus/dddsample/infrastructure/routing/ExternalRoutingServiceTest.java

@@ -62,7 +62,7 @@ public class ExternalRoutingServiceTest extends TestCase {
       assertFalse(legs.isEmpty());
 
       // Cargo origin and start of first leg should match
-      assertEquals(cargo.origin(), legs.get(0).loadLocation());
+      assertEquals(cargo.routeSpecification().origin(), legs.get(0).loadLocation());
 
       // Cargo final destination and last leg stop should match
       Location lastLegStop = legs.get(legs.size() - 1).unloadLocation();