A few minor method name changes and documentation imrpovements

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

@@ -46,7 +46,7 @@ public final class BookingServiceImpl implements BookingService {
 
     final Cargo cargo = new Cargo(trackingId, origin, routeSpecification);
 
-    cargoRepository.save(cargo);
+    cargoRepository.store(cargo);
     logger.info("Booked new cargo with tracking id " + cargo.trackingId().idString());
 
     return cargo.trackingId();

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

@@ -43,7 +43,7 @@ public final class HandlingEventServiceImpl implements HandlingEventService {
          state of the handling event aggregate (but not the cargo aggregate -
          that happens asynchronously!)
        */
-      handlingEventRepository.save(event);
+      handlingEventRepository.store(event);
 
       /* Publish an event stating that a cargo has been handled. */
       applicationEvents.cargoWasHandled(event);

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

@@ -24,15 +24,13 @@ public interface CargoRepository {
    *
    * @param cargo cargo to save
    */
-  void save(Cargo cargo);
+  void store(Cargo cargo);
 
   /**
-   * TODO
-   * this might be too complex a procedure to belong in the repository -
-   * introduce a TrackingIdFactory (or perhaps a CargoFactory).
-   *
-   * @return A new generated tracking Id.
+   * @return A unique, generated tracking Id.
    */
   TrackingId nextTrackingId();
 
+  // TODO perhaps it belongs in a factory instead
+
 }

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

@@ -117,7 +117,7 @@ public class Delivery implements ValueObject<Delivery> {
     }
   }
 
-  // TODO add currentCarrierMovement
+  // TODO add currentCarrierMovement (?)
 
   private void calculateCurrentVoyage() {
     if (transportStatus().equals(ONBOARD_CARRIER) && lastEvent != null) {

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

@@ -31,16 +31,15 @@ public class HandlingEventFactory {
   }
 
   /**
+   * @param registrationTime  time when this event was received by the system
    * @param completionTime    when the event was completed, for example finished loading
-   * @param trackingId        tracking id
+   * @param trackingId        cargo tracking id
    * @param voyageNumber      voyage number
    * @param unlocode          United Nations Location Code for the location of the event
    * @param type              type of event
-   * @param registrationTime  time when this event was received by the system
-   * @throws UnknownVoyageException
-   *                                    if there's not carrier movement with this id
-   * @throws UnknownCargoException if there's no cargo with this tracking id
-   * @throws UnknownLocationException   if there's no location with this UN Locode
+   * @throws UnknownVoyageException   if there's no voyage with this number
+   * @throws UnknownCargoException    if there's no cargo with this tracking id
+   * @throws UnknownLocationException if there's no location with this UN Locode
    * @return A handling event.
    */
   public HandlingEvent createHandlingEvent(Date registrationTime, Date completionTime, TrackingId trackingId, VoyageNumber voyageNumber, UnLocode unlocode, HandlingEvent.Type type)

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

@@ -10,16 +10,17 @@ import java.util.List;
 public interface HandlingEventRepository {
 
   /**
-   * Saves a (new) handling event.
+   * Stores a (new) handling event.
    *
    * @param event handling event to save
    */
-  void save(final HandlingEvent event);
+  void store(HandlingEvent event);
 
 
   /**
    * @param trackingId cargo tracking id
-   * @return All handling events for this cargo, ordered by completion time.
+   * @return All handling events for this cargo
    */
-  List<HandlingEvent> findEventsForCargo(final TrackingId trackingId);
+  List<HandlingEvent> findEventsForCargo(TrackingId trackingId);
+
 }

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

@@ -21,7 +21,7 @@ public class CargoRepositoryHibernate extends HibernateRepository implements Car
       uniqueResult();
   }
 
-  public void save(Cargo cargo) {
+  public void store(Cargo cargo) {
     getSession().persist(cargo);
     getSession().createSQLQuery("delete from Leg where cargo_id = null").executeUpdate();
   }

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

@@ -14,13 +14,15 @@ import java.util.List;
 @Repository
 public class HandlingEventRepositoryHibernate extends HibernateRepository implements HandlingEventRepository {
 
-  public void save(HandlingEvent event) {
+  @Override
+  public void store(HandlingEvent event) {
     getSession().save(event);
   }
 
+  @Override
   public List<HandlingEvent> findEventsForCargo(TrackingId tid) {
     return getSession().createQuery(
-            "from HandlingEvent where cargo.trackingId = :tid order by completionTime").
+            "from HandlingEvent where cargo.trackingId = :tid").
             setParameter("tid", tid).
             list();
   }

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

@@ -68,7 +68,7 @@ public class BookingServiceFacadeImpl implements BookingServiceFacade {
     }
 
     cargo.assignToRoute(itinerary);
-    cargoRepository.save(cargo);
+    cargoRepository.store(cargo);
 
     logger.info("Assigned cargo " + trackingId + " to new route");
   }

dddsample/src/test/java/se/citerus/dddsample/application/BookingServiceTest.java

@@ -37,7 +37,7 @@ public class BookingServiceTest extends TestCase {
     expect(locationRepository.find(fromUnlocode)).andReturn(CHICAGO);
     expect(locationRepository.find(toUnlocode)).andReturn(STOCKHOLM);
 
-    cargoRepository.save(isA(Cargo.class));
+    cargoRepository.store(isA(Cargo.class));
 
     replay(cargoRepository, locationRepository);
 

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

@@ -57,7 +57,7 @@ public class HandlingEventServiceTest extends TestCase {
     expect(locationRepository.find(unLocode)).andReturn(STOCKHOLM);
 
     // TODO: does not inspect the handling event instance in a sufficient way
-    handlingEventRepository.save(isA(HandlingEvent.class));
+    handlingEventRepository.store(isA(HandlingEvent.class));
     applicationEvents.cargoWasHandled(isA(HandlingEvent.class));
 
     replay(cargoRepository, voyageRepository, handlingEventRepository, locationRepository, applicationEvents);
@@ -71,7 +71,7 @@ public class HandlingEventServiceTest extends TestCase {
     final TrackingId trackingId = new TrackingId("ABC");
     expect(cargoRepository.find(trackingId)).andReturn(cargoABC);
 
-    handlingEventRepository.save(isA(HandlingEvent.class));
+    handlingEventRepository.store(isA(HandlingEvent.class));
     applicationEvents.cargoWasHandled(isA(HandlingEvent.class));
 
     expect(locationRepository.find(STOCKHOLM.unLocode())).andReturn(STOCKHOLM);

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

@@ -112,7 +112,7 @@ public class CargoRepositoryTest extends AbstractRepositoryTest {
     Location destination = locationRepository.find(MELBOURNE.unLocode());
 
     Cargo cargo = new Cargo(trackingId, origin, new RouteSpecification(origin, destination, new Date()));
-    cargoRepository.save(cargo);
+    cargoRepository.store(cargo);
 
     flush();
 
@@ -139,7 +139,7 @@ public class CargoRepositoryTest extends AbstractRepositoryTest {
 
     cargo.assignToRoute(newItinerary);
 
-    cargoRepository.save(cargo);
+    cargoRepository.store(cargo);
     flush();
 
     assertEquals(1, sjt.queryForInt("select count(*) from Leg where cargo_id = ?", cargoId));

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

@@ -39,7 +39,7 @@ public class HandlingEventRepositoryTest extends AbstractRepositoryTest {
     Date registrationTime = new Date(20);
     HandlingEvent event = new HandlingEvent(cargo, completionTime, registrationTime, HandlingEvent.Type.CLAIM, location);
 
-    handlingEventRepository.save(event);
+    handlingEventRepository.store(event);
 
     flush();
 

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

@@ -41,7 +41,7 @@ public class CargoRepositoryInMem implements CargoRepository {
     return cargoDb.get(trackingId.idString());
   }
 
-  public void save(final Cargo cargo) {
+  public void store(final Cargo cargo) {
     cargoDb.put(cargo.trackingId().idString(), cargo);
   }
 

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

@@ -82,7 +82,7 @@ public class HandlingEventRepositoryInMem implements HandlingEventRepository {
   }
 
 
-  public void save(HandlingEvent event) {
+  public void store(HandlingEvent event) {
     eventDB.put(event.cargo().trackingId().idString(), event);
   }
 

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

@@ -238,7 +238,7 @@ public class CargoLifecycleScenarioTest extends TestCase {
     handlingEventRepository = new HandlingEventRepository() {
       Map<TrackingId, List<HandlingEvent>> eventMap = new HashMap<TrackingId, List<HandlingEvent>>();
 
-      public void save(HandlingEvent event) {
+      public void store(HandlingEvent event) {
         final TrackingId trackingId = event.cargo().trackingId();
         List<HandlingEvent> list = eventMap.get(trackingId);
         if (list == null) {