Refactored creation of Cargo into a CargoFactory.

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

@@ -1,5 +1,6 @@
 package se.citerus.dddsample.application.impl;
 
+import org.apache.commons.lang.Validate;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.springframework.transaction.annotation.Transactional;
@@ -16,17 +17,20 @@ import java.util.List;
 
 public final class BookingServiceImpl implements BookingService {
 
+  private final RoutingService routingService;
+  private final CargoFactory cargoFactory;
   private final CargoRepository cargoRepository;
   private final LocationRepository locationRepository;
-  private final RoutingService routingService;
   private final Log logger = LogFactory.getLog(getClass());
 
-  public BookingServiceImpl(final CargoRepository cargoRepository,
-                            final LocationRepository locationRepository,
-                            final RoutingService routingService) {
+  public BookingServiceImpl(final RoutingService routingService,
+                            final CargoFactory cargoFactory,
+                            final CargoRepository cargoRepository,
+                            final LocationRepository locationRepository) {
+    this.routingService = routingService;
+    this.cargoFactory = cargoFactory;
     this.cargoRepository = cargoRepository;
     this.locationRepository = locationRepository;
-    this.routingService = routingService;
   }
 
   @Override
@@ -34,14 +38,7 @@ public final class BookingServiceImpl implements BookingService {
   public TrackingId bookNewCargo(final UnLocode originUnLocode,
                                  final UnLocode destinationUnLocode,
                                  final Date arrivalDeadline) {
-    // TODO modeling this as a cargo factory might be suitable
-    final TrackingId trackingId = cargoRepository.nextTrackingId();
-    final Location origin = locationRepository.find(originUnLocode);
-    final Location destination = locationRepository.find(destinationUnLocode);
-    final RouteSpecification routeSpecification = new RouteSpecification(origin, destination, arrivalDeadline);
-
-    final Cargo cargo = new Cargo(trackingId, routeSpecification);
-
+    final Cargo cargo = cargoFactory.newCargo(originUnLocode, destinationUnLocode, arrivalDeadline);
     cargoRepository.store(cargo);
     logger.info("Booked new cargo with tracking id " + cargo.trackingId().idString());
 
@@ -64,10 +61,7 @@ public final class BookingServiceImpl implements BookingService {
   @Transactional
   public void assignCargoToRoute(final Itinerary itinerary, final TrackingId trackingId) {
     final Cargo cargo = cargoRepository.find(trackingId);
-    if (cargo == null) {
-      throw new IllegalArgumentException("Can't assign itinerary to non-existing cargo " + trackingId);
-    }
-
+    Validate.notNull(cargo, "Can't assign itinerary to non-existing cargo " + trackingId);
     cargo.assignToRoute(itinerary);
     cargoRepository.store(cargo);
 
@@ -78,6 +72,7 @@ public final class BookingServiceImpl implements BookingService {
   @Transactional
   public void changeDestination(final TrackingId trackingId, final UnLocode unLocode) {
     final Cargo cargo = cargoRepository.find(trackingId);
+    Validate.notNull(cargo, "Can't change destination of non-existing cargo " + trackingId);
     final Location newDestination = locationRepository.find(unLocode);
 
     final RouteSpecification routeSpecification = cargo.routeSpecification().withDestination(newDestination);

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

@@ -0,0 +1,34 @@
+/**
+ * Purpose
+ * @author peter
+ * @created 2009-jun-14
+ * $Id$
+ */
+package se.citerus.dddsample.domain.model.cargo;
+
+import se.citerus.dddsample.domain.model.location.Location;
+import se.citerus.dddsample.domain.model.location.LocationRepository;
+import se.citerus.dddsample.domain.model.location.UnLocode;
+
+import java.util.Date;
+
+public class CargoFactory {
+
+  private final CargoRepository cargoRepository;
+  private final LocationRepository locationRepository;
+
+  public CargoFactory(CargoRepository cargoRepository, LocationRepository locationRepository) {
+    this.cargoRepository = cargoRepository;
+    this.locationRepository = locationRepository;
+  }
+
+  public Cargo newCargo(UnLocode originUnLocode, UnLocode destinationUnLocode, Date arrivalDeadline) {
+    final TrackingId trackingId = cargoRepository.nextTrackingId();
+    final Location origin = locationRepository.find(originUnLocode);
+    final Location destination = locationRepository.find(destinationUnLocode);
+    final RouteSpecification routeSpecification = new RouteSpecification(origin, destination, arrivalDeadline);
+
+    return new Cargo(trackingId, routeSpecification);
+  }
+
+}

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

@@ -57,6 +57,30 @@ public class RouteSpecification extends AbstractSpecification<Itinerary> impleme
     return new Date(arrivalDeadline.getTime());
   }
 
+  /**
+   * @param newDestination destination of new route specification
+   * @return A copy of this route specification but with new destination
+   */
+  public RouteSpecification withDestination(Location newDestination) {
+	  return new RouteSpecification(origin, newDestination, arrivalDeadline);
+  }
+
+  /**
+   * @param newOrigin origin of new route specification
+   * @return A copy of this route specification but with the new origin
+   */
+  public RouteSpecification withOrigin(Location newOrigin) {
+    return new RouteSpecification(newOrigin, destination, arrivalDeadline);
+  }
+
+  /**
+   * @param newArrivalDeadline arrival deadline of new route specification
+   * @return A copy of this route specification but with the new arrival deadline
+   */
+  public RouteSpecification withArrivalDeadline(Date newArrivalDeadline) {
+    return new RouteSpecification(origin, destination, newArrivalDeadline);
+  }
+
   @Override
   public boolean isSatisfiedBy(final Itinerary itinerary) {
     return itinerary != null &&
@@ -96,11 +120,4 @@ public class RouteSpecification extends AbstractSpecification<Itinerary> impleme
   RouteSpecification() {
     // Needed by Hibernate
   }
-
-public RouteSpecification withDestination(Location newDestination) {
-
-	return new RouteSpecification(origin, newDestination, arrivalDeadline);
-	
-}
-  
 }

dddsample/src/main/java/se/citerus/dddsample/interfaces/tracking/CargoTrackingViewAdapter.java

@@ -57,7 +57,7 @@ public final class CargoTrackingViewAdapter {
   }
 
   /**
-   * @return A translated string describing the cargo status. 
+   * @return A translated string describing the cargo status.
    */
   public String getStatusText() {
     final Delivery delivery = cargo.delivery();
@@ -66,10 +66,10 @@ public final class CargoTrackingViewAdapter {
     final Object[] args;
     switch (delivery.transportStatus()) {
       case IN_PORT:
-        args = new Object[] {getDisplayText(delivery.lastKnownLocation())};
+        args = new Object[]{getDisplayText(delivery.lastKnownLocation())};
         break;
       case ONBOARD_CARRIER:
-        args = new Object[] {delivery.currentVoyage().voyageNumber().idString()};
+        args = new Object[]{delivery.currentVoyage().voyageNumber().idString()};
         break;
       case CLAIMED:
       case NOT_RECEIVED:
@@ -78,7 +78,7 @@ public final class CargoTrackingViewAdapter {
         args = null;
         break;
     }
-    
+
     return messageSource.getMessage(code, args, "[Unknown status]", locale);
   }
 
@@ -107,33 +107,33 @@ public final class CargoTrackingViewAdapter {
     Date eta = cargo.delivery().estimatedTimeOfArrival();
 
     if (eta == null) return "?";
-	else {
-		Location destination = cargo.routeSpecification().destination();
-		SimpleDateFormat dateFormat = new SimpleDateFormat(FORMAT);
-		dateFormat.setTimeZone(destination.timeZone());
-		return dateFormat.format(eta);
-	}
+    else {
+      Location destination = cargo.routeSpecification().destination();
+      SimpleDateFormat dateFormat = new SimpleDateFormat(FORMAT);
+      dateFormat.setTimeZone(destination.timeZone());
+      return dateFormat.format(eta);
+    }
   }
 
   public String getNextExpectedActivity() {
-      HandlingActivity activity = cargo.delivery().nextExpectedActivity();
-      if (activity == null) {
-        return "";
-      }
+    HandlingActivity activity = cargo.delivery().nextExpectedActivity();
+    if (activity == null) {
+      return "";
+    }
 
     String text = "Next expected activity is to ";
     HandlingEvent.Type type = activity.type();
     if (type.sameValueAs(HandlingEvent.Type.LOAD)) {
-        return
-          text + type.name().toLowerCase() + " cargo onto voyage " + activity.voyage().voyageNumber() +
+      return
+        text + type.name().toLowerCase() + " cargo onto voyage " + activity.voyage().voyageNumber() +
           " in " + activity.location().name();
-      } else if (type.sameValueAs(HandlingEvent.Type.UNLOAD)) {
-        return
-          text + type.name().toLowerCase() + " cargo off of " + activity.voyage().voyageNumber() +
+    } else if (type.sameValueAs(HandlingEvent.Type.UNLOAD)) {
+      return
+        text + type.name().toLowerCase() + " cargo off of " + activity.voyage().voyageNumber() +
           " in " + activity.location().name();
-      } else {
-        return text + type.name().toLowerCase() + " cargo in " + activity.location().name();
-      }
+    } else {
+      return text + type.name().toLowerCase() + " cargo in " + activity.location().name();
+    }
   }
 
   /**
@@ -170,8 +170,8 @@ public final class CargoTrackingViewAdapter {
      * @return Time when the event was completed.
      */
     public String getTime() {
-		SimpleDateFormat dateFormat = new SimpleDateFormat(FORMAT);
-		dateFormat.setTimeZone(handlingEvent.location().timeZone());
+      SimpleDateFormat dateFormat = new SimpleDateFormat(FORMAT);
+      dateFormat.setTimeZone(handlingEvent.location().timeZone());
 
       return dateFormat.format(handlingEvent.completionTime());
     }
@@ -204,7 +204,7 @@ public final class CargoTrackingViewAdapter {
       switch (handlingEvent.type()) {
         case LOAD:
         case UNLOAD:
-          args = new Object[] {
+          args = new Object[]{
             handlingEvent.voyage().voyageNumber().idString(),
             handlingEvent.location().name(),
             handlingEvent.completionTime()
@@ -213,21 +213,21 @@ public final class CargoTrackingViewAdapter {
 
         case RECEIVE:
         case CLAIM:
-          args = new Object[] {
+          args = new Object[]{
             handlingEvent.location().name(),
             handlingEvent.completionTime()
           };
           break;
 
         default:
-          args = new Object[] {};
+          args = new Object[]{};
       }
 
       String key = "deliveryHistory.eventDescription." + handlingEvent.type().name();
 
-      return messageSource.getMessage(key,args,locale);
+      return messageSource.getMessage(key, args, locale);
     }
 
   }
-  
+
 }

dddsample/src/main/resources/context-application.xml

@@ -5,9 +5,10 @@
        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd">
 
   <bean id="bookingService" class="se.citerus.dddsample.application.impl.BookingServiceImpl">
+    <constructor-arg ref="cargoFactory"/>
+    <constructor-arg ref="routingService"/>
     <constructor-arg ref="cargoRepository"/>
     <constructor-arg ref="locationRepository"/>
-    <constructor-arg ref="routingService"/>
   </bean>
 
   <bean id="cargoInspectionService" class="se.citerus.dddsample.application.impl.CargoInspectionServiceImpl">

dddsample/src/main/resources/context-domain.xml

@@ -10,4 +10,9 @@
     <constructor-arg ref="locationRepository"/>
   </bean>
 
+  <bean id="cargoFactory" class="se.citerus.dddsample.domain.model.cargo.CargoFactory">
+    <constructor-arg ref="cargoRepository"/>
+    <constructor-arg ref="locationRepository"/>
+  </bean>
+
 </beans>

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

@@ -4,6 +4,7 @@ import junit.framework.TestCase;
 import static org.easymock.EasyMock.*;
 import se.citerus.dddsample.application.impl.BookingServiceImpl;
 import se.citerus.dddsample.domain.model.cargo.Cargo;
+import se.citerus.dddsample.domain.model.cargo.CargoFactory;
 import se.citerus.dddsample.domain.model.cargo.CargoRepository;
 import se.citerus.dddsample.domain.model.cargo.TrackingId;
 import se.citerus.dddsample.domain.model.location.LocationRepository;
@@ -25,7 +26,7 @@ public class BookingServiceTest extends TestCase {
     cargoRepository = createMock(CargoRepository.class);
     locationRepository = createMock(LocationRepository.class);
     routingService = createMock(RoutingService.class);
-    bookingService = new BookingServiceImpl(cargoRepository, locationRepository, routingService);
+    bookingService = new BookingServiceImpl(routingService, new CargoFactory(cargoRepository, locationRepository), cargoRepository, locationRepository);
   }
 
   public void testRegisterNew() {