Package ai.timefold.solver.core.impl.solver.change

Class DefaultProblemChangeDirector<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.solver.change.DefaultProblemChangeDirector<Solution_>

All Implemented Interfaces:

ProblemChangeDirector

public final class DefaultProblemChangeDirector<Solution_>
extends Object
implements ProblemChangeDirector

Constructor Summary

Constructors

Constructor	Description
DefaultProblemChangeDirector(InnerScoreDirector<Solution_,?> scoreDirector)

Method Summary

Modifier and Type	Method	Description
<Entity> void	addEntity(@NonNull Entity entity, @NonNull Consumer<Entity> entityConsumer)	Add a new PlanningEntity instance into the working solution.
<ProblemFact> void	addProblemFact(@NonNull ProblemFact problemFact, @NonNull Consumer<ProblemFact> problemFactConsumer)	Add a new problem fact into the working solution.
<EntityOrProblemFact> void	changeProblemProperty(@NonNull EntityOrProblemFact problemFactOrEntity, @NonNull Consumer<EntityOrProblemFact> problemFactOrEntityConsumer)	Change a property of either a PlanningEntity or a problem fact.
<Entity> void	changeVariable(@NonNull Entity entity, @NonNull String variableName, @NonNull Consumer<Entity> entityConsumer)	Change a PlanningVariable value of a PlanningEntity.
<EntityOrProblemFact> Optional<EntityOrProblemFact>	lookUpWorkingObject(EntityOrProblemFact externalObject)	As defined by ProblemChangeDirector.lookUpWorkingObjectOrFail(Object), but doesn't fail fast if no workingObject was ever added for the externalObject.
<EntityOrProblemFact> @Nullable EntityOrProblemFact	lookUpWorkingObjectOrFail(@Nullable EntityOrProblemFact externalObject)	Translate an entity or fact instance (often from another Thread or JVM) to this ProblemChangeDirector's internal working instance.
<Entity> void	removeEntity(@NonNull Entity entity, @NonNull Consumer<Entity> entityConsumer)	Remove an existing PlanningEntity instance from the working solution.
<ProblemFact> void	removeProblemFact(@NonNull ProblemFact problemFact, @NonNull Consumer<ProblemFact> problemFactConsumer)	Remove an existing problem fact from the working solution.
void	updateShadowVariables()	Calls variable listeners on the external changes submitted so far.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultProblemChangeDirector

public DefaultProblemChangeDirector(InnerScoreDirector<Solution_,?> scoreDirector)

Method Details

addEntity

public <Entity> void addEntity(@NonNull Entity entity,
 @NonNull Consumer<Entity> entityConsumer)

Description copied from interface: ProblemChangeDirector

Add a new PlanningEntity instance into the working solution.

Specified by:

addEntity in interface ProblemChangeDirector

Type Parameters:

Entity - the planning entity object type

Parameters:

entity - the PlanningEntity instance

entityConsumer - adds the entity to the working solution

removeEntity

public <Entity> void removeEntity(@NonNull Entity entity,
 @NonNull Consumer<Entity> entityConsumer)

Description copied from interface: ProblemChangeDirector

Remove an existing PlanningEntity instance from the working solution. Translates the entity to a working planning entity by performing a lookup as defined by ProblemChangeDirector.lookUpWorkingObjectOrFail(Object).

Specified by:

removeEntity in interface ProblemChangeDirector

Type Parameters:

Entity - the planning entity object type

Parameters:

entity - the PlanningEntity instance

entityConsumer - removes the working entity from the working solution

changeVariable

public <Entity> void changeVariable(@NonNull Entity entity,
 @NonNull String variableName,
 @NonNull Consumer<Entity> entityConsumer)

Description copied from interface: ProblemChangeDirector

Change a PlanningVariable value of a PlanningEntity. Translates the entity to a working planning entity by performing a lookup as defined by ProblemChangeDirector.lookUpWorkingObjectOrFail(Object).

