Removed DeliveryHistory, part 1. Need to do some more clean up, specially with the InMem repositories

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

@@ -1,5 +1,11 @@
 package se.citerus.dddsample.domain;
 
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
 import org.apache.commons.lang.builder.EqualsBuilder;
 import org.apache.commons.lang.builder.HashCodeBuilder;
 import org.apache.commons.lang.builder.ReflectionToStringBuilder;
@@ -8,6 +14,7 @@ import org.apache.commons.lang.builder.ToStringStyle;
 import javax.persistence.EmbeddedId;
 import javax.persistence.Entity;
 import javax.persistence.ManyToOne;
+import javax.persistence.OneToMany;
 
 
 /**
@@ -25,25 +32,56 @@ public class Cargo {
   
   @ManyToOne
   private Location finalDestination;
+  
+  @OneToMany
+  private final Set<HandlingEvent> events = new HashSet<HandlingEvent>();
 
-  private DeliveryHistory history;
 
   public Cargo(TrackingId trackingId, Location origin, Location finalDestination) {
     this.trackingId = trackingId;
     this.origin = origin;
     this.finalDestination = finalDestination;
-
-    this.history = new DeliveryHistory();
   }
 
-  public DeliveryHistory deliveryHistory() {
-    return history;
-  }
+//  
+//  public DeliveryHistory deliveryHistory() {
+//    return history;
+//  }
 
   public void handle(HandlingEvent event) {
-    history.addEvent(event);
+    events.add(event);
+  }
+
+  
+  /**
+   * @return An <b>unmodifiable</b> list of handling events, ordered by the time the events occured.
+   */
+  public List<HandlingEvent> eventsOrderedByTime() {
+    List<HandlingEvent> eventList = new ArrayList<HandlingEvent>(events);
+    Collections.sort(eventList, HandlingEvent.BY_TIMESTAMP_COMPARATOR);
+    return Collections.unmodifiableList(eventList);
   }
 
+  /**
+   * 
+   * @return The last handled event
+   */
+  public HandlingEvent lastEvent() {
+    if (events.isEmpty()) {
+      return null;
+    } else {
+      List<HandlingEvent> orderedEvents = eventsOrderedByTime();
+      return orderedEvents.get(orderedEvents.size() - 1);
+    }
+  }
+  
+  /**
+   * Checks if the Cargo's last event was reported at the same Location as the final destination. 
+   * 
+   * Note that this doesn't nessecary mean that the Cargo has been delivered. Possibly there are more handling to be done before the Cargo can be claimed at the final destination
+   * 
+   * @return true if Cargos is at final destination otherwise false.
+   */
   public boolean atFinalDestiation() {
     return currentLocation().equals(finalDestination);
   }
