Implemented RouteSpecification.isSatisfiedBy()

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

@@ -3,9 +3,11 @@ package se.citerus.dddsample.domain.model.cargo;
 import org.apache.commons.lang.Validate;
 import se.citerus.dddsample.domain.model.ValueObject;
 import se.citerus.dddsample.domain.model.handling.HandlingEvent;
+import se.citerus.dddsample.domain.model.location.Location;
 
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.Date;
 import java.util.List;
 
 /**
@@ -17,6 +19,7 @@ public class Itinerary implements ValueObject<Itinerary> {
   private List<Leg> legs = Collections.emptyList();
 
   static final Itinerary EMPTY_ITINERARY = new Itinerary();
+  private static final Date END_OF_DAYS = new Date(Long.MAX_VALUE);
 
   /**
    * Constructor.
@@ -76,7 +79,7 @@ public class Itinerary implements ValueObject<Itinerary> {
 
     if (event.type() == HandlingEvent.Type.CLAIM) {
       //Check that the last leg's destination is from the event's location
-      final Leg leg = legs.get(legs.size() - 1);
+      final Leg leg = lastLeg();
       return (leg.unloadLocation().equals(event.location()));
     }
 
@@ -85,6 +88,52 @@ public class Itinerary implements ValueObject<Itinerary> {
   }
 
   /**
+   * @return The initial departure location.
+   */
+  public Location initialDepartureLocation() {
+     if (legs.isEmpty()) {
+       return Location.UNKNOWN;
+     } else {
+       return legs.get(0).loadLocation();
+     }
+  }
+
+  /**
+   * @return The final arrival location.
+   */
+  public Location finalArrivalLocation() {
+    if (legs.isEmpty()) {
+      return Location.UNKNOWN;
+    } else {
+      return lastLeg().unloadLocation();
+    }
+  }
+
+  /**
+   * @return Date when cargo arrives at final destination.
+   */
+  public Date finalArrivalDate() {
+    final Leg lastLeg = lastLeg();
+
+    if (lastLeg == null) {
+      return END_OF_DAYS;
+    } else {
+      return lastLeg.unloadTime();
+    }
+  }
+
+  /**
+   * @return The last leg on the itinerary.
+   */
+  public Leg lastLeg() {
+    if (legs.isEmpty()) {
+      return null;
+    } else {
+      return legs.get(legs.size() - 1);
+    }
+  }
+
+  /**
    * @param other itinerary to compare
    * @return <code>true</code> if the legs in this and the other itinerary are all equal.
    */
@@ -123,5 +172,4 @@ public class Itinerary implements ValueObject<Itinerary> {
 
   // Auto-generated surrogate key
   private Long id;
-
 }

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

