Persisted Itinerary and Leg, with sample data and mapping.

Introduced Itinerary.EMPTY_ITINERARY to represent an emtpy itinerary (null object pattern)

Added capability to display expected/misdirected status of cargo and events to web tracking interface (jsp, DTOs, etc)

Location constructor now only has package-level visibility, and test code uses static location instances.

Rewrote UN Locode import to use straight JDBC access.

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

@@ -29,10 +29,11 @@ public class Cargo {
   @Transient
   private DeliveryHistory deliveryHistory = new DeliveryHistory();
 
-  @Transient
+  @ManyToOne
   private Itinerary itinerary;
 
   //TODO Remove this constructor
+  //TODO Shouldn't origin and destination be implicitly derived from itinerary?
   public Cargo(TrackingId trackingId, Location origin, Location destination) {
     Validate.noNullElements(new Object[] {trackingId, origin, destination});
     this.trackingId = trackingId;
@@ -61,10 +62,12 @@ public class Cargo {
   }
 
   public void setOrigin(Location origin) {
+    Validate.notNull(origin);
     this.origin = origin;
   }
 
   public void setDestination(Location destination) {
+    Validate.notNull(destination);
     this.destination = destination;
   }
 
@@ -83,6 +86,17 @@ public class Cargo {
   }
 
   /**
+   * @return The itinerary.
+   */
+  public Itinerary itinerary() {
+    if (this.itinerary == null) {
+      return Itinerary.EMPTY_ITINERARY;
+    } else {
+      return this.itinerary;
+    }
+  }
+
+  /**
    * @return Last known location of the cargo, or Location.UNKNOWN if the delivery history is empty.
    */
   public Location lastKnownLocation() {
@@ -106,7 +120,8 @@ public class Cargo {
    *
    * @param itinerary an itinerary
    */
-  public void assignItinerary(Itinerary itinerary) {
+  public void setItinerary(Itinerary itinerary) {
+    Validate.notNull(itinerary);
     this.itinerary = itinerary;
   }
 
@@ -129,10 +144,6 @@ public class Cargo {
     return !itinerary.isExpected(lastEvent);
   }
 
-  public Itinerary itinerary() {
-    return this.itinerary;
-  }
-
   /**
    * 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.
@@ -144,7 +155,7 @@ public class Cargo {
    *         attributes.
    */
   private boolean sameIdentityAs(Cargo other) {
-    return trackingId.equals(other.trackingId);
+    return other != null && trackingId.equals(other.trackingId);
   }
 
   /**
@@ -169,11 +180,6 @@ public class Cargo {
     return trackingId.hashCode();
   }
 
-  @Override
-  public String toString() {
-    return ReflectionToStringBuilder.toString(this, ToStringStyle.MULTI_LINE_STYLE);
-  }
-
   Cargo() {
     // Needed by Hibernate
   }

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

@@ -2,25 +2,30 @@ package se.citerus.dddsample.domain;
 
 import org.apache.commons.lang.Validate;
 
-import javax.persistence.GeneratedValue;
-import javax.persistence.Id;
+import javax.persistence.*;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Collections;
 
 /**
  *
  */
-
+@Entity
 public class Itinerary {
 
   @Id
   @GeneratedValue
   private Long id;
 
-  private List<Leg> legs;
+  @OneToMany
+  @JoinColumn(name = "itinerary_id")
+  private List<Leg> legs = Collections.emptyList();
+
+  public static final Itinerary EMPTY_ITINERARY = new Itinerary();
 
   public Itinerary(List<Leg> legs) {
     Validate.notEmpty(legs);
+    Validate.noNullElements(legs);
     this.legs = legs;
   }
 
@@ -28,6 +33,10 @@ public class Itinerary {
     this(Arrays.asList(legs));
   }
 
+  public List<Leg> legs() {
+    return legs;
+  }
+
   /**
    * Test if the given handling event is expected when executing this itinerary.
    *
@@ -35,7 +44,6 @@ public class Itinerary {
    * @return <code>true</code> if the event is expected
    */
   public boolean isExpected(HandlingEvent event) {
-
     if (legs.isEmpty()) {
       return true;
     }
@@ -48,8 +56,6 @@ public class Itinerary {
 
     if (event.type() == HandlingEvent.Type.LOAD) {
       //Check that the there is one leg with same from location and carrier movement
-      boolean found = false;
-
       for (Leg leg : legs) {
         if (leg.from().equals(event.location())
            && leg.carrierMovementId().equals(event.carrierMovement().carrierId()))
@@ -66,7 +72,6 @@ public class Itinerary {
           return true;
       }
       return false;
-
     }
 
     if (event.type() == HandlingEvent.Type.CLAIM) {
@@ -84,7 +89,7 @@ public class Itinerary {
    * @return <code>true</code> if the legs in this and the other itinerary are all equal.
    */
   public boolean sameValueAs(Itinerary other) {
-    return legs.equals(other.legs);
+    return other != null && legs.equals(other.legs);
   }
 
   @Override
@@ -101,4 +106,8 @@ public class Itinerary {
   public int hashCode() {
     return legs.hashCode();
   }
+
+  Itinerary() {
+    // Needed by Hibernate
+  }
 }

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

@@ -6,12 +6,23 @@ import org.apache.commons.lang.builder.ToStringStyle;
 import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.Validate;
 
+import javax.persistence.*;
+
 /**
  * An itinerary consists of one or more legs.
  */
+@Entity
 public class Leg {
+  @Id
+  @GeneratedValue
+  private Long id;
+
+  // TODO: why is this not related to CarrierMovement?
+  @Embedded
   private CarrierMovementId carrierMovementId;
+  @ManyToOne
   private Location from;
+  @ManyToOne
   private Location to;
 
   public Leg(CarrierMovementId carrierMovementId, Location from, Location to) {
@@ -63,7 +74,11 @@ public class Leg {
 
   @Override
   public int hashCode() {
-    return HashCodeBuilder.reflectionHashCode(this);
+    return new HashCodeBuilder(13,17).
+      append(carrierMovementId).
+      append(from).
+      append(to).
+      toHashCode();
   }
 
   @Override

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

@@ -27,15 +27,14 @@ public class Location {
   );
 
   /**
+   * Package-level constructor, visible for test only.
+   * 
    * @param unLocode UN Locode
    * @param name     location name
    * @throws IllegalArgumentException if the UN Locode or name is null
    */
-  public Location(UnLocode unLocode, String name) {
+  Location(UnLocode unLocode, String name) {
     Validate.noNullElements(new Object[] {unLocode, name});
-    // TODO:
-    // It shouldn't really be possible to create a new location -
-    // it should only be looked up in the location repository.
     Validate.notNull(unLocode);
     Validate.notNull(name);
     this.unLocode = unLocode;

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

@@ -17,6 +17,9 @@ public class CargoRepositoryHibernate extends HibernateRepository implements Car
             createQuery("from Cargo where trackingId = :tid").
             setParameter("tid", tid).
             uniqueResult();
+    if (cargo == null) {
+      return null;
+    }
     /*  There's no OR-mapped relation between the cargo delivery history and its handling events
         because the handling events are in a different aggregate.
 

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

@@ -28,12 +28,13 @@ public class CargoServiceImpl implements CargoService {
     Location currentLocation = deliveryHistory.currentLocation();
     CarrierMovement currentCarrierMovement = deliveryHistory.currentCarrierMovement();
     final CargoWithHistoryDTO dto = new CargoWithHistoryDTO(
-            cargo.trackingId().idString(),
-            cargo.origin().toString(),
-            cargo.finalDestination().toString(),
-            deliveryHistory.status(),
-            currentLocation == null ? null : currentLocation.unLocode().idString(),
-            currentCarrierMovement == null ? null : currentCarrierMovement.carrierId().idString()
+      cargo.trackingId().idString(),
+      cargo.origin().toString(),
+      cargo.finalDestination().toString(),
+      deliveryHistory.status(),
+      currentLocation == null ? null : currentLocation.unLocode().idString(),
+      currentCarrierMovement == null ? null : currentCarrierMovement.carrierId().idString(),
+      cargo.isMisdirected()
     );
 
     final List<HandlingEvent> events = deliveryHistory.eventsOrderedByCompletionTime();
@@ -41,10 +42,11 @@ public class CargoServiceImpl implements CargoService {
       CarrierMovement cm = event.carrierMovement();
       String carrierIdString = (cm == null) ? "" : cm.carrierId().idString();
       dto.addEvent(new HandlingEventDTO(
-              event.location().toString(),
-              event.type().toString(),
-              carrierIdString,
-              event.completionTime()
+        event.location().toString(),
+        event.type().toString(),
+        carrierIdString,
+        event.completionTime(),
+        cargo.itinerary().isExpected(event)
       ));
     }
     return dto;

dddsample/src/main/java/se/citerus/dddsample/service/dto/CargoWithHistoryDTO.java

@@ -20,15 +20,18 @@ public class CargoWithHistoryDTO implements Serializable {
   List<HandlingEventDTO> events;
   String carrierMovementId;
   StatusCode statusCode;
+  boolean misdirected;
 
   public CargoWithHistoryDTO(String trackingId, String origin, String finalDestination,
-                             StatusCode statusCode, String currentLocationId, String carrierMovementId) {
+                             StatusCode statusCode, String currentLocationId, String carrierMovementId,
+                             boolean isMisdirected) {
     this.trackingId = trackingId;
     this.origin = origin;
     this.finalDestination = finalDestination;
     this.statusCode = statusCode;
     this.currentLocationId = currentLocationId;
     this.carrierMovementId = carrierMovementId;
+    this.misdirected = isMisdirected;
 
     this.events = new ArrayList<HandlingEventDTO>();
   }
@@ -65,4 +68,8 @@ public class CargoWithHistoryDTO implements Serializable {
     return carrierMovementId;
   }
 
+  public boolean isMisdirected() {
+    return misdirected;
+  }
+
 }

dddsample/src/main/java/se/citerus/dddsample/service/dto/HandlingEventDTO.java

@@ -12,12 +12,14 @@ public class HandlingEventDTO implements Serializable {
   private final String location;
   private final String carrier;
   private final Date time;
+  private boolean expected;
 
-  public HandlingEventDTO(String location, String type, String carrier, Date time) {
+  public HandlingEventDTO(String location, String type, String carrier, Date time, boolean expected) {
     this.location = location;
     this.type = type;
     this.carrier = carrier;
     this.time = time;
+    this.expected = expected;
   }
 
   public String getLocation() {
@@ -35,4 +37,8 @@ public class HandlingEventDTO implements Serializable {
   public String getCarrier() {
     return carrier;
   }
+
+  public boolean isExpected() {
+    return expected;
+  }
 }

dddsample/src/main/java/se/citerus/dddsample/util/LocationsImporter.java

@@ -4,10 +4,6 @@ import org.apache.commons.io.IOUtils;
 import org.apache.commons.io.LineIterator;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
-import org.hibernate.CacheMode;
-import org.hibernate.FlushMode;
-import org.hibernate.SessionFactory;
-import org.hibernate.classic.Session;
 import org.springframework.beans.factory.BeanFactoryUtils;
 import org.springframework.core.io.ClassPathResource;
 import org.springframework.transaction.PlatformTransactionManager;
@@ -16,15 +12,18 @@ import org.springframework.transaction.support.TransactionCallback;
 import org.springframework.transaction.support.TransactionTemplate;
 import org.springframework.web.context.WebApplicationContext;
 import org.springframework.web.context.support.WebApplicationContextUtils;
-import se.citerus.dddsample.domain.Location;
-import se.citerus.dddsample.domain.UnLocode;
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.jdbc.core.BatchPreparedStatementSetter;
 
 import javax.servlet.ServletContextEvent;
 import javax.servlet.ServletContextListener;
+import javax.sql.DataSource;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
+import java.sql.PreparedStatement;
+import java.sql.SQLException;
 
 /**
  * Imports about 55 000 locations from an official UN Locode CSV export.
@@ -36,55 +35,67 @@ public class LocationsImporter implements ServletContextListener {
   private static final int BATCH_SIZE = 1000;
   private static final Log logger = LogFactory.getLog(LocationsImporter.class);
 
-  protected int importLocations(Session session) throws IOException {
+  protected int importLocations(JdbcTemplate jt) throws IOException {
     ZipFile zipFile = new ZipFile(new ClassPathResource(ZIP_FILE_NAME).getFile());
     ZipEntry zipEntry = zipFile.getEntry(ZIP_ENTRY_NAME);
     InputStream inputStream = zipFile.getInputStream(zipEntry);
     LineIterator iterator = IOUtils.lineIterator(inputStream, "ISO-8859-1");
-    session.setCacheMode(CacheMode.IGNORE);
-    session.setFlushMode(FlushMode.MANUAL);
 
-    int insertCount = 1;
+    int count = 0;
+    String sql = "INSERT INTO Location (unlocode,name) VALUES (?,?)";
+
+    final String[][] batchArgs = new String[BATCH_SIZE][2];
     while (iterator.hasNext()) {
       String line = iterator.nextLine();
-      Location location = parseLocation(line);
-      if (location != Location.UNKNOWN) {
-          session.save(location);
-          if (insertCount % BATCH_SIZE == 0) {
-            session.flush();
-            session.clear();
-          }
-          insertCount++;
+      String[] args = parseLocation(line);
+      if (args != null) {
+        int pos = count % BATCH_SIZE;
+        batchArgs[pos][0] = args[0];
+        batchArgs[pos][1] = args[1];
+        count++;
+        if (count % BATCH_SIZE == 0) {
+          jt.batchUpdate(sql, new BatchPreparedStatementSetter() {
+            public void setValues(PreparedStatement ps, int i) throws SQLException {
+              ps.setString(1, batchArgs[i][0]);
+              ps.setString(2, batchArgs[i][1]);
+            }
+            public int getBatchSize() {
+              return BATCH_SIZE;
+            }
+          });
+        }
+        //jt.update(sql, new Object[] {pos, args[0], args[1]});
       }
     }
-    session.flush();
+    // TODO: batch insert the tail of the line list
 
-    return insertCount;
+    return count;
   }
 
-  private Location parseLocation(String line) {
+  private String[] parseLocation(String line) {
     String countryCode = line.substring(3, 5);
     String locationCode = line.substring(6, 9);
     if (locationCode.trim().length() == 3) {
       String name = line.substring(10, 46).trim();
-      UnLocode unlocode = new UnLocode(countryCode, locationCode);
-      return new Location(unlocode, name);
+      return new String[] {countryCode + locationCode, name};
     } else {
-      return Location.UNKNOWN;
+      return null;
     }
   }
 
   public void contextInitialized(ServletContextEvent event) {
-    final WebApplicationContext context = WebApplicationContextUtils.getRequiredWebApplicationContext(event.getServletContext());
-    final PlatformTransactionManager ptm = (PlatformTransactionManager) BeanFactoryUtils.beanOfType(context, PlatformTransactionManager.class);
-    final SessionFactory sf = (SessionFactory) BeanFactoryUtils.beanOfType(context, SessionFactory.class);
-    final TransactionTemplate tt = new TransactionTemplate(ptm);
+    WebApplicationContext context = WebApplicationContextUtils.getRequiredWebApplicationContext(event.getServletContext());
+    PlatformTransactionManager ptm = (PlatformTransactionManager) BeanFactoryUtils.beanOfType(context, PlatformTransactionManager.class);
+    TransactionTemplate tt = new TransactionTemplate(ptm);
+    DataSource dataSource = (DataSource) BeanFactoryUtils.beanOfType(context, DataSource.class);
+    final JdbcTemplate jt = new JdbcTemplate(dataSource);
+
 
     long t = System.currentTimeMillis();
     Integer count = (Integer) tt.execute(new TransactionCallback() {
       public Object doInTransaction(TransactionStatus status) {
         try {
-          return importLocations(sf.getCurrentSession());
+          return importLocations(jt);
         } catch (IOException e) {
           throw new RuntimeException(e);
         }

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

@@ -23,6 +23,7 @@ public class SampleDataGenerator implements ServletContextListener {
     String handlingEventSql =
       "insert into HandlingEvent (completionTime, registrationTime, type, location_id, carrierMovement_id, cargo_id) " +
       "values (?, ?, ?, ?, ?, ?)";
+
     Object[][] handlingEventArgs = {
         //XYZ (SESTO-FIHEL-DEHAM-CNHKG-JPTOK-AUMEL)
         {ts(0),     ts((1)),    "RECEIVE",  1,  null,  1},
@@ -53,12 +54,24 @@ public class SampleDataGenerator implements ServletContextListener {
         {ts((0)),   ts((1)),    "RECEIVE",  2,  null,  4},
         {ts((10)),  ts((11)),   "LOAD",     2,  7,     4},
         {ts((20)),  ts((21)),   "UNLOAD",   7,  7,     4},
+
+        //FGH
+        {ts(100),   ts(160),    "RECEIVE",  3,  null,   5},
+        {ts(150),   ts(110),    "LOAD",     3,  10,     5},
+
+        // JKL
+        {ts(200),   ts(220),    "RECEIVE",  6,  null,   6},
+        {ts(300),   ts(330),    "LOAD",     6,  12,     6},
+        {ts(400),   ts(440),    "UNLOAD",   5,  12,     6}  // Unexpected event
     };
     executeUpdate(jdbcTemplate, handlingEventSql, handlingEventArgs);
   }
 
   private static void loadCarrierMovementData(JdbcTemplate jdbcTemplate) {
-    String carrierMovementSql = "insert into CarrierMovement (id, carrier_movement_id, from_id, to_id) values (?,?,?,?)";
+    String carrierMovementSql =
+      "insert into CarrierMovement (id, carrier_movement_id, from_id, to_id) " +
+      "values (?,?,?,?)";
+
     Object[][] carrierMovementArgs = {
      // SESTO-FIHEL-DEHAM-CNHKG-JPTOK-AUMEL
       {1, "CAR_001",1,5},
@@ -73,24 +86,43 @@ public class SampleDataGenerator implements ServletContextListener {
       // AUMEL - USCHI - DEHAM - SESTO
       {7, "CAR_007",2,7},
       {8, "CAR_008",7,6},
-      {9, "CAR_009",6,1}
+      {9, "CAR_009",6,1},
+
+      // CNHKG - AUMEL
+      {10,"CAR_010",3,2},
+      // AUMEL - FIHEL
+      {11,"CAR_011",2,5},
+      // DEHAM - SESTO
+      {12,"CAR_020",6,1},
+      // SESTO - USCHI
+      {13,"CAR_021",1,7},
+      // USCHI - JPTKO
+      {14,"CAR_022",7,4}
     };
     executeUpdate(jdbcTemplate, carrierMovementSql, carrierMovementArgs);
   }
 
   private static void loadCargoData(JdbcTemplate jdbcTemplate) {
-    String cargoSql = "insert into Cargo (id, tracking_id, origin_id, destination_id) values (?, ?, ?, ?)";
+    String cargoSql =
+      "insert into Cargo (id, tracking_id, origin_id, destination_id, itinerary_id) " +
+      "values (?, ?, ?, ?, ?)";
+
     Object[][] cargoArgs = {
-      {1, "XYZ",1,2},
-      {2, "ABC",1,5},
-      {3, "ZYX",2,1},
-      {4, "CBA",5,1}
+      {1, "XYZ", 1, 2, null},
+      {2, "ABC", 1, 5, null},
+      {3, "ZYX", 2, 1, null},
+      {4, "CBA", 5, 1, null},
+      {5, "FGH", 3, 5, 1},
+      {6, "JKL", 6, 4, 2}
     };
     executeUpdate(jdbcTemplate, cargoSql, cargoArgs);
   }
 
   private static void loadLocationData(JdbcTemplate jdbcTemplate) {
-    String locationSql = "insert into Location (id, unlocode, name) values (?, ?, ?)";
+    String locationSql =
+      "insert into Location (id, unlocode, name) " +
+      "values (?, ?, ?)";
+
     Object[][] locationArgs = {
       {1, "SESTO", "Stockholm"},
       {2, "AUMEL", "Melbourne"},
@@ -103,6 +135,32 @@ public class SampleDataGenerator implements ServletContextListener {
     executeUpdate(jdbcTemplate, locationSql, locationArgs);
   }
 
+  private static void loadItineraryData(JdbcTemplate jdbcTemplate) {
+    String itinerarySql = "insert into Itinerary (id) values (?)";
+
+    Object[][] itineraryArgs = {
+      {1},
+      {2}
+    };
+    executeUpdate(jdbcTemplate, itinerarySql, itineraryArgs);
+
+    String legSql =
+      "insert into Leg (id, itinerary_id, carrier_movement_id, from_id, to_id) " +
+      "values (?,?,?,?,?)";
+
+    Object [][] legArgs = {
+      // Cargo 5: Hongkong - Melbourne - Stockholm - Helsinki
+      {1,1,"CAR_010",3,2},
+      {2,1,"CAR_011",2,1},
+      {3,1,"CAR_011",1,5},
+      // Cargo 6: Hamburg - Stockholm - Chicago - Tokyo
+      {4,2,"CAR_020",6,1},
+      {5,2,"CAR_021",1,7},
+      {6,2,"CAR_022",7,4}
+    };
+    executeUpdate(jdbcTemplate, legSql, legArgs);
+  }
+
   public void contextInitialized(ServletContextEvent event) {
     WebApplicationContext context = WebApplicationContextUtils.getRequiredWebApplicationContext(event.getServletContext());
     DataSource dataSource = (DataSource) BeanFactoryUtils.beanOfType(context, DataSource.class);
@@ -116,8 +174,9 @@ public class SampleDataGenerator implements ServletContextListener {
     transactionTemplate.execute(new TransactionCallbackWithoutResult() {
       protected void doInTransactionWithoutResult(TransactionStatus status) {
         loadLocationData(jdbcTemplate);
-        loadCargoData(jdbcTemplate);
         loadCarrierMovementData(jdbcTemplate);
+        loadItineraryData(jdbcTemplate);
+        loadCargoData(jdbcTemplate);
         loadHandlingEventData(jdbcTemplate);
       }
     });

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

@@ -10,11 +10,12 @@
     <!-- 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.TrackingId"/>
+    <mapping class="se.citerus.dddsample.domain.Leg"/>
+    <mapping class="se.citerus.dddsample.domain.Itinerary"/>
     <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.CarrierMovementId"/>
     <mapping class="se.citerus.dddsample.domain.UnLocode"/>
   </session-factory>

dddsample/src/main/webapp/WEB-INF/jsp/start.jsp

@@ -29,6 +29,9 @@
   <c:if test="${cargo ne null}">
     <div id="result">	
     <h2>Status: <spring:message code="cargo.status.${cargo.statusCode}"/>&nbsp;${cargo.currentLocationId}&nbsp;${cargo.carrierMovementId}</h2>
+    <c:if test="${cargo.misdirected}">
+      <p class="notify"><img src="${rc.contextPath}/images/error.png" alt="" />Cargo is misdirected</p>
+    </c:if>  
     <h3>Tracking History</h3>
     <table cellspacing="4">
       <thead>
@@ -36,6 +39,7 @@
           <td>Event</td>
           <td>Location</td>
           <td>Time</td>
+          <td></td>
         </tr>
       </thead>
       <tbody>
@@ -44,6 +48,7 @@
             <td>${event.type}</td>
             <td>${event.location}</td>
             <td>${event.time}</td>
+            <td><img src="${rc.contextPath}/images/${event.expected ? "tick" : "cross"}.png" alt=""/></td>
           </tr>
         </c:forEach>
       </tbody>

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

@@ -258,7 +258,7 @@ public class CargoTest extends TestCase {
        new Leg(new CarrierMovementId("DEF"), rotterdam, goteborg)
     );
 
-    cargo.assignItinerary(itinerary);
+    cargo.setItinerary(itinerary);
     return cargo;
   }
 

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

@@ -77,14 +77,6 @@ public class ItineraryTest extends TestCase {
   }
 
   public void testCreateItinerary() throws Exception {
-    //An empty legs list is not OK:
-    try {
-      new Itinerary();
-      fail("An empty itinerary is not OK");
-    } catch (IllegalArgumentException iae) {
-      //Expected
-    }
-
     try {
       new Itinerary(new ArrayList<Leg>());
       fail("An empty itinerary is not OK");

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

@@ -0,0 +1,17 @@
+package se.citerus.dddsample.domain;
+
+/**
+ * A few locations for easy testing.
+ *
+ */
+public class SampleLocations {
+
+  public static final Location HONGKONG = new Location(new UnLocode("CN", "HKG"), "Hongkong");
+  public static final Location MELBOURNE = new Location(new UnLocode("AU","MEL"), "Melbourne");
+  public static final Location STOCKHOLM = new Location(new UnLocode("SE","STO"), "Stockholm");
+  public static final Location HELSINKI = new Location(new UnLocode("Fi","HEL"), "Helsinki");
+  public static final Location USCHI = new Location(new UnLocode("US", "CHI"), "Chicago");
+  public static final Location JPTKO = new Location(new UnLocode("JN","TKO"), "Tokyo");
+  public static final Location DEHAM = new Location(new UnLocode("DE", "HAM"), "Hamburg");
+
+}

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

@@ -1,39 +1,77 @@
 package se.citerus.dddsample.repository;
 
-import se.citerus.dddsample.domain.Cargo;
-import se.citerus.dddsample.domain.Location;
-import se.citerus.dddsample.domain.TrackingId;
-import se.citerus.dddsample.domain.UnLocode;
+import se.citerus.dddsample.domain.*;
+import static se.citerus.dddsample.domain.HandlingEvent.Type.*;
+import static se.citerus.dddsample.domain.SampleLocations.*;
 
 import java.util.Map;
+import java.util.List;
+import java.util.Date;
 
 public class CargoRepositoryTest extends AbstractRepositoryTest {
 
   CargoRepository cargoRepository;
-  private final Location stockholm = new Location(new UnLocode("SE","STO"), "Stockholm");
-  private final Location melbourne = new Location(new UnLocode("AU","MEL"), "Melbourne");
 
   public void setCargoRepository(CargoRepository cargoRepository) {
     this.cargoRepository = cargoRepository;
   }
 
   public void testFindByCargoId() {
-    final TrackingId trackingId = new TrackingId("XYZ");
+    Cargo cargo = cargoRepository.find(new TrackingId("FGH"));
+    assertEquals(HONGKONG, cargo.origin());
+    assertEquals(HELSINKI, cargo.finalDestination());
 
-    Cargo cargo = cargoRepository.find(trackingId);
+    DeliveryHistory dh = cargo.deliveryHistory();
+    assertNotNull(dh);
 
-    assertEquals(trackingId, cargo.trackingId());
-    assertEquals(stockholm, cargo.origin());
-    assertEquals(melbourne, cargo.finalDestination());
-    // TODO: verify delivery history
+    List<HandlingEvent> events = dh.eventsOrderedByCompletionTime();
+    assertEquals(2, events.size());
+
+    HandlingEvent firstEvent = events.get(0);
+    assertHandlingEvent(cargo, firstEvent, RECEIVE, HONGKONG, 100, 160, null);
+
+    HandlingEvent secondEvent = events.get(1);
+    CarrierMovement expectedCm = new CarrierMovement(new CarrierMovementId("CAR_010"), HONGKONG, MELBOURNE);
+    assertHandlingEvent(cargo,  secondEvent, LOAD, HONGKONG, 150, 110, expectedCm);
+
+    List<Leg> legs = cargo.itinerary().legs();
+    assertEquals(3, legs.size());
+
+    Leg firstLeg = legs.get(0);
+    assertLeg(firstLeg, "CAR_010", HONGKONG, MELBOURNE);
+
+    Leg secondLeg = legs.get(1);
+    assertLeg(secondLeg, "CAR_011", MELBOURNE, STOCKHOLM);
+
+    Leg thirdLeg = legs.get(2);
+    assertLeg(thirdLeg, "CAR_011", STOCKHOLM, HELSINKI);
+  }
+
+  private void assertHandlingEvent(Cargo cargo, HandlingEvent event, HandlingEvent.Type expectedEventType, Location expectedLocation, int completionTimeMs, int registrationTimeMs, CarrierMovement expectedCarrierMovement) {
+    assertEquals(expectedEventType, event.type());
+    assertEquals(expectedLocation, event.location());
+    assertEquals(new Date(completionTimeMs), event.completionTime());
+    assertEquals(new Date(registrationTimeMs), event.registrationTime());
+    if (expectedCarrierMovement == null) {
+      assertNull(event.carrierMovement());
+    } else {
+      assertEquals(expectedCarrierMovement, event.carrierMovement());
+    }
+    assertEquals(cargo, event.cargo());
+  }
+
+  private void assertLeg(Leg firstLeg, String cmId, Location expectedFrom, Location expectedTo) {
+    assertEquals(new CarrierMovementId(cmId), firstLeg.carrierMovementId());
+    assertEquals(expectedFrom, firstLeg.from());
+    assertEquals(expectedTo, firstLeg.to());
   }
 
   public void testSave() {
-    sessionFactory.getCurrentSession().saveOrUpdate(stockholm);
-    sessionFactory.getCurrentSession().saveOrUpdate(melbourne);
+    sessionFactory.getCurrentSession().saveOrUpdate(STOCKHOLM);
+    sessionFactory.getCurrentSession().saveOrUpdate(MELBOURNE);
 
 
-    Cargo cargo = new Cargo(new TrackingId("AAA"), stockholm, melbourne);
+    Cargo cargo = new Cargo(new TrackingId("AAA"), STOCKHOLM, MELBOURNE);
     cargoRepository.save(cargo);
 
     flush();

dddsample/src/test/java/se/citerus/dddsample/repository/CarrierMovementRepositoryTest.java

@@ -1,15 +1,11 @@
 package se.citerus.dddsample.repository;
 
-import se.citerus.dddsample.domain.CarrierMovement;
-import se.citerus.dddsample.domain.CarrierMovementId;
-import se.citerus.dddsample.domain.Location;
-import se.citerus.dddsample.domain.UnLocode;
+import se.citerus.dddsample.domain.*;
+import static se.citerus.dddsample.domain.SampleLocations.*;
 
 public class CarrierMovementRepositoryTest extends AbstractRepositoryTest {
 
   CarrierMovementRepository carrierMovementRepository;
-  private final Location stockholm = new Location(new UnLocode("SE","STO"), "Stockholm");
-  private final Location helsinki = new Location(new UnLocode("FI","HEL"), "Helsinki");
 
   public void setCarrierMovementRepository(CarrierMovementRepository carrierMovementRepository) {
     this.carrierMovementRepository = carrierMovementRepository;
@@ -19,8 +15,8 @@ public class CarrierMovementRepositoryTest extends AbstractRepositoryTest {
     CarrierMovement carrierMovement = carrierMovementRepository.find(new CarrierMovementId("CAR_001"));
     assertNotNull(carrierMovement);
     assertEquals("CAR_001", carrierMovement.carrierId().idString());
-    assertEquals(stockholm, carrierMovement.from());
-    assertEquals(helsinki, carrierMovement.to());
+    assertEquals(STOCKHOLM, carrierMovement.from());
+    assertEquals(HELSINKI, carrierMovement.to());
   }
 
 }

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

@@ -10,6 +10,7 @@ import org.springframework.test.AbstractDependencyInjectionSpringContextTests;
 import org.springframework.transaction.TransactionStatus;
 import org.springframework.transaction.interceptor.TransactionAspectSupport;
 import se.citerus.dddsample.domain.*;
+import static se.citerus.dddsample.domain.SampleLocations.*;
 import se.citerus.dddsample.repository.CargoRepository;
 import se.citerus.dddsample.repository.HandlingEventRepository;
 import se.citerus.dddsample.service.dto.CargoWithHistoryDTO;
@@ -76,15 +77,12 @@ public class CargoServiceTest extends AbstractDependencyInjectionSpringContextTe
    * Cargo returned.
    */
   public void testCargoServiceFindByTrackingIdScenario() {
-    Location origin = new Location(new UnLocode("OR","IGI"), "Origin");
-    Location finalDestination = new Location(new UnLocode("DE","STI"), "Destination");
-    final Cargo cargo = new Cargo(new TrackingId("XYZ"), origin, finalDestination);
-    Location sesto = new Location(new UnLocode("SE","STO"), "Stockholm");
-    HandlingEvent claimed = new HandlingEvent(cargo, new Date(10), new Date(20), HandlingEvent.Type.CLAIM, sesto, null);
-    Location to = new Location(new UnLocode("MU","GER"), "München");
-    CarrierMovement carrierMovement = new CarrierMovement(new CarrierMovementId("CAR_001"), sesto, to);
-    HandlingEvent loaded = new HandlingEvent(cargo, new Date(12), new Date(25), HandlingEvent.Type.LOAD, sesto, carrierMovement);
-    HandlingEvent unloaded = new HandlingEvent(cargo, new Date(100), new Date(110), HandlingEvent.Type.UNLOAD, to, carrierMovement);
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), STOCKHOLM, USCHI);
+
+    HandlingEvent claimed = new HandlingEvent(cargo, new Date(10), new Date(20), HandlingEvent.Type.CLAIM, STOCKHOLM, null);
+    CarrierMovement carrierMovement = new CarrierMovement(new CarrierMovementId("CAR_001"), STOCKHOLM, USCHI);
+    HandlingEvent loaded = new HandlingEvent(cargo, new Date(12), new Date(25), HandlingEvent.Type.LOAD, STOCKHOLM, carrierMovement);
+    HandlingEvent unloaded = new HandlingEvent(cargo, new Date(100), new Date(110), HandlingEvent.Type.UNLOAD, USCHI, carrierMovement);
     // Add out of order to verify ordering in DTO
     cargo.deliveryHistory().addAllEvents(Arrays.asList(loaded, unloaded, claimed));
 
@@ -103,9 +101,9 @@ public class CargoServiceTest extends AbstractDependencyInjectionSpringContextTe
 
 
     assertEquals("XYZ", cargoDTO.getTrackingId());
-    assertEquals("ORIGI (Origin)", cargoDTO.getOrigin());
-    assertEquals("DESTI (Destination)", cargoDTO.getFinalDestination());
-    assertEquals("MUGER", cargoDTO.getCurrentLocationId());
+    assertEquals("SESTO (Stockholm)", cargoDTO.getOrigin());
+    assertEquals("USCHI (Chicago)", cargoDTO.getFinalDestination());
+    assertEquals("USCHI", cargoDTO.getCurrentLocationId());
 
     List<HandlingEventDTO> events = cargoDTO.getEvents();
     assertEquals(3, events.size());
@@ -126,7 +124,7 @@ public class CargoServiceTest extends AbstractDependencyInjectionSpringContextTe
 
     // Finally unload
     eventDTO = events.get(2);
-    assertEquals("MUGER (München)", eventDTO.getLocation());
+    assertEquals("USCHI (Chicago)", eventDTO.getLocation());
     assertEquals("UNLOAD", eventDTO.getType());
     assertEquals("CAR_001", eventDTO.getCarrier());
     assertEquals(new Date(100), eventDTO.getTime());

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

@@ -3,6 +3,7 @@ package se.citerus.dddsample.service;
 import junit.framework.TestCase;
 import static org.easymock.EasyMock.*;
 import se.citerus.dddsample.domain.*;
+import static se.citerus.dddsample.domain.SampleLocations.*;
 import se.citerus.dddsample.repository.CargoRepository;
 import se.citerus.dddsample.repository.CarrierMovementRepository;
 import se.citerus.dddsample.repository.HandlingEventRepository;
@@ -18,23 +19,13 @@ public class HandlingEventServiceTest extends TestCase {
   private HandlingEventRepository handlingEventRepository;
   private LocationRepository locationRepository;
 
-  private Location origin = new Location(new UnLocode("AF","ROM"), "AFROM");
-  private Location finalDestination = new Location(new UnLocode("AB","CTO"), "ABCTO");
-  private final Cargo cargoABC = new Cargo(new TrackingId("ABC"), origin, finalDestination);
+  private final Cargo cargoABC = new Cargo(new TrackingId("ABC"), DEHAM, JPTKO);
 
-  private Location xfrom = new Location(new UnLocode("XF","ROM"), "XFROM");
-  private Location xyzto = new Location(new UnLocode("XY","ZTO"), "XYZTO");
-  private final Cargo cargoXYZ = new Cargo(new TrackingId("XYZ"), xfrom, xyzto);
+  private final Cargo cargoXYZ = new Cargo(new TrackingId("XYZ"), HONGKONG, HELSINKI);
 
-  private Location a5 = new Location(new UnLocode("AA","AAA"), "AAAAA");
-  private Location b5 = new Location(new UnLocode("BB","BBB"), "BBBBB");
   private final CarrierMovement cmAAA_BBB = new CarrierMovement(
-          new CarrierMovementId("CAR_001"), a5, b5);
+          new CarrierMovementId("CAR_001"), USCHI, STOCKHOLM);
   
-  private final Location stockholm = new Location(new UnLocode("SE","STO"), "Stockholm");
-  private final Location melbourne = new Location(new UnLocode("AU","MEL"), "Melbourne");
-  private final Location hongkong = new Location(new UnLocode("CN","HKG"), "Hongkong");
-
   protected void setUp() throws Exception{
     service = new HandlingEventServiceImpl();
     cargoRepository = createMock(CargoRepository.class);
@@ -64,7 +55,7 @@ public class HandlingEventServiceTest extends TestCase {
     expect(carrierMovementRepository.find(carrierMovementId)).andReturn(cmAAA_BBB);
 
     final UnLocode unLocode = new UnLocode("SE", "STO");
-    expect(locationRepository.find(unLocode)).andReturn(stockholm);
+    expect(locationRepository.find(unLocode)).andReturn(STOCKHOLM);
 
     // TODO: does not inspect the handling event instance in a sufficient way
     handlingEventRepository.save(isA(HandlingEvent.class));
@@ -84,11 +75,11 @@ public class HandlingEventServiceTest extends TestCase {
     handlingEventRepository.save(isA(HandlingEvent.class));
     eventService.fireHandlingEventRegistered(isA(HandlingEvent.class));
 
-    expect(locationRepository.find(stockholm.unLocode())).andReturn(stockholm);
+    expect(locationRepository.find(STOCKHOLM.unLocode())).andReturn(STOCKHOLM);
 
     replay(cargoRepository, carrierMovementRepository, handlingEventRepository, locationRepository, eventService);
 
-    service.register(date, trackingId, null, stockholm.unLocode(), HandlingEvent.Type.CLAIM);
+    service.register(date, trackingId, null, STOCKHOLM.unLocode(), HandlingEvent.Type.CLAIM);
   }
   
 
@@ -99,14 +90,14 @@ public class HandlingEventServiceTest extends TestCase {
     expect(carrierMovementRepository.find(carrierMovementId)).andReturn(null);
 
     final TrackingId trackingId = new TrackingId("XYZ");
-    expect(cargoRepository.find(trackingId)).andReturn(new Cargo(trackingId, a5, b5));
+    expect(cargoRepository.find(trackingId)).andReturn(new Cargo(trackingId, USCHI, STOCKHOLM));
 
-    expect(locationRepository.find(melbourne.unLocode())).andReturn(melbourne);
+    expect(locationRepository.find(MELBOURNE.unLocode())).andReturn(MELBOURNE);
     
     replay(cargoRepository, carrierMovementRepository, handlingEventRepository, locationRepository, eventService);
     
     try {
-      service.register(date, trackingId, carrierMovementId, melbourne.unLocode(), HandlingEvent.Type.UNLOAD);
+      service.register(date, trackingId, carrierMovementId, MELBOURNE.unLocode(), HandlingEvent.Type.UNLOAD);
       fail("Should not be able to register an event with non-existing carrier movement");
     } catch (UnknownCarrierMovementIdException expected) {}
   }
@@ -117,12 +108,12 @@ public class HandlingEventServiceTest extends TestCase {
     final TrackingId trackingId = new TrackingId("XYZ");
     expect(cargoRepository.find(trackingId)).andReturn(null);
 
-    expect(locationRepository.find(hongkong.unLocode())).andReturn(hongkong);
+    expect(locationRepository.find(HONGKONG.unLocode())).andReturn(HONGKONG);
     
     replay(cargoRepository, carrierMovementRepository, handlingEventRepository, locationRepository, eventService);
     
     try {
-      service.register(date, trackingId, null, hongkong.unLocode(), HandlingEvent.Type.CLAIM);
+      service.register(date, trackingId, null, HONGKONG.unLocode(), HandlingEvent.Type.CLAIM);
       fail("Should not be able to register an event with non-existing cargo");
     } catch (UnknownTrackingIdException expected) {}
   }

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

@@ -31,7 +31,7 @@ public class RoutingServiceTest extends TestCase {
       assigns that itinerary to the cargo.
      */
     Itinerary itinerary = stubbedItinerarySelection(itineraryCandidates);
-    cargo.assignItinerary(itinerary);
+    cargo.setItinerary(itinerary);
 
     /*
       A number of events occur, all of which are according to plan

dddsample/src/test/java/se/citerus/dddsample/util/LocationsImporterTest.java

@@ -8,10 +8,10 @@ public class LocationsImporterTest extends AbstractRepositoryTest {
     LocationsImporter importer = new LocationsImporter();
     long t = System.currentTimeMillis();
 
-    //importer.importLocations(getSessionFactory().getCurrentSession());
-
+    int inserted = importer.importLocations(jdbcTemplate);
+    assertEquals(54600, inserted);
+    
     System.out.println("\n* * * Time to import: " + (System.currentTimeMillis() - t)/1000.0 + " seconds.\n");
-    //setComplete();
   }
 
 }

dddsample/src/test/java/se/citerus/dddsample/web/CargoTrackingControllerTest.java

@@ -10,6 +10,7 @@ import org.springframework.validation.Errors;
 import org.springframework.validation.FieldError;
 import org.springframework.web.servlet.ModelAndView;
 import se.citerus.dddsample.domain.*;
+import static se.citerus.dddsample.domain.SampleLocations.*;
 import se.citerus.dddsample.service.CargoService;
 import se.citerus.dddsample.service.dto.CargoWithHistoryDTO;
 import se.citerus.dddsample.service.dto.HandlingEventDTO;
@@ -40,10 +41,8 @@ public class CargoTrackingControllerTest extends TestCase {
   private CargoService getCargoServiceMock() {
     return new CargoService() {
       public CargoWithHistoryDTO track(TrackingId trackingId) {
-        final Location a5 = new Location(new UnLocode("AA","AAA"), "AAAAA");
-        final Location b5 = new Location(new UnLocode("BB","BBB"), "BBBBB");
-        Cargo cargo = new Cargo(trackingId, a5, b5);
-        HandlingEvent event = new HandlingEvent(cargo, new Date(10L), new Date(20L), HandlingEvent.Type.RECEIVE, b5, null);
+        Cargo cargo = new Cargo(trackingId, HONGKONG, JPTKO);
+        HandlingEvent event = new HandlingEvent(cargo, new Date(10L), new Date(20L), HandlingEvent.Type.RECEIVE, HONGKONG, null);
 
         // TODO: use DTO assemblers
         CargoWithHistoryDTO cargoDTO = new CargoWithHistoryDTO(
@@ -52,12 +51,14 @@ public class CargoTrackingControllerTest extends TestCase {
                 cargo.finalDestination().unLocode().idString(),
                 StatusCode.CLAIMED,
                 "AAAAA",
-                "BALO");
+                "BALO",
+                false);
         cargoDTO.addEvent(new HandlingEventDTO(
           event.location().unLocode().idString(),
           event.type().toString(),
-          null, // TODO: event hierarchy will remove this kind of code
-          event.completionTime()));
+          null,
+          event.completionTime(),
+          true));
         return cargoDTO;
       }