Improved cargo delivery updater, added itinerary updater.

Migrated parts of the code base to use the cargo.handled(HandlingActivity) way of pushing aggregate updates.

dddsample/src/main/java/se/citerus/dddsample/application/event/CargoDeliveryUpdater.java

@@ -6,8 +6,8 @@ import org.springframework.transaction.annotation.Transactional;
 import se.citerus.dddsample.domain.model.cargo.Cargo;
 import se.citerus.dddsample.domain.model.cargo.CargoRepository;
 import se.citerus.dddsample.domain.model.cargo.TrackingId;
+import se.citerus.dddsample.domain.model.handling.HandlingEvent;
 import se.citerus.dddsample.domain.model.handling.HandlingEventRepository;
-import se.citerus.dddsample.domain.model.handling.HandlingHistory;
 
 public class CargoDeliveryUpdater {
 
@@ -27,8 +27,10 @@ public class CargoDeliveryUpdater {
   @Transactional
   public void updateDelivery(final TrackingId trackingId) {
     final Cargo cargo = cargoRepository.find(trackingId);
-    final HandlingHistory handlingHistory = handlingEventRepository.lookupHandlingHistoryOfCargo(cargo);
-    cargo.deriveDeliveryProgress(handlingHistory);
+    final HandlingEvent handlingEvent = handlingEventRepository.mostRecentHandling(cargo);
+
+    // TODO still doesn't sound right...cargo.updateDelivery()?
+    cargo.handled(handlingEvent.handlingActivity());
 
     cargoRepository.store(cargo);
     applicationEvents.cargoDeliveryWasUpdated(cargo);

dddsample/src/main/java/se/citerus/dddsample/application/event/ItineraryUpdater.java

@@ -0,0 +1,43 @@
+/**
+ * Purpose
+ * @author peter
+ * @created 2009-aug-04
+ * $Id$
+ */
+package se.citerus.dddsample.application.event;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.springframework.transaction.annotation.Transactional;
+import se.citerus.dddsample.domain.model.cargo.Cargo;
+import se.citerus.dddsample.domain.model.cargo.CargoRepository;
+import se.citerus.dddsample.domain.model.cargo.Itinerary;
+import se.citerus.dddsample.domain.model.voyage.Voyage;
+import se.citerus.dddsample.domain.model.voyage.VoyageNumber;
+import se.citerus.dddsample.domain.model.voyage.VoyageRepository;
+
+import java.util.List;
+
+public final class ItineraryUpdater {
+
+  private VoyageRepository voyageRepository;
+  private CargoRepository cargoRepository;
+  private static final Log LOG = LogFactory.getLog(ItineraryUpdater.class);
+
+  public ItineraryUpdater(final VoyageRepository voyageRepository, final CargoRepository cargoRepository) {
+    this.voyageRepository = voyageRepository;
+    this.cargoRepository = cargoRepository;
+  }
+
+  @Transactional
+  public void updateItineraries(final VoyageNumber voyageNumber) {
+    final Voyage voyage = voyageRepository.find(voyageNumber);
+    final List<Cargo> affectedCargos = cargoRepository.findCargosOnVoyage(voyage);
+    for (final Cargo cargo : affectedCargos) {
+      final Itinerary newItinerary = cargo.itinerary().withRescheduledVoyage(voyage);
+      cargo.assignToRoute(newItinerary);
+      LOG.info("Updated itinerary of cargo " + cargo);
+    }
+  }
+
+}

dddsample/src/main/java/se/citerus/dddsample/application/event/ReadyToClaimNotfier.java

@@ -16,7 +16,6 @@ import se.citerus.dddsample.domain.model.cargo.TrackingId;
 public class ReadyToClaimNotfier {
 
   private CargoRepository cargoRepository;
-
   private static final Log LOG = LogFactory.getLog(ReadyToClaimNotfier.class);
 
   public ReadyToClaimNotfier(final CargoRepository cargoRepository) {
@@ -26,7 +25,7 @@ public class ReadyToClaimNotfier {
   @Transactional
   public void alertIfReadyToClaim(final TrackingId trackingId) {
     final Cargo cargo = cargoRepository.find(trackingId);
-
+                                                      
     if (cargo.delivery().isUnloadedAtDestination()) {
       LOG.info("Cargo " + cargo + " is ready to be claimed");
     }

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

@@ -86,7 +86,7 @@ public final class BookingServiceImpl implements BookingService {
 
   @Override
   @Transactional
-  public Cargo loadCargoForRouting(TrackingId trackingId) {
+  public Cargo loadCargoForRouting(final TrackingId trackingId) {
     // TODO locking semantics
     final Cargo cargo = cargoRepository.find(trackingId);
     return cargo;

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

@@ -12,7 +12,10 @@ import org.springframework.web.context.WebApplicationContext;
 import org.springframework.web.context.support.WebApplicationContextUtils;
 import static se.citerus.dddsample.application.util.DateTestUtil.toDate;
 import se.citerus.dddsample.domain.model.cargo.*;
-import se.citerus.dddsample.domain.model.handling.*;
+import se.citerus.dddsample.domain.model.handling.CannotCreateHandlingEventException;
+import se.citerus.dddsample.domain.model.handling.HandlingEvent;
+import se.citerus.dddsample.domain.model.handling.HandlingEventFactory;
+import se.citerus.dddsample.domain.model.handling.HandlingEventRepository;
 import se.citerus.dddsample.domain.model.location.Location;
 import se.citerus.dddsample.domain.model.location.LocationRepository;
 import se.citerus.dddsample.domain.model.location.SampleLocations;
@@ -250,9 +253,8 @@ public class SampleDataGenerator implements ServletContextListener {
           throw new RuntimeException(e);
         }
 
-        HandlingHistory handlingHistory = handlingEventRepository.lookupHandlingHistoryOfCargo(abc123);
-        abc123.deriveDeliveryProgress(handlingHistory);
-
+        final HandlingEvent handlingEvent = handlingEventRepository.mostRecentHandling(abc123);
+        abc123.handled(handlingEvent.handlingActivity());
         session.update(abc123);
 
         // Cargo JKL567
@@ -295,9 +297,8 @@ public class SampleDataGenerator implements ServletContextListener {
           throw new RuntimeException(e);
         }
 
-        HandlingHistory handlingHistory1 = handlingEventRepository.lookupHandlingHistoryOfCargo(jkl567);
-        jkl567.deriveDeliveryProgress(handlingHistory1);
-
+        HandlingEvent handlingEvent1 = handlingEventRepository.mostRecentHandling(jkl567);
+        jkl567.handled(handlingEvent1.handlingActivity());
         session.update(jkl567);
       }
     });

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

@@ -1,5 +1,7 @@
 package se.citerus.dddsample.domain.model.cargo;
 
+import se.citerus.dddsample.domain.model.voyage.Voyage;
+
 import java.util.List;
 
 public interface CargoRepository {
@@ -13,6 +15,13 @@ public interface CargoRepository {
   Cargo find(TrackingId trackingId);
 
   /**
+   *
+   * @param voyage
+   * @return
+   */
+  List<Cargo> findCargosOnVoyage(Voyage voyage);
+
+  /**
    * Finds all cargo.
    *
    * @return All cargo.
@@ -30,5 +39,4 @@ public interface CargoRepository {
    * @return A unique, generated tracking Id.
    */
   TrackingId nextTrackingId();
-
 }

dddsample/src/main/java/se/citerus/dddsample/domain/model/handling/HandlingEventRepository.java

@@ -21,4 +21,11 @@ public interface HandlingEventRepository {
    */
   HandlingHistory lookupHandlingHistoryOfCargo(Cargo cargo);
 
+  /**
+   *
+   * @param cargo cargo
+   * @return The most recent handling of the cargo, or null if it has never been handled.
+   */
+  HandlingEvent mostRecentHandling(Cargo cargo);
+
 }

dddsample/src/main/java/se/citerus/dddsample/infrastructure/persistence/hibernate/CargoRepositoryHibernate.java

@@ -4,6 +4,7 @@ import org.springframework.stereotype.Repository;
 import se.citerus.dddsample.domain.model.cargo.Cargo;
 import se.citerus.dddsample.domain.model.cargo.CargoRepository;
 import se.citerus.dddsample.domain.model.cargo.TrackingId;
+import se.citerus.dddsample.domain.model.voyage.Voyage;
 
 import java.util.List;
 import java.util.UUID;
@@ -21,6 +22,17 @@ public class CargoRepositoryHibernate extends HibernateRepository implements Car
       uniqueResult();
   }
 
+  @SuppressWarnings("unchecked")
+  @Override
+  public List<Cargo> findCargosOnVoyage(Voyage voyage) {
+    return getSession().createQuery(
+      "select cargo from Cargo as cargo " +
+        "left join cargo.itinerary.legs as leg " +
+        "where leg.voyage = :voyage").
+      setParameter("voyage", voyage).
+      list();
+  }
+
   public void store(Cargo cargo) {
     getSession().saveOrUpdate(cargo);
     // Delete-orphan does not seem to work correctly when the parent is a component
@@ -37,7 +49,7 @@ public class CargoRepositoryHibernate extends HibernateRepository implements Car
 
   @SuppressWarnings("unchecked")
   public List<Cargo> findAll() {
-      return getSession().createQuery("from Cargo").list();
+    return getSession().createQuery("from Cargo").list();
   }
 
 }

dddsample/src/main/java/se/citerus/dddsample/infrastructure/persistence/hibernate/HandlingEventRepositoryHibernate.java

@@ -33,4 +33,13 @@ public class HandlingEventRepositoryHibernate extends HibernateRepository implem
     }
   }
 
+  @Override
+  public HandlingEvent mostRecentHandling(Cargo cargo) {
+      return (HandlingEvent) getSession().createQuery(
+        "from HandlingEvent where cargo = :cargo order by completionTime desc").
+        setParameter("cargo", cargo).
+        setMaxResults(1).
+        uniqueResult();
+  }
+
 }

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

@@ -170,4 +170,22 @@ public class CargoRepositoryTest extends AbstractRepositoryTest {
     assertFalse(trackingId.equals(trackingId2));
   }
 
+  public void testFindCargosOnVoyage() {
+    Voyage voyage = voyageRepository.find(new VoyageNumber("0101"));
+    List<Cargo> cargos = cargoRepository.findCargosOnVoyage(voyage);
+    assertEquals(3, cargos.size());
+    for (Cargo cargo : cargos) {
+      boolean found = false;
+      for (Leg leg : cargo.itinerary().legs()) {
+        if (leg.voyage().sameIdentityAs(voyage)) {
+          found = true;
+        }
+      }
+      assertTrue("Cargo " + cargo + " has no leg on voyage " + voyage, found);
+    }
+    
+    Voyage voyage2 = voyageRepository.find(new VoyageNumber("0100S"));
+    assertTrue(cargoRepository.findCargosOnVoyage(voyage2).isEmpty());
+  }
+
 }

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

@@ -1,5 +1,6 @@
 package se.citerus.dddsample.infrastructure.persistence.hibernate;
 
+import static se.citerus.dddsample.application.util.DateTestUtil.toDate;
 import se.citerus.dddsample.domain.model.cargo.Cargo;
 import se.citerus.dddsample.domain.model.cargo.CargoRepository;
 import se.citerus.dddsample.domain.model.cargo.TrackingId;
@@ -7,7 +8,9 @@ import se.citerus.dddsample.domain.model.handling.HandlingEvent;
 import se.citerus.dddsample.domain.model.handling.HandlingEventRepository;
 import se.citerus.dddsample.domain.model.location.Location;
 import se.citerus.dddsample.domain.model.location.LocationRepository;
+import static se.citerus.dddsample.domain.model.location.SampleLocations.MELBOURNE;
 import se.citerus.dddsample.domain.model.location.UnLocode;
+import se.citerus.dddsample.domain.model.shared.HandlingActivity;
 
 import java.util.Date;
 import java.util.List;
@@ -57,4 +60,12 @@ public class HandlingEventRepositoryTest extends AbstractRepositoryTest {
     assertEquals(12, handlingEvents.size());
   }
 
+  public void testMostRecentHandling() {
+    Cargo cargo = cargoRepository.find(new TrackingId("XYZ"));
+    HandlingEvent handlingEvent = handlingEventRepository.mostRecentHandling(cargo);
+    assertEquals(cargo, handlingEvent.cargo());
+    assertEquals(toDate("2007-09-27", "05:00"), handlingEvent.completionTime());
+    assertEquals(new HandlingActivity(HandlingEvent.Type.CLAIM, MELBOURNE), handlingEvent.handlingActivity());
+  }
+
 }

dddsample/src/test/java/se/citerus/dddsample/infrastructure/persistence/inmemory/CargoRepositoryInMem.java

@@ -7,6 +7,7 @@ import se.citerus.dddsample.domain.model.cargo.TrackingId;
 import se.citerus.dddsample.domain.model.handling.HandlingHistory;
 import se.citerus.dddsample.domain.model.location.Location;
 import static se.citerus.dddsample.domain.model.location.SampleLocations.*;
+import se.citerus.dddsample.domain.model.voyage.Voyage;
 
 import java.util.*;
 
@@ -33,10 +34,23 @@ public class CargoRepositoryInMem implements CargoRepository {
     return cargoDb.get(trackingId.stringValue());
   }
 
-  public void store(final Cargo cargo) {
+  @Override
+  public List<Cargo> findCargosOnVoyage(Voyage voyage) {
+    List<Cargo> onVoyage = new ArrayList<Cargo>();
+    for (Cargo cargo : cargoDb.values()) {
+      if (voyage.sameIdentityAs(cargo.delivery().currentVoyage())) {
+        onVoyage.add(cargo);
+      }
+    }
+    return onVoyage;
+  }
+
+  @Override
+  public void store(Cargo cargo) {
     cargoDb.put(cargo.trackingId().stringValue(), cargo);
   }
 
+  @Override
   public TrackingId nextTrackingId() {
     String random = UUID.randomUUID().toString().toUpperCase();
     return new TrackingId(
@@ -44,6 +58,7 @@ public class CargoRepositoryInMem implements CargoRepository {
     );
   }
 
+  @Override
   public List<Cargo> findAll() {
     return new ArrayList<Cargo>(cargoDb.values());
   }

dddsample/src/test/java/se/citerus/dddsample/infrastructure/persistence/inmemory/HandlingEventRepositoryInMem.java

@@ -6,14 +6,18 @@ import se.citerus.dddsample.domain.model.handling.HandlingEvent;
 import se.citerus.dddsample.domain.model.handling.HandlingEventRepository;
 import se.citerus.dddsample.domain.model.handling.HandlingHistory;
 
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 
 public class HandlingEventRepositoryInMem implements HandlingEventRepository {
 
   private Map<TrackingId, List<HandlingEvent>> eventMap = new HashMap<TrackingId, List<HandlingEvent>>();
+  private static final Comparator<HandlingEvent> BY_COMPLETION_TIME_DESC = new Comparator<HandlingEvent>() {
+    @Override
+    public int compare(HandlingEvent o1, HandlingEvent o2) {
+      // Newest first
+      return o2.completionTime().compareTo(o1.completionTime());
+    }
+  };
 
   @Override
   public void store(HandlingEvent event) {
@@ -37,4 +41,15 @@ public class HandlingEventRepositoryInMem implements HandlingEventRepository {
     }
   }
 
+  @Override
+  public HandlingEvent mostRecentHandling(Cargo cargo) {
+    List<HandlingEvent> handlingEvents = eventMap.get(cargo.trackingId());
+    if (handlingEvents == null) {
+      return null;
+    }
+
+    Collections.sort(handlingEvents, BY_COMPLETION_TIME_DESC);
+    return handlingEvents.get(0);
+  }
+
 }

dddsample/src/test/java/se/citerus/dddsample/scenario/CargoLifecycleScenarioTest.java

@@ -8,8 +8,11 @@ import static se.citerus.dddsample.application.util.DateTestUtil.toDate;
 import se.citerus.dddsample.domain.model.cargo.*;
 import static se.citerus.dddsample.domain.model.cargo.RoutingStatus.*;
 import static se.citerus.dddsample.domain.model.cargo.TransportStatus.*;
-import se.citerus.dddsample.domain.model.handling.*;
+import se.citerus.dddsample.domain.model.handling.CannotCreateHandlingEventException;
+import se.citerus.dddsample.domain.model.handling.HandlingEvent;
 import static se.citerus.dddsample.domain.model.handling.HandlingEvent.Type.*;
+import se.citerus.dddsample.domain.model.handling.HandlingEventFactory;
+import se.citerus.dddsample.domain.model.handling.HandlingEventRepository;
 import se.citerus.dddsample.domain.model.location.Location;
 import se.citerus.dddsample.domain.model.location.LocationRepository;
 import static se.citerus.dddsample.domain.model.location.SampleLocations.*;
@@ -375,16 +378,20 @@ public class CargoLifecycleScenarioTest {
   }
 
   private void createHandlingEventAndUpdateAggregates(Date completionTime, Voyage voyage, Location location, HandlingEvent.Type type) throws CannotCreateHandlingEventException {
+    updateHandlingEventAggregate(completionTime, voyage, location, type);
+    updateCargoAggregate();
+  }
+
+  private void updateHandlingEventAggregate(Date completionTime, Voyage voyage, Location location, HandlingEvent.Type type) throws CannotCreateHandlingEventException {
     VoyageNumber voyageNumber = voyage != null ? voyage.voyageNumber() : null;
     HandlingEvent handlingEvent = handlingEventFactory.createHandlingEvent(new Date(), completionTime, trackingId, voyageNumber, location.unLocode(), type);
     handlingEventRepository.store(handlingEvent);
-    updateCargoAggregate();
   }
 
   private void updateCargoAggregate() {
     Cargo cargo = cargoRepository.find(trackingId);
-    HandlingHistory handlingHistory = handlingEventRepository.lookupHandlingHistoryOfCargo(cargo);
-    cargo.deriveDeliveryProgress(handlingHistory);
+    HandlingEvent handlingEvent = handlingEventRepository.mostRecentHandling(cargo);
+    cargo.handled(handlingEvent.handlingActivity());
     cargoRepository.store(cargo);
   }