PLANNER-383 @CustomShadowVariable sources parameter type changed for …

…consistency
kiegroup · Jul 1, 2016 · fe2fbcf · fe2fbcf
1 parent 4f3a69d
commit fe2fbcf
Show file tree

Hide file tree

Showing 15 changed files with 44 additions and 59 deletions.
diff --git a/...ner-core/src/main/java/org/optaplanner/core/api/domain/variable/CustomShadowVariable.java b/...ner-core/src/main/java/org/optaplanner/core/api/domain/variable/CustomShadowVariable.java
@@ -58,30 +58,6 @@ interface NullVariableListener extends VariableListener {}
      * The source variables (masters) that trigger a change to this shadow variable (slave).
      * @return never null (unless {@link #variableListenerRef()} is not null), at least 1
      */
-    Source[] sources() default {};
+    PlanningVariableReference[] sources() default {};
-
-    /**
-     * Declares which genuine variable (or other shadow variable) causes the shadow variable to change.
-     */
-    // TODO Replace with @PlanningVariableReference when upgrading to 7.0
-    public static @interface Source {
-
-        /**
-         * Specified if the source variable is on a different {@link Class} than the shadow variable.
-         * @return {@link NullEntityClass} when it is null (workaround for annotation limitation).
-         * Defaults to the same {@link Class} as the one that contains the {@link CustomShadowVariable} annotation.
-         */
-        Class<?> entityClass() default NullEntityClass.class;
-
-        /** Workaround for annotation limitation in {@link #entityClass()}. */
-        interface NullEntityClass {}
-
-        /**
-         * A source variable that causes the shadow variable to change.
-         * @return never null, a genuine or shadow variable
-         */
-        String variableName();
-
-    }
 
 }
diff --git a/...java/org/optaplanner/core/impl/domain/variable/custom/CustomShadowVariableDescriptor.java b/...java/org/optaplanner/core/impl/domain/variable/custom/CustomShadowVariableDescriptor.java
@@ -65,7 +65,7 @@ private void processPropertyAnnotations(DescriptorPolicy descriptorPolicy) {
         if (variableListenerClass == CustomShadowVariable.NullVariableListener.class) {
             variableListenerClass = null;
         }
-        CustomShadowVariable.Source[] sources = shadowVariableAnnotation.sources();
+        PlanningVariableReference[] sources = shadowVariableAnnotation.sources();
         if (variableListenerRef != null) {
             if (variableListenerClass != null || sources.length > 0) {
                 throw new IllegalArgumentException("The entityClass (" + entityDescriptor.getEntityClass()
@@ -147,12 +147,12 @@ public void linkShadowSources(DescriptorPolicy descriptorPolicy) {
             }
             refVariableDescriptor.registerSinkVariableDescriptor(this);
         } else {
-            CustomShadowVariable.Source[] sources = shadowVariableAnnotation.sources();
+            PlanningVariableReference[] sources = shadowVariableAnnotation.sources();
             sourceVariableDescriptorList = new ArrayList<>(sources.length);
-            for (CustomShadowVariable.Source source : sources) {
+            for (PlanningVariableReference source : sources) {
                 EntityDescriptor<Solution_> sourceEntityDescriptor;
                 Class<?> sourceEntityClass = source.entityClass();
-                if (sourceEntityClass.equals(CustomShadowVariable.Source.NullEntityClass.class)) {
+                if (sourceEntityClass.equals(PlanningVariableReference.NullEntityClass.class)) {
                     sourceEntityDescriptor = entityDescriptor;
                 } else {
                     sourceEntityDescriptor = entityDescriptor.getSolutionDescriptor()

diff --git a/...planner/core/impl/testdata/domain/shadow/cyclic/TestdataSevenNonCyclicShadowedEntity.java b/...planner/core/impl/testdata/domain/shadow/cyclic/TestdataSevenNonCyclicShadowedEntity.java
@@ -19,6 +19,7 @@
 import org.optaplanner.core.api.domain.entity.PlanningEntity;
 import org.optaplanner.core.api.domain.variable.CustomShadowVariable;
 import org.optaplanner.core.api.domain.variable.PlanningVariable;
+import org.optaplanner.core.api.domain.variable.PlanningVariableReference;
 import org.optaplanner.core.impl.domain.entity.descriptor.EntityDescriptor;
 import org.optaplanner.core.impl.domain.solution.descriptor.SolutionDescriptor;
 import org.optaplanner.core.impl.domain.variable.descriptor.GenuineVariableDescriptor;
@@ -72,7 +73,7 @@ public void setValue(TestdataValue value) {
     }
 
     @CustomShadowVariable(variableListenerClass = VariableListenerAdapter.class,
-            sources = {@CustomShadowVariable.Source(variableName = "secondShadow")})
+            sources = {@PlanningVariableReference(variableName = "secondShadow")})
     public String getThirdShadow() {
         return thirdShadow;
     }
@@ -82,7 +83,7 @@ public void setThirdShadow(String thirdShadow) {
     }
 
     @CustomShadowVariable(variableListenerClass = VariableListenerAdapter.class,
-            sources = {@CustomShadowVariable.Source(variableName = "fourthShadow")})
+            sources = {@PlanningVariableReference(variableName = "fourthShadow")})
     public String getFifthShadow() {
         return fifthShadow;
     }
@@ -92,7 +93,7 @@ public void setFifthShadow(String fifthShadow) {
     }
 
     @CustomShadowVariable(variableListenerClass = VariableListenerAdapter.class,
-            sources = {@CustomShadowVariable.Source(variableName = "value")})
+            sources = {@PlanningVariableReference(variableName = "value")})
     public String getFirstShadow() {
         return firstShadow;
     }
@@ -102,7 +103,7 @@ public void setFirstShadow(String firstShadow) {
     }
 
     @CustomShadowVariable(variableListenerClass = VariableListenerAdapter.class,
-            sources = {@CustomShadowVariable.Source(variableName = "thirdShadow")})
+            sources = {@PlanningVariableReference(variableName = "thirdShadow")})
     public String getFourthShadow() {
         return fourthShadow;
     }
@@ -112,7 +113,7 @@ public void setFourthShadow(String fourthShadow) {
     }
 
     @CustomShadowVariable(variableListenerClass = VariableListenerAdapter.class,
-            sources = {@CustomShadowVariable.Source(variableName = "firstShadow")})
+            sources = {@PlanningVariableReference(variableName = "firstShadow")})
     public String getSecondShadow() {
         return secondShadow;
     }
@@ -122,7 +123,7 @@ public void setSecondShadow(String secondShadow) {
     }
 
     @CustomShadowVariable(variableListenerClass = VariableListenerAdapter.class,
-            sources = {@CustomShadowVariable.Source(variableName = "sixthShadow")})
+            sources = {@PlanningVariableReference(variableName = "sixthShadow")})
     public String getSeventhShadow() {
         return seventhShadow;
     }
@@ -132,7 +133,7 @@ public void setSeventhShadow(String seventhShadow) {
     }
 
     @CustomShadowVariable(variableListenerClass = VariableListenerAdapter.class,
-            sources = {@CustomShadowVariable.Source(variableName = "fifthShadow")})
+            sources = {@PlanningVariableReference(variableName = "fifthShadow")})
     public String getSixthShadow() {
         return sixthShadow;
     }

diff --git a/...re/impl/testdata/domain/shadow/cyclic/invalid/TestdataCyclicReferencedShadowedEntity.java b/...re/impl/testdata/domain/shadow/cyclic/invalid/TestdataCyclicReferencedShadowedEntity.java
@@ -68,8 +68,8 @@ public void setValue(TestdataValue value) {
     }
 
     @CustomShadowVariable(variableListenerClass = BarberAndCutsOwnHairUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(variableName = "value"),
+            sources = {@PlanningVariableReference(variableName = "value"),
-                    @CustomShadowVariable.Source(variableName = "cutsOwnHair")})
+                    @PlanningVariableReference(variableName = "cutsOwnHair")})
     public boolean isBarber() {
         return barber;
     }

