Merge pull request graphhopper#348 from balage1541/master

graphhopper#347 - Custom properties

Author: oblonski

jsprit-core/src/main/java/com/graphhopper/jsprit/core/problem/AbstractJob.java

@@ -26,7 +26,9 @@
 public abstract class AbstractJob implements Job {
 
     private int index;
+    private Object userData;
 
+    @Override
     public int getIndex() {
         return index;
     }
@@ -35,4 +37,15 @@ protected void setIndex(int index) {
         this.index = index;
     }
 
+    /**
+     * @return User-specific domain data associated by the job
+     */
+    public Object getUserData() {
+        return userData;
+    }
+
+    protected void setUserData(Object userData) {
+        this.userData = userData;
+    }
+
 }

jsprit-core/src/main/java/com/graphhopper/jsprit/core/problem/AbstractVehicle.java

@@ -30,6 +30,7 @@ public abstract static class AbstractTypeKey implements HasIndex {
 
         private int index;
 
+        @Override
         public int getIndex() {
             return index;
         }
@@ -44,19 +45,35 @@ public void setIndex(int index) {
 
     private VehicleTypeKey vehicleIdentifier;
 
-    public int getIndex() {
-        return index;
-    }
+	private Object userData;
 
-    protected void setIndex(int index) {
-        this.index = index;
-    }
+	/**
+	 * @return User-specific domain data associated with the vehicle
+	 */
+	@Override
+    public Object getUserData() {
+		return userData;
+	}
 
-    public VehicleTypeKey getVehicleTypeIdentifier() {
-        return vehicleIdentifier;
-    }
+	protected void setUserData(Object userData) {
+		this.userData = userData;
+	}
 
-    protected void setVehicleIdentifier(VehicleTypeKey vehicleTypeIdentifier) {
-        this.vehicleIdentifier = vehicleTypeIdentifier;
-    }
+	@Override
+	public int getIndex() {
+		return index;
+	}
+
+	protected void setIndex(int index) {
+		this.index = index;
+	}
+
+	@Override
+	public VehicleTypeKey getVehicleTypeIdentifier() {
+		return vehicleIdentifier;
+	}
+
+	protected void setVehicleIdentifier(VehicleTypeKey vehicleTypeIdentifier) {
+		this.vehicleIdentifier = vehicleTypeIdentifier;
+	}
 }

jsprit-core/src/main/java/com/graphhopper/jsprit/core/problem/Location.java

@@ -66,10 +66,30 @@ public static class Builder {
 
         private String name = "";
 
+        private Object userData;
+
         public static Builder newInstance() {
             return new Builder();
         }
 
+        /**
+         * Sets user specific domain data associated with the object.
+         *
+         * <p>
+         * The user data is a black box for the framework, it only stores it,
+         * but never interacts with it in any way.
+         * </p>
+         *
+         * @param userData
+         *            any object holding the domain specific user data
+         *            associated with the object.
+         * @return builder
+         */
+        public Builder setUserData(Object userData) {
+            this.userData = userData;
+            return this;
+        }
+
         /**
          * Sets location index
          *
@@ -140,13 +160,23 @@ public Location build() {
 
     private final String name;
 
+    private Object userData;
+
     private Location(Builder builder) {
+        this.userData = builder.userData;
         this.index = builder.index;
         this.coordinate = builder.coordinate;
         this.id = builder.id;
         this.name = builder.name;
     }
 
+    /**
+     * @return User-specific domain data associated by the job
+     */
+    public Object getUserData() {
+        return userData;
+    }
+
     @Override
     public String getId() {
         return id;

jsprit-core/src/main/java/com/graphhopper/jsprit/core/problem/job/Service.java

@@ -17,6 +17,8 @@
  */
 package com.graphhopper.jsprit.core.problem.job;
 
+import java.util.Collection;
+
 import com.graphhopper.jsprit.core.problem.AbstractJob;
 import com.graphhopper.jsprit.core.problem.Capacity;
 import com.graphhopper.jsprit.core.problem.Location;
@@ -26,8 +28,6 @@
 import com.graphhopper.jsprit.core.problem.solution.route.activity.TimeWindowsImpl;
 import com.graphhopper.jsprit.core.util.Coordinate;
 
-import java.util.Collection;
-
 /**
  * Service implementation of a job.
  * <p>
@@ -86,15 +86,16 @@ public static Builder newInstance(String id) {
 
         protected TimeWindowsImpl timeWindows;
 
-		private boolean twAdded = false;
+        private boolean twAdded = false;
 
         private int priority = 2;
+        protected Object userData;
 
-		Builder(String id){
-			this.id = id;
-			timeWindows = new TimeWindowsImpl();
-			timeWindows.add(timeWindow);
-		}
+        Builder(String id){
+            this.id = id;
+            timeWindows = new TimeWindowsImpl();
+            timeWindows.add(timeWindow);
+        }
 
         /**
          * Protected method to set the type-name of the service.
@@ -137,6 +138,24 @@ public Builder<T> setServiceTime(double serviceTime) {
             return this;
         }
 
+        /**
+         * Sets user specific domain data associated with the object.
+         *
+         * <p>
+         * The user data is a black box for the framework, it only stores it,
+         * but never interacts with it in any way.
+         * </p>
+         *
+         * @param userData
+         *            any object holding the domain specific user data
+         *            associated with the object.
+         * @return builder
+         */
+        public Builder<T> setUserData(Object userData) {
+            this.userData = userData;
+            return this;
+        }
+
         /**
          * Adds capacity dimension.
          *
@@ -247,7 +266,8 @@ public Builder<T> setPriority(int priority) {
 
     private final int priority;
 
-    Service(Builder builder) {
+    Service(Builder<?> builder) {
+        setUserData(builder.userData);
         id = builder.id;
         serviceTime = builder.serviceTime;
         timeWindow = builder.timeWindow;
@@ -256,13 +276,13 @@ public Builder<T> setPriority(int priority) {
         skills = builder.skills;
         name = builder.name;
         location = builder.location;
-		timeWindowManager = builder.timeWindows;
+        timeWindowManager = builder.timeWindows;
         priority = builder.priority;
-	}
+    }
 
-	public Collection<TimeWindow> getTimeWindows(){
-		return timeWindowManager.getTimeWindows();
-	}
+    public Collection<TimeWindow> getTimeWindows(){
+        return timeWindowManager.getTimeWindows();
+    }
 
     @Override
     public String getId() {
@@ -367,6 +387,7 @@ public String getName() {
      *
      * @return priority
      */
+    @Override
     public int getPriority() {
         return priority;
     }

jsprit-core/src/main/java/com/graphhopper/jsprit/core/problem/job/Shipment.java

@@ -17,15 +17,15 @@
  */
 package com.graphhopper.jsprit.core.problem.job;
 
+import java.util.Collection;
+
 import com.graphhopper.jsprit.core.problem.AbstractJob;
 import com.graphhopper.jsprit.core.problem.Capacity;
 import com.graphhopper.jsprit.core.problem.Location;
 import com.graphhopper.jsprit.core.problem.Skills;
 import com.graphhopper.jsprit.core.problem.solution.route.activity.TimeWindow;
 import com.graphhopper.jsprit.core.problem.solution.route.activity.TimeWindowsImpl;
 
-import java.util.Collection;
-
 
 /**
  * Shipment is an implementation of Job and consists of a pickup and a delivery of something.
@@ -89,6 +89,8 @@ public static class Builder {
 
         private int priority = 2;
 
+        public Object userData;
+
         /**
          * Returns new instance of this builder.
          *
@@ -108,10 +110,29 @@ public static Builder newInstance(String id) {
             deliveryTimeWindows.add(deliveryTimeWindow);
         }
 
+        /**
+         * Sets user specific domain data associated with the object.
+         *
+         * <p>
+         * The user data is a black box for the framework, it only stores it,
+         * but never interacts with it in any way.
+         * </p>
+         *
+         * @param userData
+         *            any object holding the domain specific user data
+         *            associated with the object.
+         * @return builder
+         */
+        public Builder setUserData(Object userData) {
+            this.userData = userData;
+            return this;
+        }
+
         /**
          * Sets pickup location.
          *
-         * @param pickupLocation pickup location
+         * @param pickupLocation
+         *            pickup location
          * @return builder
          */
         public Builder setPickupLocation(Location pickupLocation) {
@@ -311,6 +332,7 @@ public Builder setPriority(int priority) {
     private final int priority;
 
     Shipment(Builder builder) {
+        setUserData(builder.userData);
         this.id = builder.id;
         this.pickupServiceTime = builder.pickupServiceTime;
         this.pickupTimeWindow = builder.pickupTimeWindow;
@@ -438,6 +460,7 @@ public String getName() {
      *
      * @return priority
      */
+    @Override
     public int getPriority() {
         return priority;
     }

jsprit-core/src/main/java/com/graphhopper/jsprit/core/problem/vehicle/Vehicle.java

@@ -72,6 +72,14 @@ public interface Vehicle extends HasId, HasIndex {
     public abstract VehicleTypeKey getVehicleTypeIdentifier();
 
     public abstract Skills getSkills();
+	/**
+	 * @return User-specific domain data associated with the vehicle
+	 */
+	public Object getUserData();
 
     public abstract Break getBreak();
+	// Switch to this as soon as we switct to Java 8:
+	// default Object getUserData() {
+	// return null;
+	// };
 }