@@ -56,7 +94,7 @@ public class Cargo {
    * @return The last known location
    */
   public Location currentLocation() {
-    HandlingEvent lastEvent = history.lastEvent();
+    HandlingEvent lastEvent = lastEvent();
     
     // If we have no last event, we have not even received the package. Return unknown location
     if (lastEvent == null) {
@@ -109,5 +147,6 @@ public class Cargo {
   
   // Needed by Hibernate
   Cargo() {}
+
   
 }

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

@@ -1,60 +0,0 @@
-package se.citerus.dddsample.domain;
-
-import org.apache.commons.lang.builder.ReflectionToStringBuilder;
-import org.apache.commons.lang.builder.ToStringStyle;
-
-import javax.persistence.Embeddable;
-import javax.persistence.OneToMany;
-import java.util.*;
-
-/**
- * The delivery history of a cargo. One cargo has exactly one delivery history.
- *
- */
-@Embeddable
-public class DeliveryHistory {
-
-  @OneToMany
-  private final Set<HandlingEvent> events = new HashSet<HandlingEvent>();
-
-  private static final HandlingEventByTimeComparator HANDLING_EVENT_COMPARATOR = new HandlingEventByTimeComparator();
-
-  /**
-   * @return An <b>unmodifiable</b> list of handling events, ordered by the time the events occured.
-   */
-  public List<HandlingEvent> eventsOrderedByTime() {
-    List<HandlingEvent> eventList = new ArrayList<HandlingEvent>(events);
-    Collections.sort(eventList, HANDLING_EVENT_COMPARATOR);
-    return Collections.unmodifiableList(eventList);
-  }
-
-  /**
-   * Adds the HandlingEvent to the sorted set.
-   * 
-   * @throws IllegalArgumentException if an event is not unique. Uniquness are evaluated by checking that compareTo() not returns 0.
-   * @param event
-   */
-  public void addEvent(HandlingEvent... event) {
-      events.addAll(Arrays.asList(event));
-  }
-
-  public HandlingEvent lastEvent() {
-    if (events.isEmpty()) {
-      return null;
-    } else {
-      List<HandlingEvent> orderedEvents = eventsOrderedByTime();
-      return orderedEvents.get(orderedEvents.size() - 1);
-    }
-  }
-
-  @Override
-  public String toString() {
-    return ReflectionToStringBuilder.toString(this, ToStringStyle.MULTI_LINE_STYLE);
-  }
-
-  private static class HandlingEventByTimeComparator implements Comparator<HandlingEvent> {
-    public int compare(HandlingEvent o1, HandlingEvent o2) {
-      return o1.timeOccurred().compareTo(o2.timeOccurred());
-    }
-  }
-}

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

@@ -1,25 +1,34 @@
 package se.citerus.dddsample.domain;
 
-import org.apache.commons.lang.builder.EqualsBuilder;
-
-import javax.persistence.*;
-
+import java.util.Comparator;
 import java.util.Date;
 import java.util.HashSet;
 import java.util.Set;
 import java.util.UUID;
 
+import javax.persistence.Entity;
+import javax.persistence.Enumerated;
+import javax.persistence.Id;
+import javax.persistence.ManyToOne;
+import javax.persistence.Transient;
+
+import org.apache.commons.lang.builder.EqualsBuilder;
+
 /**
  * HandlingEvent links the type of handling with a CarrierMovement.
  * 
  * Since HandlingEvents can be added in any order to a Cargo (or
  * DeliveryHistory), they need to implement Comparable to be able to be sorted
  * in correct order.
- *
- * TODO: build hierarchy of event types
  */
 @Entity
 public class HandlingEvent {
+  
+ public static final Comparator<HandlingEvent> BY_TIMESTAMP_COMPARATOR = new Comparator<HandlingEvent>(){
+  public int compare(HandlingEvent o1, HandlingEvent o2) {
+    return o1.timeOccurred().compareTo(o2.timeOccurred());
+  }
+ };
 
   @Id
   private UUID id;

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

@@ -28,12 +28,12 @@ public class CargoRepositoryInMem implements CargoRepository {
   }
 
   public Cargo find(TrackingId trackingId) {
-    if (trackingId.toString().equalsIgnoreCase("DAE")){
-      throw new DataRetrievalFailureException("Network failure. Please try again");
-    }
+    simulateNetworkError(trackingId);
     
     return cargoDb.get(trackingId.toString());
   }
+
+
   
   public void save(Cargo cargo) {
     //No need to save anything with InMem
@@ -70,4 +70,18 @@ public class CargoRepositoryInMem implements CargoRepository {
   public void setHandlingEventRepository(HandlingEventRepository handlingEventRepository) {
     this.handlingEventRepository = handlingEventRepository;
   }
+  
+  /**
+   * Private helper method that simulates network error by thrwoing a DataDataRetrievalFailureException if tracking id equals "DAE".
+   * 
+   * Note that this method is only used for testing purposes.
+   * 
+   * @param trackingId
+   * @throws DataRetrievalFailureException
+   */
+  private void simulateNetworkError(TrackingId trackingId) {
+    if (trackingId.toString().equalsIgnoreCase("DAE")){
+      throw new DataRetrievalFailureException("Network failure. Please try again");
+    }
+  }
 }

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

@@ -24,7 +24,7 @@ public class CargoServiceImpl implements CargoService {
             cargo.finalDestination().unlocode(),
             cargo.currentLocation().unlocode()
     );
-    final List<HandlingEvent> events = cargo.deliveryHistory().eventsOrderedByTime();
+    final List<HandlingEvent> events = cargo.eventsOrderedByTime();
     for (HandlingEvent event : events) {
       CarrierMovement cm = event.carrierMovement();
       String carrierIdString =

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

@@ -1,11 +1,13 @@
 package se.citerus.dddsample.domain;
 
-import junit.framework.TestCase;
-
 import java.text.DateFormat;
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
+import java.util.Calendar;
 import java.util.Date;
+import java.util.List;
+
+import junit.framework.TestCase;
 
 public class CargoTest extends TestCase {
 
@@ -53,6 +55,36 @@ public class CargoTest extends TestCase {
     assertFalse(cargo.atFinalDestiation());
   }
   
+  public void testLastEvent() throws Exception {
+    Cargo cargo = populateCargoOutOfOrder();
+    
+    HandlingEvent lastEvent = cargo.lastEvent();
+    
+    assertEquals("SESTO", lastEvent.location().unlocode());
+    assertEquals(HandlingEvent.Type.LOAD, lastEvent.type());
+    assertEquals(getDate("2007-12-11"), lastEvent.timeOccurred());
+  }
+  
+  public void testLastEventWithNoEvents() throws Exception {
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), new Location("SESTO"), new Location("AUMEL"));
+    
+    HandlingEvent lastEvent = cargo.lastEvent();
+    assertNull(lastEvent);
+  }
+
+  public void testEventsOrderedByTime() throws Exception {
+    Cargo cargo = populateCargoOutOfOrder();
+    
+    List<HandlingEvent> events = cargo.eventsOrderedByTime();
+    
+    Date lastTime = new Date(0);
+    for (HandlingEvent event : events) {
+      Date time = event.timeOccurred();
+      assertTrue(time.compareTo(lastTime) > 0);
+      lastTime = time;
+    }
+  }
+  
   public void testEquality() throws Exception {
     Cargo c1 = new Cargo(new TrackingId("ABC"), new Location("A"), new Location("C"));
     Cargo c2 = new Cargo(new TrackingId("CBA"), new Location("A"), new Location("C"));
@@ -64,6 +96,9 @@ public class CargoTest extends TestCase {
     assertFalse("Cargos are not equal when Locations differ", c2.equals(c3));
   }
 
+  
+  
+  
   // TODO: Generate test data some better way
   private Cargo populateCargoReceivedStockholm() throws Exception {
     final Cargo cargo = new Cargo(new TrackingId("XYZ"), new Location("SESTO"), new Location("AUMEL"));
@@ -164,6 +199,28 @@ public class CargoTest extends TestCase {
     return cargo;
   }
 
+  private Cargo populateCargoOutOfOrder() throws Exception {
+    final Cargo cargo = new Cargo(new TrackingId("XYZ"), new Location("SESTO"), new Location("AUMEL"));
+
+    final CarrierMovement stockholmToHamburg = new CarrierMovement(
+            new CarrierId("CAR_001"), new Location("SESTO"), new Location("DEHAM"));
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-11"), new Date(), HandlingEvent.Type.LOAD, new Location("SESTO"), stockholmToHamburg));
+    cargo.handle(new HandlingEvent(getDate("2007-12-02"), new Date(), HandlingEvent.Type.UNLOAD, new Location("DEHAM"), stockholmToHamburg));
+
+    final CarrierMovement hamburgToHongKong = new CarrierMovement(
+            new CarrierId("CAR_001"), new Location("DEHAM"), new Location("CNHGK"));
+
+    cargo.handle(new HandlingEvent(getDate("2007-12-03"), new Date(), HandlingEvent.Type.LOAD, new Location("DEHAM"), hamburgToHongKong));
+    cargo.handle(new HandlingEvent(getDate("2007-12-04"), new Date(), HandlingEvent.Type.UNLOAD, new Location("CNHGK"), hamburgToHongKong));
+
+    final CarrierMovement hongKongToMelbourne = new CarrierMovement(
+            new CarrierId("CAR_001"), new Location("CNHGK"), new Location("AUMEL"));
+
+    cargo.handle(new HandlingEvent(getDate("2001-12-05"), new Date(), HandlingEvent.Type.LOAD, new Location("CNHGK"), hongKongToMelbourne));
+
+    return cargo;
+  }
   /**
    * Parse an ISO 8601 (YYYY-MM-DD) String to Date
    *

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

@@ -1,30 +0,0 @@
-package se.citerus.dddsample.domain;
-
-import junit.framework.TestCase;
-
-import java.text.DateFormat;
-import java.text.SimpleDateFormat;
-import java.util.Date;
-import java.util.List;
-
-public class DeliveryHistoryTest extends TestCase {
-
-  public void testEvensOrderedByTimeOccured() throws Exception {
-    DeliveryHistory dh = new DeliveryHistory();
-    assertTrue(dh.eventsOrderedByTime().isEmpty());
-
-    DateFormat df = new SimpleDateFormat("yyyy-MM-dd");
-    HandlingEvent he1 = new HandlingEvent(df.parse("2010-01-03"), new Date(), HandlingEvent.Type.RECEIVE, new Location("a"));
-    HandlingEvent he2 = new HandlingEvent(df.parse("2010-01-01"), new Date(), HandlingEvent.Type.LOAD, new Location("b"));
-    HandlingEvent he3 = new HandlingEvent(df.parse("2010-01-04"), new Date(), HandlingEvent.Type.CLAIM, new Location("c"));
-    HandlingEvent he4 = new HandlingEvent(df.parse("2010-01-02"), new Date(), HandlingEvent.Type.UNLOAD, new Location("d"));
-    dh.addEvent(he1, he2, he3, he4);
-
-    List<HandlingEvent> orderEvents = dh.eventsOrderedByTime();
-    assertEquals(4, orderEvents.size());
-    assertSame(he2, orderEvents.get(0));
-    assertSame(he4, orderEvents.get(1));
-    assertSame(he1, orderEvents.get(2));
-    assertSame(he3, orderEvents.get(3));
-  }
-}

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

@@ -14,13 +14,16 @@ public class TrackingScenarioTest extends TestCase {
 
     Cargo cargo = populateCargo();
 
-    DeliveryHistory deliveryHistory = cargo.deliveryHistory();
-
-    List<HandlingEvent> handlingEvents = deliveryHistory.eventsOrderedByTime();
-
+    final List<HandlingEvent> handlingEvents = cargo.eventsOrderedByTime();
+    final HandlingEvent event = cargo.lastEvent();
+
+//
+//    DeliveryHistory deliveryHistory = cargo.deliveryHistory();
+//
+//    List<HandlingEvent> handlingEvents = deliveryHistory.eventsOrderedByTime();
+//
     assertEquals(4, handlingEvents.size());
-    final HandlingEvent event = deliveryHistory.lastEvent();
-
+    
     assertSame(HandlingEvent.Type.UNLOAD, event.type());
     assertFalse(cargo.atFinalDestiation());
     assertEquals("CNHKG", cargo.currentLocation().unlocode());

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

@@ -69,7 +69,7 @@ public class CargoServiceTest extends AbstractDependencyInjectionSpringContextTe
       public Cargo answerWithinTransaction() throws Throwable {
         Cargo cargo = new Cargo(new TrackingId("XYZ"), new Location("ORIG"), new Location("DEST"));
         CarrierMovement cm = new CarrierMovement(new CarrierId("CAR_001"), new Location("FROM"), new Location("TO"));
-        cargo.deliveryHistory().addEvent(
+        cargo.handle(
                 new HandlingEvent(new Date(10L), new Date(20L), HandlingEvent.Type.CLAIM, new Location("TO"), cm)
         );
         return cargo;

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

@@ -45,7 +45,7 @@ public class CargoTrackingControllerTest extends TestCase {
       public CargoWithHistoryDTO find(String trackingId) {
         Cargo cargo = new Cargo(new TrackingId(trackingId), new Location("AAA"), new Location("BBB"));
         HandlingEvent event = new HandlingEvent(new Date(10L), new Date(20L), HandlingEvent.Type.RECEIVE, new Location("AAA"));
-        cargo.deliveryHistory().addEvent(event);
+        cargo.handle(event);
 
         // TODO: use DTO assemblers
         CargoWithHistoryDTO cargoDTO = new CargoWithHistoryDTO(

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

@@ -21,7 +21,6 @@
       <list>
         <value>se.citerus.dddsample.domain.Cargo</value>
         <value>se.citerus.dddsample.domain.Location</value>
-        <value>se.citerus.dddsample.domain.DeliveryHistory</value>
         <value>se.citerus.dddsample.domain.HandlingEvent</value>
         <value>se.citerus.dddsample.domain.CarrierMovement</value>
       </list>