diff --git a/...planner/core/impl/testdata/domain/shadow/cyclic/invalid/TestdataCyclicShadowedEntity.java b/...planner/core/impl/testdata/domain/shadow/cyclic/invalid/TestdataCyclicShadowedEntity.java
@@ -19,6 +19,7 @@
 import org.optaplanner.core.api.domain.entity.PlanningEntity;
 import org.optaplanner.core.api.domain.variable.CustomShadowVariable;
 import org.optaplanner.core.api.domain.variable.PlanningVariable;
+import org.optaplanner.core.api.domain.variable.PlanningVariableReference;
 import org.optaplanner.core.impl.domain.entity.descriptor.EntityDescriptor;
 import org.optaplanner.core.impl.domain.solution.descriptor.SolutionDescriptor;
 import org.optaplanner.core.impl.domain.variable.descriptor.GenuineVariableDescriptor;
@@ -68,7 +69,7 @@ public void setValue(TestdataValue value) {
     }
 
     @CustomShadowVariable(variableListenerClass = RockShadowUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(variableName = "scissorsShadow")})
+            sources = {@PlanningVariableReference(variableName = "scissorsShadow")})
     public String getRockShadow() {
         return rockShadow;
     }
@@ -78,7 +79,7 @@ public void setRockShadow(String rockShadow) {
     }
 
     @CustomShadowVariable(variableListenerClass = PaperShadowUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(variableName = "rockShadow")})