@@ -10,7 +10,8 @@ import se.citerus.dddsample.domain.shared.AbstractSpecification;
 import java.util.Date;
 
 /**
- * Route specification.
+ * Route specification. Describes where a cargo orign and destination is,
+ * and the arrival deadline.
  * 
  */
 public class RouteSpecification extends AbstractSpecification<Itinerary> implements ValueObject<RouteSpecification> {
@@ -20,41 +21,51 @@ public class RouteSpecification extends AbstractSpecification<Itinerary> impleme
   private Date arrivalDeadline;
 
   /**
-   * Factory for creatig a route specification for a cargo, from cargo
-   * origin to cargo destination. Use for initial routing.
-   *
    * @param origin origin location
    * @param destination destination location
    * @param arrivalDeadline arrival deadline
    */
-  public RouteSpecification(Location origin, Location destination, Date arrivalDeadline) {
-    Validate.noNullElements(new Object[] {origin, destination, arrivalDeadline});
-    
+  public RouteSpecification(final Location origin, final Location destination, final Date arrivalDeadline) {
+    Validate.notNull(origin, "Origin is required");
+    Validate.notNull(destination, "Destination is required");
+    Validate.notNull(arrivalDeadline, "Arrival deadline is required");
+
     this.origin = origin;
     this.destination = destination;
     this.arrivalDeadline = arrivalDeadline;
   }
 
+  /**
+   * @return Specified origin location.
+   */
   public Location origin() {
     return origin;
   }
 
+  /**
+   * @return Specfied destination location.
+   */
   public Location destination() {
     return destination;
   }
 
+  /**
+   * @return Arrival deadline.
+   */
   public Date arrivalDeadline() {
     return arrivalDeadline;
   }
 
   @Override
-  public boolean isSatisfiedBy(Itinerary itinerary) {
-    // TODO implement
-    return true;
+  public boolean isSatisfiedBy(final Itinerary itinerary) {
+    return itinerary != null &&
+           origin().sameIdentityAs(itinerary.initialDepartureLocation()) &&
+           destination().sameIdentityAs(itinerary.finalArrivalLocation()) &&
+           arrivalDeadline().after(itinerary.finalArrivalDate());
   }
 
   @Override
-  public boolean sameValueAs(RouteSpecification other) {
+  public boolean sameValueAs(final RouteSpecification other) {
     return other != null && new EqualsBuilder().
       append(this.origin, other.origin).
       append(this.destination, other.destination).
@@ -68,7 +79,7 @@ public class RouteSpecification extends AbstractSpecification<Itinerary> impleme
   }
 
   @Override
-  public boolean equals(Object o) {
+  public boolean equals(final Object o) {
     if (this == o) return true;
     if (o == null || getClass() != o.getClass()) return false;
 

dddsample/src/test/java/se/citerus/dddsample/domain/model/cargo/RouteSpecificationTest.java

@@ -1,29 +1,68 @@
 package se.citerus.dddsample.domain.model.cargo;
 
 import junit.framework.TestCase;
-import static se.citerus.dddsample.domain.model.location.SampleLocations.CHICAGO;
-import static se.citerus.dddsample.domain.model.location.SampleLocations.HONGKONG;
+import static se.citerus.dddsample.DateTestUtil.toDate;
+import se.citerus.dddsample.domain.model.carrier.Voyage;
+import se.citerus.dddsample.domain.model.carrier.VoyageNumber;
+import static se.citerus.dddsample.domain.model.location.SampleLocations.*;
 
-import java.util.Date;
+import java.util.Arrays;
 
 public class RouteSpecificationTest extends TestCase {
 
-  public void testIsSatisfiedBySuccess() {
-    RouteSpecification routeSpecification = new RouteSpecification(HONGKONG, CHICAGO, new Date());
-    Itinerary itinerary = new Itinerary();
+  final Voyage hongKongTokyoNewYork = new Voyage.Builder(
+    new VoyageNumber("V001"), HONGKONG).
+    addMovement(TOKYO, toDate("2009-02-01"), toDate("2009-02-05")).
+    addMovement(NEWYORK, toDate("2009-02-06"), toDate("2009-02-10")).
+    addMovement(HONGKONG, toDate("2009-02-11"), toDate("2009-02-14")).
+    build();
+
+  final Voyage dallasNewYorkChicago = new Voyage.Builder(
+    new VoyageNumber("V002"), DALLAS).
+    addMovement(NEWYORK, toDate("2009-02-06"), toDate("2009-02-07")).
+    addMovement(CHICAGO, toDate("2009-02-12"), toDate("2009-02-20")).
+    build();
+
+  // TODO:
+  // it shouldn't be possible to create Legs that have load/unload locations
+  // and/or dates that don't match the voyage's carrier movements.
+  final Itinerary itinerary = new Itinerary(Arrays.asList(
+      new Leg(hongKongTokyoNewYork, HONGKONG, NEWYORK,
+              toDate("2009-02-01"), toDate("2009-02-10")),
+      new Leg(dallasNewYorkChicago, NEWYORK, CHICAGO,
+              toDate("2009-02-12"), toDate("2009-02-20")))
+  );
+
+  public void testIsSatisfiedBy_Success() {
+    RouteSpecification routeSpecification = new RouteSpecification(
+      HONGKONG, CHICAGO, toDate("2009-03-01")
+    );
+
     assertTrue(routeSpecification.isSatisfiedBy(itinerary));
   }
 
-  public void testIsSatisfiedByInvalidDate() {
-    // TODO
+  public void testIsSatisfiedBy_WrongOrigin() {
+    RouteSpecification routeSpecification = new RouteSpecification(
+      HANGZOU, CHICAGO, toDate("2009-03-01")
+    );
+
+    assertFalse(routeSpecification.isSatisfiedBy(itinerary));
   }
 
-  public void testIsSatisfiedByInvalidOrigin() {
-    // TODO
+  public void testIsSatisfiedBy_WrongDestination() {
+    RouteSpecification routeSpecification = new RouteSpecification(
+      HONGKONG, DALLAS, toDate("2009-03-01")
+    );
+
+    assertFalse(routeSpecification.isSatisfiedBy(itinerary));
   }
 
-  public void testIsSatisfiedByInvalidDestination() {
-    // TODO
+  public void testIsSatisfiedBy_MissedDeadline() {
+    RouteSpecification routeSpecification = new RouteSpecification(
+      HONGKONG, CHICAGO, toDate("2009-02-15")
+    );
+
+    assertFalse(routeSpecification.isSatisfiedBy(itinerary));
   }
 
 }