Package ai.timefold.solver.core.impl.domain.solution.descriptor

Class SolutionDescriptor<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.domain.solution.descriptor.SolutionDescriptor<Solution_>

Type Parameters:

Solution_ - the solution type, the class with the PlanningSolution annotation

public class SolutionDescriptor<Solution_>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SolutionDescriptor.SolutionInitializationStatistics

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Class[]	ANNOTATED_MEMBERS_CLASSES

Method Summary

Modifier and Type	Method	Description
void	addEntityDescriptor(EntityDescriptor<Solution_> entityDescriptor)
static void	assertMutable(Class<?> clz, String classType)
static void	assertSingleInheritance(Class<?> solutionClass)
static void	assertValidAnnotatedMembers(Class<?> clazz)	If a class declares any annotated member, it must be annotated as a solution, even if a supertype already has the annotation.
static <Solution_> SolutionDescriptor<Solution_>	buildSolutionDescriptor(Class<Solution_> solutionClass, Class<?>... entityClasses)
static <Solution_> SolutionDescriptor<Solution_>	buildSolutionDescriptor(Class<Solution_> solutionClass, List<Class<?>> entityClassList)
static <Solution_> SolutionDescriptor<Solution_>	buildSolutionDescriptor(Set<PreviewFeature> enabledPreviewFeatureSet, DomainAccessType domainAccessType, Class<Solution_> solutionClass, Map<String,MemberAccessor> memberAccessorMap, Map<String,SolutionCloner> solutionClonerMap, List<Class<?>> entityClassList)
static <Solution_> SolutionDescriptor<Solution_>	buildSolutionDescriptor(Set<PreviewFeature> enabledPreviewFeaturesSet, Class<Solution_> solutionClass, Class<?>... entityClasses)
static <Solution_> SolutionDescriptor<Solution_>	buildSolutionDescriptor(Set<PreviewFeature> enabledPreviewFeaturesSet, Class<Solution_> solutionClass, List<Class<?>> entityClassList)
SolutionDescriptor.SolutionInitializationStatistics	computeInitializationStatistics(Solution_ solution)
SolutionDescriptor.SolutionInitializationStatistics	computeInitializationStatistics(Solution_ solution, Consumer<Object> finisher)
PlanningSolutionDiff<Solution_>	diff(Solution_ oldSolution, Solution_ newSolution)
EntityDescriptor<Solution_>	findEntityDescriptor(Class<?> entitySubclass)
EntityDescriptor<Solution_>	findEntityDescriptorOrFail(Class<?> entitySubclass)
VariableDescriptor<Solution_>	findVariableDescriptorOrFail(Object entity, String variableName)
Collection<Object>	getAllEntitiesAndProblemFacts(Solution_ solution)
List<ShadowVariableDescriptor<Solution_>>	getAllShadowVariableDescriptors()
long	getApproximateValueCount(Solution_ solution)
List<BasicVariableDescriptor<Solution_>>	getBasicVariableDescriptorList()
MemberAccessor	getConstraintConfigurationMemberAccessor()	Deprecated, for removal: This API element is subject to removal in a future version. ConstraintConfiguration was replaced by ConstraintWeightOverrides.
<Score_ extends Score<Score_>> ConstraintWeightSupplier<Solution_,Score_>	getConstraintWeightSupplier()
List<DeclarativeShadowVariableDescriptor<Solution_>>	getDeclarativeShadowVariableDescriptors()
DomainAccessType	getDomainAccessType()
Set<Class<?>>	getEntityClassSet()
Map<String,MemberAccessor>	getEntityCollectionMemberAccessorMap()
Collection<EntityDescriptor<Solution_>>	getEntityDescriptors()
EntityDescriptor<Solution_>	getEntityDescriptorStrict(Class<?> entityClass)
Map<String,MemberAccessor>	getEntityMemberAccessorMap()
int	getGenuineEntityCount(Solution_ solution)
Collection<EntityDescriptor<Solution_>>	getGenuineEntityDescriptors()
long	getGenuineVariableCount(Solution_ solution)
ListVariableDescriptor<Solution_>	getListVariableDescriptor()
LookUpStrategyResolver	getLookUpStrategyResolver()
long	getMaximumValueRangeSize(Solution_ solution)
MemberAccessorFactory	getMemberAccessorFactory()
PlanningSolutionMetaModel<Solution_>	getMetaModel()
MemberAccessor	getPlanningIdAccessor(Class<?> factClass)	Return accessor for a given member of a given class, if present, and cache it for future use.
Map<String,MemberAccessor>	getProblemFactCollectionMemberAccessorMap()
Map<String,MemberAccessor>	getProblemFactMemberAccessorMap()
Set<Class<?>>	getProblemFactOrEntityClassSet()
double	getProblemScale(Solution_ solution)	Calculates an indication on how big this problem instance is.
ProblemSizeStatistics	getProblemSizeStatistics(Solution_ solution)
<Score_ extends Score<Score_>> Score_	getScore(Solution_ solution)
<Score_ extends Score<Score_>> ScoreDefinition<Score_>	getScoreDefinition()
<Score_ extends Score<Score_>> ScoreDescriptor<Score_>	getScoreDescriptor()
Class<Solution_>	getSolutionClass()
SolutionCloner<Solution_>	getSolutionCloner()
boolean	hasBasicVariable()
boolean	hasBothBasicAndListVariables()
boolean	hasChainedVariable()
boolean	hasEntityDescriptor(Class<?> entitySubclass)
boolean	hasListVariable()
boolean	hasMovableEntities(ScoreDirector<Solution_> scoreDirector)
void	processAnnotations(DescriptorPolicy descriptorPolicy, List<Class<?>> entityClassList)
void	processUnannotatedFieldsAndMethods(DescriptorPolicy descriptorPolicy)
<Score_ extends Score<Score_>> void	setScore(Solution_ solution, Score_ score)	Called when the Score has been calculated or predicted.
String	toString()
void	visitAll(Solution_ solution, Consumer<Object> visitor)
void	visitAllEntities(Solution_ solution, Consumer<Object> visitor)
void	visitAllProblemFacts(Solution_ solution, Consumer<Object> visitor)
void	visitEntitiesByEntityClass(Solution_ solution, Class<?> entityClass, Predicate<Object> visitor)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ANNOTATED_MEMBERS_CLASSES