+            sources = {@PlanningVariableReference(variableName = "rockShadow")})
     public String getPaperShadow() {
         return paperShadow;
     }
@@ -88,7 +89,7 @@ public void setPaperShadow(String paperShadow) {
     }
 
     @CustomShadowVariable(variableListenerClass = ScissorsShadowUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(variableName = "paperShadow")})
+            sources = {@PlanningVariableReference(variableName = "paperShadow")})
     public String getScissorsShadow() {
         return scissorsShadow;
     }

diff --git a/...lanner/core/impl/testdata/domain/shadow/extended/TestdataExtendedShadowedChildEntity.java b/...lanner/core/impl/testdata/domain/shadow/extended/TestdataExtendedShadowedChildEntity.java
@@ -18,6 +18,7 @@
 
 import org.optaplanner.core.api.domain.entity.PlanningEntity;
 import org.optaplanner.core.api.domain.variable.CustomShadowVariable;
+import org.optaplanner.core.api.domain.variable.PlanningVariableReference;
 import org.optaplanner.core.impl.domain.entity.descriptor.EntityDescriptor;
 import org.optaplanner.core.impl.domain.solution.descriptor.SolutionDescriptor;
 import org.optaplanner.core.impl.domain.variable.listener.VariableListenerAdapter;
@@ -46,7 +47,7 @@ public TestdataExtendedShadowedChildEntity(String code, TestdataValue value) {
     }
 
     @CustomShadowVariable(variableListenerClass = SecondShadowUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(variableName = "firstShadow")})
+            sources = {@PlanningVariableReference(variableName = "firstShadow")})
     public String getSecondShadow() {
         return secondShadow;
     }

diff --git a/...anner/core/impl/testdata/domain/shadow/extended/TestdataExtendedShadowedParentEntity.java b/...anner/core/impl/testdata/domain/shadow/extended/TestdataExtendedShadowedParentEntity.java
@@ -19,6 +19,7 @@
 import org.optaplanner.core.api.domain.entity.PlanningEntity;
 import org.optaplanner.core.api.domain.variable.CustomShadowVariable;
 import org.optaplanner.core.api.domain.variable.PlanningVariable;
+import org.optaplanner.core.api.domain.variable.PlanningVariableReference;
 import org.optaplanner.core.impl.domain.entity.descriptor.EntityDescriptor;
 import org.optaplanner.core.impl.domain.solution.descriptor.SolutionDescriptor;
 import org.optaplanner.core.impl.domain.variable.descriptor.GenuineVariableDescriptor;
@@ -67,7 +68,7 @@ public void setValue(TestdataValue value) {
     }
 
     @CustomShadowVariable(variableListenerClass = FirstShadowUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(variableName = "value")})
+            sources = {@PlanningVariableReference(variableName = "value")})
     public String getFirstShadow() {
         return firstShadow;
     }
@@ -77,7 +78,7 @@ public void setFirstShadow(String firstShadow) {
     }
 
     @CustomShadowVariable(variableListenerClass = ThirdShadowUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(
+            sources = {@PlanningVariableReference(
                     entityClass = TestdataExtendedShadowedChildEntity.class, variableName = "secondShadow")})
     public String getThirdShadow() {
         return thirdShadow;

diff --git a/...planner/core/impl/testdata/domain/shadow/manytomany/TestdataManyToManyShadowedEntity.java b/...planner/core/impl/testdata/domain/shadow/manytomany/TestdataManyToManyShadowedEntity.java
@@ -72,8 +72,8 @@ public void setSecondaryValue(TestdataValue secondaryValue) {
     }
 
     @CustomShadowVariable(variableListenerClass = ComposedValuesUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(variableName = "primaryValue"),
+            sources = {@PlanningVariableReference(variableName = "primaryValue"),
-                    @CustomShadowVariable.Source(variableName = "secondaryValue")})
+                    @PlanningVariableReference(variableName = "secondaryValue")})
     public String getComposedCode() {
         return composedCode;
     }

diff --git a/...cs/src/main/docbook/en-US/Chapter-Planner_configuration/Chapter-Planner_configuration.xml b/...cs/src/main/docbook/en-US/Chapter-Planner_configuration/Chapter-Planner_configuration.xml
@@ -1287,7 +1287,7 @@ public class Customer {
     }
 
     @CustomShadowVariable(variableListenerClass = VehicleUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(variableName = "previousStandstill")})
