org.optaplanner.core.impl.phase.custom

Interface CustomPhaseCommand

All Known Implementing Classes:

AbstractCustomPhaseCommand

public interface CustomPhaseCommand

Runs a custom algorithm as a Phase of the Solver that changes the planning variables. Do not abuse to change the problems facts, instead use Solver.addProblemFactChange(ProblemFactChange) for that.

An implementation must extend AbstractCustomPhaseCommand to ensure backwards compatibility in future versions.

See Also:

AbstractCustomPhaseCommand

Method Summary

Methods

Modifier and Type	Method and Description
void	applyCustomProperties(Map<String,String> customPropertyMap) Called during SolverFactory.buildSolver().
void	changeWorkingSolution(ScoreDirector scoreDirector) Changes workingSolution of ScoreDirector.getWorkingSolution().

Method Detail

applyCustomProperties

void applyCustomProperties(Map<String,String> customPropertyMap)

Called during SolverFactory.buildSolver().

Parameters:

customPropertyMap - never null

Throws:

IllegalArgumentException - if any of the properties are not supported or don't parse correctly

changeWorkingSolution

void changeWorkingSolution(ScoreDirector scoreDirector)

Changes workingSolution of ScoreDirector.getWorkingSolution(). When the workingSolution is modified, the ScoreDirector must be correctly notified (through ScoreDirector.beforeVariableChanged(Object, String), ScoreDirector.afterProblemFactChanged(Object), etc), otherwise calculated Scores will be corrupted.

Don't forget to call ScoreDirector.triggerVariableListeners() after each set of changes (especially before every ScoreDirector.calculateScore() call) to ensure all shadow variables are updated.

Parameters:

scoreDirector - never null, the ScoreDirector that needs to get notified of the changes.