Skip to content

fix: fail-fast on @PlanningEntity being used in a @ProblemFactCollectionProperty #1646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Christopher-Chianelli merged 2 commits into from
Jun 12, 2025
Merged

fix: fail-fast on @PlanningEntity being used in a @ProblemFactCollectionProperty #1646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bb6b28
fix: fail-fast on @PlanningEntity being used in a @ProblemFactCollect…
Christopher-Chianelli Jun 12, 2025
9f31aac
test: Add test for array problem fact collection
Christopher-Chianelli Jun 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion ...main/java/ai/timefold/solver/core/impl/domain/solution/descriptor/SolutionDescriptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,14 @@ private void processProblemFactPropertyAnnotation(DescriptorPolicy descriptorPol
Collection.class.getSimpleName()));
}
problemFactCollectionMemberAccessorMap.put(memberAccessor.getName(), memberAccessor);
problemFactType = type;

Comment thread
Christopher-Chianelli marked this conversation as resolved.
if (type.isArray()) {
Comment thread
Christopher-Chianelli marked this conversation as resolved.
problemFactType = type.getComponentType();
} else {
problemFactType = ConfigUtils.extractGenericTypeParameterOrFail(PlanningSolution.class.getSimpleName(),
memberAccessor.getDeclaringClass(),
type, memberAccessor.getGenericType(), annotationClass, memberAccessor.getName());
}
} else {
throw new IllegalStateException("Impossible situation with annotationClass (" + annotationClass + ").");
}
Expand Down
11 changes: 10 additions & 1 deletion .../java/ai/timefold/solver/core/impl/domain/solution/descriptor/SolutionDescriptorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
import ai.timefold.solver.core.testdomain.invalid.constraintconfiguration.TestdataInvalidConfigurationSolution;
import ai.timefold.solver.core.testdomain.invalid.constraintweightoverrides.TestdataInvalidConstraintWeightOverridesSolution;
import ai.timefold.solver.core.testdomain.invalid.duplicateweightoverrides.TestdataDuplicateWeightConfigurationSolution;
import ai.timefold.solver.core.testdomain.invalid.entityannotatedasproblemfact.TestdataEntityAnnotatedAsProblemFactArraySolution;
import ai.timefold.solver.core.testdomain.invalid.entityannotatedasproblemfact.TestdataEntityAnnotatedAsProblemFactCollectionSolution;
import ai.timefold.solver.core.testdomain.invalid.entityannotatedasproblemfact.TestdataEntityAnnotatedAsProblemFactSolution;
import ai.timefold.solver.core.testdomain.invalid.multivar.TestdataInvalidMultiVarSolution;
import ai.timefold.solver.core.testdomain.invalid.nosolution.TestdataNoSolution;
Expand Down Expand Up @@ -134,7 +136,14 @@ void planningEntityIsProblemFactProperty() {

@Test
void planningEntityIsProblemFactCollectionProperty() {
assertThatIllegalStateException().isThrownBy(TestdataEntityAnnotatedAsProblemFactSolution::buildSolutionDescriptor);
assertThatIllegalStateException()
.isThrownBy(TestdataEntityAnnotatedAsProblemFactCollectionSolution::buildSolutionDescriptor);
}

@Test
void planningEntityIsProblemFactArrayProperty() {
assertThatIllegalStateException()
.isThrownBy(TestdataEntityAnnotatedAsProblemFactArraySolution::buildSolutionDescriptor);
}

@Test
Expand Down
58 changes: 58 additions & 0 deletions ...valid/entityannotatedasproblemfact/TestdataEntityAnnotatedAsProblemFactArraySolution.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
package ai.timefold.solver.core.testdomain.invalid.entityannotatedasproblemfact;

import ai.timefold.solver.core.api.domain.solution.PlanningEntityCollectionProperty;
import ai.timefold.solver.core.api.domain.solution.PlanningScore;
import ai.timefold.solver.core.api.domain.solution.PlanningSolution;
import ai.timefold.solver.core.api.domain.solution.ProblemFactCollectionProperty;
import ai.timefold.solver.core.api.domain.valuerange.ValueRangeProvider;
import ai.timefold.solver.core.api.score.buildin.simple.SimpleScore;
import ai.timefold.solver.core.impl.domain.solution.descriptor.SolutionDescriptor;
import ai.timefold.solver.core.testdomain.TestdataEntity;
import ai.timefold.solver.core.testdomain.TestdataValue;

@PlanningSolution
public class TestdataEntityAnnotatedAsProblemFactArraySolution {
TestdataEntity[] entities;
TestdataValue[] values;
SimpleScore score;

public static SolutionDescriptor<TestdataEntityAnnotatedAsProblemFactArraySolution> buildSolutionDescriptor() {
return SolutionDescriptor.buildSolutionDescriptor(TestdataEntityAnnotatedAsProblemFactArraySolution.class,
TestdataEntity.class);
}

public TestdataEntityAnnotatedAsProblemFactArraySolution() {
}

@ProblemFactCollectionProperty
public TestdataEntity[] getEntitiesAsFacts() {
return entities;
}

@PlanningEntityCollectionProperty
public TestdataEntity[] getEntities() {
return entities;
}

public void setEntities(TestdataEntity[] entities) {
this.entities = entities;
}

@ValueRangeProvider(id = "valueRange")
public TestdataValue[] getValues() {
return values;
}

public void setValues(TestdataValue[] values) {
this.values = values;
}

@PlanningScore
public SimpleScore getScore() {
return score;
}

public void setScore(SimpleScore score) {
this.score = score;
}
}
8 changes: 8 additions & 0 deletions .../entityannotatedasproblemfact/TestdataEntityAnnotatedAsProblemFactCollectionSolution.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

import java.util.List;

import ai.timefold.solver.core.api.domain.solution.PlanningEntityCollectionProperty;
import ai.timefold.solver.core.api.domain.solution.PlanningScore;
import ai.timefold.solver.core.api.domain.solution.PlanningSolution;
import ai.timefold.solver.core.api.domain.solution.ProblemFactCollectionProperty;
import ai.timefold.solver.core.api.domain.valuerange.ValueRangeProvider;
Expand All @@ -25,6 +27,11 @@ public TestdataEntityAnnotatedAsProblemFactCollectionSolution() {
}

@ProblemFactCollectionProperty
public List<TestdataEntity> getEntitiesAsFacts() {
return entities;
}

@PlanningEntityCollectionProperty
Comment thread
Christopher-Chianelli marked this conversation as resolved.
public List<TestdataEntity> getEntities() {
return entities;
}
Expand All @@ -42,6 +49,7 @@ public void setValues(List<TestdataValue> values) {
this.values = values;
}

@PlanningScore
public SimpleScore getScore() {
return score;
}
Expand Down
10 changes: 9 additions & 1 deletion ...in/invalid/entityannotatedasproblemfact/TestdataEntityAnnotatedAsProblemFactSolution.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

import java.util.List;

import ai.timefold.solver.core.api.domain.solution.PlanningEntityProperty;
import ai.timefold.solver.core.api.domain.solution.PlanningScore;
import ai.timefold.solver.core.api.domain.solution.PlanningSolution;
import ai.timefold.solver.core.api.domain.solution.ProblemFactProperty;
import ai.timefold.solver.core.api.domain.valuerange.ValueRangeProvider;
Expand All @@ -24,11 +26,16 @@ public static SolutionDescriptor<TestdataEntityAnnotatedAsProblemFactSolution> b
public TestdataEntityAnnotatedAsProblemFactSolution() {
}

@ProblemFactProperty
@PlanningEntityProperty
Comment thread
Christopher-Chianelli marked this conversation as resolved.
public TestdataEntity getEntity() {
return entity;
}

@ProblemFactProperty
public TestdataEntity getEntityAsFact() {
return entity;
}

public void setEntity(TestdataEntity entity) {
this.entity = entity;
}
Expand All @@ -42,6 +49,7 @@ public void setValues(List<TestdataValue> values) {
this.values = values;
}

@PlanningScore
public SimpleScore getScore() {
return score;
}
Expand Down
3 changes: 1 addition & 2 deletions ...mefold/solver/core/testdomain/shadow/inverserelation/TestdataInverseRelationSolution.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
import ai.timefold.solver.core.api.domain.solution.PlanningEntityCollectionProperty;
import ai.timefold.solver.core.api.domain.solution.PlanningScore;
import ai.timefold.solver.core.api.domain.solution.PlanningSolution;
import ai.timefold.solver.core.api.domain.solution.ProblemFactCollectionProperty;
import ai.timefold.solver.core.api.domain.valuerange.ValueRangeProvider;
import ai.timefold.solver.core.api.score.buildin.simple.SimpleScore;
import ai.timefold.solver.core.impl.domain.solution.descriptor.SolutionDescriptor;
Expand All @@ -32,7 +31,7 @@ public TestdataInverseRelationSolution(String code) {
}

@ValueRangeProvider(id = "valueRange")
@ProblemFactCollectionProperty
@PlanningEntityCollectionProperty
public List<TestdataInverseRelationValue> getValueList() {
return valueList;
}
Expand Down
3 changes: 1 addition & 2 deletions ...va/ai/timefold/solver/quarkus/benchmark/it/domain/TestdataStringLengthShadowSolution.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@
import ai.timefold.solver.core.api.domain.solution.PlanningEntityCollectionProperty;
import ai.timefold.solver.core.api.domain.solution.PlanningScore;
import ai.timefold.solver.core.api.domain.solution.PlanningSolution;
import ai.timefold.solver.core.api.domain.solution.ProblemFactCollectionProperty;
import ai.timefold.solver.core.api.domain.valuerange.ValueRangeProvider;
import ai.timefold.solver.core.api.score.buildin.hardsoft.HardSoftScore;

@PlanningSolution
public class TestdataStringLengthShadowSolution {

@ProblemFactCollectionProperty
@PlanningEntityCollectionProperty
@ValueRangeProvider
private List<TestdataListValueShadowEntity> valueList;

Expand Down
Loading