+            sources = {@PlanningVariableReference(variableName = "previousStandstill")})
     public Vehicle getVehicle() {
         return vehicle;
     }</programlisting>
@@ -1297,7 +1297,7 @@ public class Customer {
 
         <note>
           <para>If the class of the trigger variable is different than the shadow variable, also specify the
-          <literal>entityClass</literal> on <literal>@CustomShadowVariable.Source</literal>. In that case, make sure
+          <literal>entityClass</literal> on <literal>@PlanningVariableReference</literal>. In that case, make sure
           that that <literal>entityClass</literal> is also properly configured as a planning entity class in the solver
           config, or the <literal>VariableListener</literal> will simply never trigger.</para>
         </note>
@@ -1352,7 +1352,7 @@ public class Customer {
     }
 
     @CustomShadowVariable(variableListenerClass = TransportTimeAndCapacityUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(variableName = "previousStandstill")})
+            sources = {@PlanningVariableReference(variableName = "previousStandstill")})
     public Integer getTransportTime() {
         return transportTime;
     }

diff --git a/...examples/src/main/java/org/optaplanner/examples/coachshuttlegathering/domain/BusStop.java b/...examples/src/main/java/org/optaplanner/examples/coachshuttlegathering/domain/BusStop.java
@@ -24,6 +24,7 @@
 import org.optaplanner.core.api.domain.variable.CustomShadowVariable;
 import org.optaplanner.core.api.domain.variable.PlanningVariable;
 import org.optaplanner.core.api.domain.variable.PlanningVariableGraphType;
+import org.optaplanner.core.api.domain.variable.PlanningVariableReference;
 import org.optaplanner.examples.coachshuttlegathering.domain.location.RoadLocation;
 import org.optaplanner.examples.coachshuttlegathering.domain.solver.DepotAngleBusStopDifficultyWeightFactory;
 import org.optaplanner.examples.coachshuttlegathering.domain.solver.TransportTimeToHubUpdatingVariableListener;
@@ -122,9 +123,9 @@ public void setTransferShuttleList(List<Shuttle> transferShuttleList) {
     }
 
     @CustomShadowVariable(variableListenerClass = TransportTimeToHubUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(variableName = "nextStop"),
+            sources = {@PlanningVariableReference(variableName = "nextStop"),
-                    @CustomShadowVariable.Source(variableName = "bus"),
+                    @PlanningVariableReference(variableName = "bus"),
-                    @CustomShadowVariable.Source(entityClass = Shuttle.class, variableName = "destination")})
+                    @PlanningVariableReference(entityClass = Shuttle.class, variableName = "destination")})
     @Override
     public Integer getTransportTimeToHub() {
         return transportTimeToHub;

diff --git a/...ner-examples/src/main/java/org/optaplanner/examples/examination/domain/FollowingExam.java b/...ner-examples/src/main/java/org/optaplanner/examples/examination/domain/FollowingExam.java
@@ -19,6 +19,7 @@
 import com.thoughtworks.xstream.annotations.XStreamAlias;
 import org.optaplanner.core.api.domain.entity.PlanningEntity;
 import org.optaplanner.core.api.domain.variable.CustomShadowVariable;
+import org.optaplanner.core.api.domain.variable.PlanningVariableReference;
 import org.optaplanner.examples.examination.domain.solver.PeriodUpdatingVariableListener;
 
 @PlanningEntity
@@ -40,7 +41,7 @@ public void setLeadingExam(LeadingExam leadingExam) {
 
     @Override
     @CustomShadowVariable(variableListenerClass = PeriodUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(entityClass = LeadingExam.class, variableName = "period")})
+            sources = {@PlanningVariableReference(entityClass = LeadingExam.class, variableName = "period")})
     public Period getPeriod() {
         return period;
     }

diff --git a/...amples/src/main/java/org/optaplanner/examples/projectjobscheduling/domain/Allocation.java b/...amples/src/main/java/org/optaplanner/examples/projectjobscheduling/domain/Allocation.java
@@ -25,6 +25,7 @@
 import org.optaplanner.core.api.domain.valuerange.ValueRangeProvider;
 import org.optaplanner.core.api.domain.variable.CustomShadowVariable;
 import org.optaplanner.core.api.domain.variable.PlanningVariable;
+import org.optaplanner.core.api.domain.variable.PlanningVariableReference;
 import org.optaplanner.examples.common.domain.AbstractPersistable;
 import org.optaplanner.examples.projectjobscheduling.domain.solver.DelayStrengthComparator;
 import org.optaplanner.examples.projectjobscheduling.domain.solver.ExecutionModeStrengthWeightFactory;