protected static final Class[] ANNOTATED_MEMBERS_CLASSES

Method Details

buildSolutionDescriptor

public static <Solution_>
SolutionDescriptor<Solution_> buildSolutionDescriptor(Class<Solution_> solutionClass,
 Class<?>... entityClasses)

buildSolutionDescriptor

public static <Solution_>
SolutionDescriptor<Solution_> buildSolutionDescriptor(Class<Solution_> solutionClass,
 List<Class<?>> entityClassList)

buildSolutionDescriptor

public static <Solution_>
SolutionDescriptor<Solution_> buildSolutionDescriptor(Set<PreviewFeature> enabledPreviewFeaturesSet,
 Class<Solution_> solutionClass,
 Class<?>... entityClasses)

buildSolutionDescriptor

public static <Solution_>
SolutionDescriptor<Solution_> buildSolutionDescriptor(Set<PreviewFeature> enabledPreviewFeaturesSet,
 Class<Solution_> solutionClass,
 List<Class<?>> entityClassList)

buildSolutionDescriptor

public static <Solution_>
SolutionDescriptor<Solution_> buildSolutionDescriptor(Set<PreviewFeature> enabledPreviewFeatureSet,
 DomainAccessType domainAccessType,
 Class<Solution_> solutionClass,
 Map<String,MemberAccessor> memberAccessorMap,
 Map<String,SolutionCloner> solutionClonerMap,
 List<Class<?>> entityClassList)

assertMutable

public static void assertMutable(Class<?> clz,
 String classType)

assertValidAnnotatedMembers

public static void assertValidAnnotatedMembers(Class<?> clazz)

If a class declares any annotated member, it must be annotated as a solution, even if a supertype already has the annotation.

assertSingleInheritance

public static void assertSingleInheritance(Class<?> solutionClass)

addEntityDescriptor

public void addEntityDescriptor(EntityDescriptor<Solution_> entityDescriptor)

processUnannotatedFieldsAndMethods

public void processUnannotatedFieldsAndMethods(DescriptorPolicy descriptorPolicy)

processAnnotations

public void processAnnotations(DescriptorPolicy descriptorPolicy,
 List<Class<?>> entityClassList)

getSolutionClass

public Class<Solution_> getSolutionClass()

getMemberAccessorFactory

public MemberAccessorFactory getMemberAccessorFactory()

getDomainAccessType

public DomainAccessType getDomainAccessType()

getScoreDefinition

public <Score_ extends Score<Score_>>
ScoreDefinition<Score_> getScoreDefinition()

getScoreDescriptor

public <Score_ extends Score<Score_>>
ScoreDescriptor<Score_> getScoreDescriptor()

getProblemFactMemberAccessorMap

public Map<String,MemberAccessor> getProblemFactMemberAccessorMap()

getProblemFactCollectionMemberAccessorMap

public Map<String,MemberAccessor> getProblemFactCollectionMemberAccessorMap()

getEntityMemberAccessorMap

public Map<String,MemberAccessor> getEntityMemberAccessorMap()

getEntityCollectionMemberAccessorMap

public Map<String,MemberAccessor> getEntityCollectionMemberAccessorMap()

getProblemFactOrEntityClassSet

public Set<Class<?>> getProblemFactOrEntityClassSet()

getListVariableDescriptor

public ListVariableDescriptor<Solution_> getListVariableDescriptor()

getSolutionCloner

public SolutionCloner<Solution_> getSolutionCloner()

getMetaModel

public PlanningSolutionMetaModel<Solution_> getMetaModel()

getBasicVariableDescriptorList

public List<BasicVariableDescriptor<Solution_>> getBasicVariableDescriptorList()