Specified by:

changeVariable in interface ProblemChangeDirector

Type Parameters:

Entity - the planning entity object type

Parameters:

entity - the PlanningEntity instance

variableName - name of the PlanningVariable

entityConsumer - updates the value of the PlanningVariable inside the PlanningEntity

addProblemFact

public <ProblemFact> void addProblemFact(@NonNull ProblemFact problemFact,
 @NonNull Consumer<ProblemFact> problemFactConsumer)

Description copied from interface: ProblemChangeDirector

Add a new problem fact into the working solution.

Specified by:

addProblemFact in interface ProblemChangeDirector

Type Parameters:

ProblemFact - the problem fact object type

Parameters:

problemFact - the problem fact instance

problemFactConsumer - removes the working problem fact from the working solution

removeProblemFact

public <ProblemFact> void removeProblemFact(@NonNull ProblemFact problemFact,
 @NonNull Consumer<ProblemFact> problemFactConsumer)

Description copied from interface: ProblemChangeDirector

Remove an existing problem fact from the working solution. Translates the problem fact to a working problem fact by performing a lookup as defined by ProblemChangeDirector.lookUpWorkingObjectOrFail(Object).

Specified by:

removeProblemFact in interface ProblemChangeDirector

Type Parameters:

ProblemFact - the problem fact object type

Parameters:

problemFact - the problem fact instance

problemFactConsumer - removes the working problem fact from the working solution

changeProblemProperty

public <EntityOrProblemFact> void changeProblemProperty(@NonNull EntityOrProblemFact problemFactOrEntity,
 @NonNull Consumer<EntityOrProblemFact> problemFactOrEntityConsumer)

Description copied from interface: ProblemChangeDirector

Change a property of either a PlanningEntity or a problem fact. Translates the entity or the problem fact to its working solution counterpart by performing a lookup as defined by ProblemChangeDirector.lookUpWorkingObjectOrFail(Object).

Specified by:

changeProblemProperty in interface ProblemChangeDirector

Type Parameters:

EntityOrProblemFact - the planning entity or problem fact object type

Parameters:

problemFactOrEntity - the PlanningEntity or the problem fact instance

problemFactOrEntityConsumer - updates the property of the PlanningEntity or the problem fact

lookUpWorkingObjectOrFail

public <EntityOrProblemFact>
@Nullable EntityOrProblemFact lookUpWorkingObjectOrFail(@Nullable EntityOrProblemFact externalObject)

Description copied from interface: ProblemChangeDirector

Translate an entity or fact instance (often from another Thread or JVM) to this ProblemChangeDirector's internal working instance.

Matching is determined by the LookUpStrategyType on PlanningSolution. Matching uses a PlanningId by default.

Specified by:

lookUpWorkingObjectOrFail in interface ProblemChangeDirector

Type Parameters:

EntityOrProblemFact - the object type

Returns:

null if externalObject is null

lookUpWorkingObject

public <EntityOrProblemFact>
Optional<EntityOrProblemFact> lookUpWorkingObject(EntityOrProblemFact externalObject)

Description copied from interface: ProblemChangeDirector

As defined by ProblemChangeDirector.lookUpWorkingObjectOrFail(Object), but doesn't fail fast if no workingObject was ever added for the externalObject. It's recommended to use ProblemChangeDirector.lookUpWorkingObjectOrFail(Object) instead.

Specified by:

lookUpWorkingObject in interface ProblemChangeDirector

Type Parameters:

EntityOrProblemFact - the object type

Returns:

Optional.empty() if externalObject is null or if there is no workingObject for externalObject

updateShadowVariables

public void updateShadowVariables()

Description copied from interface: ProblemChangeDirector

Calls variable listeners on the external changes submitted so far.

This happens automatically after the entire ProblemChange has been processed, but this method allows the user to specifically request it in the middle of the ProblemChange.

Specified by:

updateShadowVariables in interface ProblemChangeDirector