@@ -110,8 +111,8 @@ public void setDelay(Integer delay) {
     }
 
     @CustomShadowVariable(variableListenerClass = PredecessorsDoneDateUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(variableName = "executionMode"),
+            sources = {@PlanningVariableReference(variableName = "executionMode"),
-                    @CustomShadowVariable.Source(variableName = "delay")})
+                    @PlanningVariableReference(variableName = "delay")})
     public Integer getPredecessorsDoneDate() {
         return predecessorsDoneDate;
     }

diff --git a/...planner-examples/src/main/java/org/optaplanner/examples/scrabble/domain/ScrabbleCell.java b/...planner-examples/src/main/java/org/optaplanner/examples/scrabble/domain/ScrabbleCell.java
@@ -35,8 +35,8 @@ public class ScrabbleCell extends AbstractPersistable {
     private int y;
 
     @CustomShadowVariable(variableListenerClass = CellUpdatingVariableListener.class,
-            sources = {@CustomShadowVariable.Source(entityClass = ScrabbleWordAssignment.class, variableName = "startCell"),
+            sources = {@PlanningVariableReference(entityClass = ScrabbleWordAssignment.class, variableName = "startCell"),
-                    @CustomShadowVariable.Source(entityClass = ScrabbleWordAssignment.class, variableName = "direction"),})
+                    @PlanningVariableReference(entityClass = ScrabbleWordAssignment.class, variableName = "direction"),})
     @DeepPlanningClone // TODO Why is this needed? This is already a shadow var
     private Set<ScrabbleWordAssignment> wordSet;
 

diff --git a/optaplanner-examples/src/main/java/org/optaplanner/examples/taskassigning/domain/Task.java b/optaplanner-examples/src/main/java/org/optaplanner/examples/taskassigning/domain/Task.java
@@ -24,6 +24,7 @@
 import org.optaplanner.core.api.domain.variable.CustomShadowVariable;
 import org.optaplanner.core.api.domain.variable.PlanningVariable;
 import org.optaplanner.core.api.domain.variable.PlanningVariableGraphType;
+import org.optaplanner.core.api.domain.variable.PlanningVariableReference;
 import org.optaplanner.examples.common.swingui.components.Labeled;
 import org.optaplanner.examples.taskassigning.domain.solver.MovableTaskSelectionFilter;
 import org.optaplanner.examples.taskassigning.domain.solver.StartTimeUpdatingVariableListener;
@@ -53,7 +54,7 @@ public class Task extends TaskOrEmployee implements Labeled {
     @CustomShadowVariable(variableListenerClass = StartTimeUpdatingVariableListener.class,
             // Arguable, to adhere to API specs (although this works), nextTask and employee should also be a source,
             // because this shadow must be triggered after nextTask and employee (but there is no need to be triggered by those)
-            sources = {@CustomShadowVariable.Source(variableName = "previousTaskOrEmployee")})
+            sources = {@PlanningVariableReference(variableName = "previousTaskOrEmployee")})
     private Integer startTime; // In minutes
 
     public TaskType getTaskType() {

diff --git a/...ava/org/optaplanner/examples/vehiclerouting/domain/timewindowed/TimeWindowedCustomer.java b/...ava/org/optaplanner/examples/vehiclerouting/domain/timewindowed/TimeWindowedCustomer.java
@@ -19,6 +19,7 @@
 import com.thoughtworks.xstream.annotations.XStreamAlias;
 import org.optaplanner.core.api.domain.entity.PlanningEntity;
 import org.optaplanner.core.api.domain.variable.CustomShadowVariable;
+import org.optaplanner.core.api.domain.variable.PlanningVariableReference;
 import org.optaplanner.examples.vehiclerouting.domain.Customer;
 import org.optaplanner.examples.vehiclerouting.domain.timewindowed.solver.ArrivalTimeUpdatingVariableListener;
 
@@ -73,7 +74,7 @@ public void setServiceDuration(long serviceDuration) {
     @CustomShadowVariable(variableListenerClass = ArrivalTimeUpdatingVariableListener.class,
             // Arguable, to adhere to API specs (although this works), nextCustomer should also be a source,
             // because this shadow must be triggered after nextCustomer (but there is no need to be triggered by nextCustomer)
-            sources = {@CustomShadowVariable.Source(variableName = "previousStandstill")})
+            sources = {@PlanningVariableReference(variableName = "previousStandstill")})
     public Long getArrivalTime() {
         return arrivalTime;
     }