Failing scenario test for a routing service, with a few added skeleton interfaces, domain classes and methods.

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

@@ -29,6 +29,9 @@ public class Cargo {
   @Embedded
   private DeliveryHistory deliveryHistory;
 
+  @OneToOne
+  private Itinerary itinerary;
+
   public Cargo(TrackingId trackingId, Location origin, Location finalDestination) {
     this.trackingId = trackingId;
     this.origin = origin;
@@ -83,6 +86,23 @@ public class Cargo {
     return finalDestination.equals(lastKnownLocation());
   }
 
+  /**
+   * Assigns an itinerary to this cargo.
+   * @param itinerary an itinerary
+   */
+  public void assignItinerary(Itinerary itinerary) {
+    this.itinerary = itinerary;
+  }
+
+  /**
+   * @return True if the cargo has been misdirected,
+   * that is if the cargo is in a location that's not in the itinerary.
+   */
+  public boolean isMisdirected() {
+    // TODO: implement
+    return false;
+  }
+
   @Override
   public String toString() {
     return ReflectionToStringBuilder.toString(this, ToStringStyle.MULTI_LINE_STYLE);

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

@@ -12,8 +12,8 @@ import java.util.Date;
  * HandlingEvent's are sent from different Incident Logging Applications some time after the event occured and contain information about the
  * {@link TrackingId}, {@link Location}, timestamp of the completion of the event, and possibly, if applicable a {@link CarrierMovement}.
  * <br><br>
- * HandlingEvent's could contain information about a {@link CarrierMovement} and if so, the event type must be either {@link Type.LOAD} or
- * {@link Type.UNLOAD}. All other events must be of {@link Type.RECEIVE}, {@link Type.CLAIM} or {@link Type.CUSTOMS}.
+ * HandlingEvent's could contain information about a {@link CarrierMovement} and if so, the event type must be either {@link Type#LOAD} or
+ * {@link Type#UNLOAD}. All other events must be of {@link Type#RECEIVE}, {@link Type#CLAIM} or {@link Type#CUSTOMS}.
  */
 @Entity
 public class HandlingEvent {

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

@@ -0,0 +1,17 @@
+package se.citerus.dddsample.domain;
+
+import javax.persistence.Entity;
+import javax.persistence.GeneratedValue;
+import javax.persistence.Id;
+
+/**
+ *
+ */
+@Entity
+public class Itinerary {
+
+  @Id
+  @GeneratedValue
+  private Long id;
+
+}

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

@@ -82,6 +82,9 @@ public class Location {
     return unLocode.hashCode();
   }
 
+  /**
+   * @return Unlocode and name, on the format "SESTO (Stockholm)"
+   */
   @Override
   public String toString() {
     return unLocode.idString() + " (" + name + ")";

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

@@ -0,0 +1,7 @@
+package se.citerus.dddsample.domain;
+
+/**
+ * 
+ */
+public interface Specification {
+}

dddsample/src/main/java/se/citerus/dddsample/service/RoutingService.java

@@ -0,0 +1,16 @@
+package se.citerus.dddsample.service;
+
+import se.citerus.dddsample.domain.Cargo;
+import se.citerus.dddsample.domain.Itinerary;
+import se.citerus.dddsample.domain.Specification;
+
+import java.util.Set;
+
+/**
+ *  
+ */
+public interface RoutingService {
+
+  Set<Itinerary> calculatePossibleRoutes(Cargo cargo, Specification specification);
+
+}

dddsample/src/main/resources/hibernate.cfg.xml

@@ -7,11 +7,17 @@
 <hibernate-configuration>
 
   <session-factory>
+    <!-- Properties defined here are shared between test and production -->
     <property name="cache.provider_class">org.hibernate.cache.EhCacheProvider</property>
     <mapping class="se.citerus.dddsample.domain.Cargo"/>
     <mapping class="se.citerus.dddsample.domain.Location"/>
     <mapping class="se.citerus.dddsample.domain.HandlingEvent"/>
     <mapping class="se.citerus.dddsample.domain.CarrierMovement"/>
+    <mapping class="se.citerus.dddsample.domain.Itinerary"/>
+    <mapping class="se.citerus.dddsample.domain.TrackingId"/>
+    <mapping class="se.citerus.dddsample.domain.DeliveryHistory"/>
+    <mapping class="se.citerus.dddsample.domain.CarrierMovementId"/>
+    <mapping class="se.citerus.dddsample.domain.UnLocode"/>
   </session-factory>
 
 </hibernate-configuration>

dddsample/src/test/java/se/citerus/dddsample/service/RoutingServiceTest.java

@@ -0,0 +1,65 @@
+package se.citerus.dddsample.service;
+
+import junit.framework.TestCase;
+import se.citerus.dddsample.domain.*;
+import se.citerus.dddsample.repository.CargoRepository;
+
+import java.util.Date;
+import java.util.Set;
+
+public class RoutingServiceTest extends TestCase {
+
+  RoutingService routingService;
+  CargoRepository cargoRepository;
+  HandlingEventService handlingEventService;
+
+  public void testCalculateRoute() throws Exception {
+    TrackingId trackingId = new TrackingId("XYZ123");
+    Cargo cargo = cargoRepository.find(trackingId);
+
+    Specification specification = null;
+
+    /*
+      The routing service calculates a number of possible routes that
+      satisfy the given specification (must arrive in three days, must not
+      cost more than $10,000 etc).
+     */
+    Set<Itinerary> itineraryCandidates = routingService.calculatePossibleRoutes(cargo, specification);
+
+    /*
+      Someone, or something, selects the most appropriate itinerary and
+      assigns that itinerary to the cargo.
+     */
+    Itinerary itinerary = selectItinerary(itineraryCandidates);
+    cargo.assignItinerary(itinerary);
+
+    /*
+      A number of events occur, all of which are according to plan
+     */
+    handlingEventService.register(new Date(), trackingId, new CarrierMovementId("A001"), new UnLocode("SE","STO"), null);
+    handlingEventService.register(new Date(), trackingId, new CarrierMovementId("B002"), null, null);
+    handlingEventService.register(new Date(), trackingId, new CarrierMovementId("C003"), null, null);
+
+    /*
+      Cargo should not be misdirected at this point.
+     */
+    assertFalse(cargo.isMisdirected());
+
+    /*
+      An unexpected event occur.
+     */
+    handlingEventService.register(null, null, null, null, null);
+
+    /*
+      Now the cargo is misdirected.
+     */
+    assertTrue(cargo.isMisdirected());
+  }
+
+
+  // Stub for the itinerary selection process
+  private Itinerary selectItinerary(Set<Itinerary> itineraryCandidates) {
+    return itineraryCandidates.iterator().next();
+  }
+
+}

dddsample/src/test/resources/mock-context-persistence.xml

@@ -20,8 +20,6 @@
     <constructor-arg value="se.citerus.dddsample.repository.CarrierMovementRepository"/>
   </bean>
 
-
-
   <bean id="locationRepository" class="se.citerus.dddsample.repository.LocationRepositoryHibernate">
     <property name="sessionFactory" ref="sessionFactory"/>
   </bean>