hasBasicVariable

public boolean hasBasicVariable()

hasChainedVariable

public boolean hasChainedVariable()

hasListVariable

public boolean hasListVariable()

hasBothBasicAndListVariables

public boolean hasBothBasicAndListVariables()

getConstraintConfigurationMemberAccessor

@Deprecated(forRemoval=true,
            since="1.13.0")
public MemberAccessor getConstraintConfigurationMemberAccessor()

Deprecated, for removal: This API element is subject to removal in a future version.

ConstraintConfiguration was replaced by ConstraintWeightOverrides.

getConstraintWeightSupplier

public <Score_ extends Score<Score_>>
ConstraintWeightSupplier<Solution_,Score_> getConstraintWeightSupplier()

getEntityClassSet

public Set<Class<?>> getEntityClassSet()

getEntityDescriptors

public Collection<EntityDescriptor<Solution_>> getEntityDescriptors()

getGenuineEntityDescriptors

public Collection<EntityDescriptor<Solution_>> getGenuineEntityDescriptors()

getEntityDescriptorStrict

public EntityDescriptor<Solution_> getEntityDescriptorStrict(Class<?> entityClass)

hasEntityDescriptor

public boolean hasEntityDescriptor(Class<?> entitySubclass)

findEntityDescriptorOrFail

public EntityDescriptor<Solution_> findEntityDescriptorOrFail(Class<?> entitySubclass)

findEntityDescriptor

public EntityDescriptor<Solution_> findEntityDescriptor(Class<?> entitySubclass)

findVariableDescriptorOrFail

public VariableDescriptor<Solution_> findVariableDescriptorOrFail(Object entity,
 String variableName)

getLookUpStrategyResolver

public LookUpStrategyResolver getLookUpStrategyResolver()

getAllEntitiesAndProblemFacts

public Collection<Object> getAllEntitiesAndProblemFacts(Solution_ solution)

getGenuineEntityCount

public int getGenuineEntityCount(Solution_ solution)

Parameters:

solution - never null

Returns:

>= 0

getPlanningIdAccessor

public MemberAccessor getPlanningIdAccessor(Class<?> factClass)

Return accessor for a given member of a given class, if present, and cache it for future use.

Parameters:

factClass - never null

Returns:

null if no such member exists

visitAllEntities

public void visitAllEntities(Solution_ solution,
 Consumer<Object> visitor)

visitEntitiesByEntityClass

public void visitEntitiesByEntityClass(Solution_ solution,
 Class<?> entityClass,
 Predicate<Object> visitor)

Parameters:

solution - solution to extract the entities from

entityClass - class of the entity to be visited, including subclasses

visitor - never null; applied to every entity, iteration stops if it returns true

visitAllProblemFacts

public void visitAllProblemFacts(Solution_ solution,
 Consumer<Object> visitor)

visitAll

public void visitAll(Solution_ solution,
 Consumer<Object> visitor)

hasMovableEntities

public boolean hasMovableEntities(ScoreDirector<Solution_> scoreDirector)

Parameters:

scoreDirector - never null

Returns:

>= 0

getGenuineVariableCount

public long getGenuineVariableCount(Solution_ solution)

Parameters:

solution - never null

Returns:

>= 0

getApproximateValueCount

public long getApproximateValueCount(Solution_ solution)

Parameters:

solution - never null

Returns:

>= 0

getMaximumValueRangeSize

public long getMaximumValueRangeSize(Solution_ solution)

getProblemScale

public double getProblemScale(Solution_ solution)

Calculates an indication on how big this problem instance is. This is approximately the base 10 log of the search space size.

Parameters:

solution - never null

Returns:

>= 0

getAllShadowVariableDescriptors

public List<ShadowVariableDescriptor<Solution_>> getAllShadowVariableDescriptors()

getDeclarativeShadowVariableDescriptors

public List<DeclarativeShadowVariableDescriptor<Solution_>> getDeclarativeShadowVariableDescriptors()

getProblemSizeStatistics

public ProblemSizeStatistics getProblemSizeStatistics(Solution_ solution)

computeInitializationStatistics

public SolutionDescriptor.SolutionInitializationStatistics computeInitializationStatistics(Solution_ solution)

computeInitializationStatistics

public SolutionDescriptor.SolutionInitializationStatistics computeInitializationStatistics(Solution_ solution,
 Consumer<Object> finisher)

getScore

public <Score_ extends Score<Score_>> Score_ getScore(Solution_ solution)

Parameters:

solution - never null

Returns:

sometimes null, if the Score hasn't been calculated yet

setScore

public <Score_ extends Score<Score_>> void setScore(Solution_ solution,
 Score_ score)

Called when the Score has been calculated or predicted.

Parameters:

solution - never null

score - sometimes null, in rare occasions to indicate that the old Score is stale, but no new ones has been calculated

diff

public PlanningSolutionDiff<Solution_> diff(Solution_ oldSolution,
 Solution_ newSolution)

toString

public String toString()

Overrides:

toString in class Object