org.optaplanner.core.impl.heuristic.move

Class AbstractMove

java.lang.Object

org.optaplanner.core.impl.heuristic.move.AbstractMove

All Implemented Interfaces:

Move

Direct Known Subclasses:

ChangeMove, KOptMove, NoChangeMove, PillarChangeMove, PillarSwapMove, SubChainChangeMove, SubChainReversingChangeMove, SubChainReversingSwapMove, SubChainSwapMove, SwapMove, TailChainSwapMove

public abstract class AbstractMove
extends Object
implements Move

Abstract superclass for Move.

See Also:

Move

Constructor Summary

Constructors

Constructor and Description
AbstractMove()

Method Summary

Methods

Modifier and Type	Method and Description
void	doMove(ScoreDirector scoreDirector) Does the move (which indirectly affects the ScoreDirector.getWorkingSolution()).
protected abstract void	doMoveOnGenuineVariables(ScoreDirector scoreDirector) Like doMove(ScoreDirector) but without the ScoreDirector.triggerVariableListeners() call (because doMove(ScoreDirector) already does that).
String	getSimpleMoveTypeDescription() Describes the move type for statistical purposes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.optaplanner.core.impl.heuristic.move.Move

createUndoMove, getPlanningEntities, getPlanningValues, isMoveDoable

Constructor Detail

AbstractMove

public AbstractMove()

Method Detail

getSimpleMoveTypeDescription

public String getSimpleMoveTypeDescription()

Description copied from interface: Move

Describes the move type for statistical purposes. For example "ChangeMove(Process.computer)".

The format is not formalized. Never parse the String returned by this method.

Specified by:

getSimpleMoveTypeDescription in interface Move

Returns:

never null

doMove

public final void doMove(ScoreDirector scoreDirector)

Description copied from interface: Move

Does the move (which indirectly affects the ScoreDirector.getWorkingSolution()). When the workingSolution is modified, the ScoreDirector must be correctly notified (through ScoreDirector.beforeVariableChanged(Object, String), ScoreDirector.afterProblemFactChanged(Object), etc), otherwise later calculated Scores will be corrupted.

This method must end with calling ScoreDirector.triggerVariableListeners() to ensure all shadow variables are updated.

Specified by:

doMove in interface Move

Parameters:

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

doMoveOnGenuineVariables

protected abstract void doMoveOnGenuineVariables(ScoreDirector scoreDirector)

Like doMove(ScoreDirector) but without the ScoreDirector.triggerVariableListeners() call (because doMove(ScoreDirector) already does that).

Parameters:

scoreDirector - never null