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

Class OverridesBasedConstraintWeightSupplier<Score_ extends Score<Score_>,Solution_>

java.lang.Object

ai.timefold.solver.core.impl.domain.solution.OverridesBasedConstraintWeightSupplier<Score_,Solution_>

All Implemented Interfaces:

ConstraintWeightSupplier<Solution_,Score_>

public final class OverridesBasedConstraintWeightSupplier<Score_ extends Score<Score_>,Solution_>
extends Object
implements ConstraintWeightSupplier<Solution_,Score_>

Method Summary

Modifier and Type	Method	Description
static <Solution_, Score_ extends Score<Score_>> ConstraintWeightSupplier<Solution_,Score_>	create(SolutionDescriptor<Solution_> solutionDescriptor, DescriptorPolicy descriptorPolicy, Field field)
Score_	getConstraintWeight(ConstraintRef constraintRef, Solution_ workingSolution)	Get the weight for the constraint if known to the supplier.
String	getDefaultConstraintPackage()
Class<?>	getProblemFactClass()	The class that carries the constraint weights.
void	initialize(SolutionDescriptor<Solution_> solutionDescriptor, MemberAccessorFactory memberAccessorFactory, DomainAccessType domainAccessType)
String	toString()
void	validate(Solution_ workingSolution, Set<ConstraintRef> userDefinedConstraints)	Will be called after ConstraintWeightSupplier.initialize(SolutionDescriptor, MemberAccessorFactory, DomainAccessType).

Methods inherited from class java.lang.Object

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

Method Details

create

public static <Solution_,
Score_ extends Score<Score_>>
ConstraintWeightSupplier<Solution_,Score_> create(SolutionDescriptor<Solution_> solutionDescriptor,
 DescriptorPolicy descriptorPolicy,
 Field field)

initialize

public void initialize(SolutionDescriptor<Solution_> solutionDescriptor,
 MemberAccessorFactory memberAccessorFactory,
 DomainAccessType domainAccessType)

Specified by:

initialize in interface ConstraintWeightSupplier<Score_ extends Score<Score_>,Solution_>

validate

public void validate(Solution_ workingSolution,
 Set<ConstraintRef> userDefinedConstraints)

Description copied from interface: ConstraintWeightSupplier

Will be called after ConstraintWeightSupplier.initialize(SolutionDescriptor, MemberAccessorFactory, DomainAccessType). Has the option of failing fast in case of discrepancies between the constraints defined in ConstraintProvider and the constraints defined in the configuration.

Specified by:

validate in interface ConstraintWeightSupplier<Score_ extends Score<Score_>,Solution_>

userDefinedConstraints - never null

getProblemFactClass

public Class<?> getProblemFactClass()

Description copied from interface: ConstraintWeightSupplier

The class that carries the constraint weights. It will either be annotated by ConstraintConfiguration, or be ConstraintWeightOverrides.

Specified by:

getProblemFactClass in interface ConstraintWeightSupplier<Score_ extends Score<Score_>,Solution_>

Returns:

never null

getDefaultConstraintPackage

public String getDefaultConstraintPackage()

Specified by:

getDefaultConstraintPackage in interface ConstraintWeightSupplier<Score_ extends Score<Score_>,Solution_>

getConstraintWeight

public Score_ getConstraintWeight(ConstraintRef constraintRef,
 Solution_ workingSolution)

Description copied from interface: ConstraintWeightSupplier

Get the weight for the constraint if known to the supplier. Supplies may choose not to provide a value for unknown constraints, which is the case for OverridesBasedConstraintWeightSupplier. ConstraintConfigurationBasedConstraintWeightSupplier will always provide a value.

Specified by:

getConstraintWeight in interface ConstraintWeightSupplier<Score_ extends Score<Score_>,Solution_>

Parameters:

constraintRef - never null

workingSolution - never null

Returns:

may be null, if the provider does not know the constraint

toString

public String toString()

Overrides:

toString in class Object