org.optaplanner.core.impl.heuristic.selector.move.generic

Class PillarChangeMove

java.lang.Object

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

org.optaplanner.core.impl.heuristic.selector.move.generic.PillarChangeMove

All Implemented Interfaces:

Move

public class PillarChangeMove
extends AbstractMove

Non-cacheable.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Object>	pillar
protected Object	toPlanningValue
protected GenuineVariableDescriptor	variableDescriptor

Constructor Summary

Constructors

Constructor and Description
PillarChangeMove(List<Object> pillar, GenuineVariableDescriptor variableDescriptor, Object toPlanningValue)

Method Summary

Methods

Modifier and Type	Method and Description
Move	createUndoMove(ScoreDirector scoreDirector) Called before the move is done, so the move can be evaluated and then be undone without resulting into a permanent change in the solution.
protected void	doMoveOnGenuineVariables(ScoreDirector scoreDirector) Like AbstractMove.doMove(ScoreDirector) but without the ScoreDirector.triggerVariableListeners() call (because AbstractMove.doMove(ScoreDirector) already does that).
boolean	equals(Object o)
List<Object>	getPillar()
Collection<? extends Object>	getPlanningEntities() Returns all planning entities that are being changed by this move.
Collection<? extends Object>	getPlanningValues() Returns all planning values that entities are being assigned to by this move.
String	getSimpleMoveTypeDescription() Describes the move type for statistical purposes.
Object	getToPlanningValue()
int	hashCode()
boolean	isMoveDoable(ScoreDirector scoreDirector) Called before a move is evaluated to decide whether the move can be done and evaluated.
String	toString()

Methods inherited from class org.optaplanner.core.impl.heuristic.move.AbstractMove

doMove

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

variableDescriptor

protected final GenuineVariableDescriptor variableDescriptor

pillar

protected final List<Object> pillar

toPlanningValue

protected final Object toPlanningValue

Constructor Detail

PillarChangeMove

public PillarChangeMove(List<Object> pillar,
                GenuineVariableDescriptor variableDescriptor,
                Object toPlanningValue)

Method Detail

getPillar

public List<Object> getPillar()

getToPlanningValue

public Object getToPlanningValue()

isMoveDoable

public boolean isMoveDoable(ScoreDirector scoreDirector)

Description copied from interface: Move

Called before a move is evaluated to decide whether the move can be done and evaluated. A Move is not doable if:

• Either doing it would change nothing in the Solution.
• Either it's simply not possible to do (for example due to build-in hard constraints).

It is recommended to keep this method implementation simple: do not use it in an attempt to satisfy normal hard and soft constraints.

Although you could also filter out non-doable moves in for example the MoveSelector or MoveListFactory, this is not needed as the Solver will do it for you.

Parameters:

scoreDirector - the ScoreDirector not yet modified by the move.

Returns:

true if the move achieves a change in the solution and the move is possible to do on the solution.

createUndoMove

public Move createUndoMove(ScoreDirector scoreDirector)

Description copied from interface: Move

Called before the move is done, so the move can be evaluated and then be undone without resulting into a permanent change in the solution.

Parameters:

scoreDirector - the ScoreDirector not yet modified by the move.

Returns:

an undoMove which does the exact opposite of this move.

doMoveOnGenuineVariables

protected void doMoveOnGenuineVariables(ScoreDirector scoreDirector)

Description copied from class: AbstractMove

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

Specified by:

doMoveOnGenuineVariables in class AbstractMove

Parameters:

scoreDirector - never null

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

Overrides:

getSimpleMoveTypeDescription in class AbstractMove

Returns:

never null

getPlanningEntities

public Collection<? extends Object> getPlanningEntities()

Description copied from interface: Move

Returns all planning entities that are being changed by this move. Required for AcceptorType.ENTITY_TABU.

Duplicates entries in the returned Collection are best avoided. The returned Collection is recommended to be in a stable order. For example: use List or LinkedHashSet, but not HashSet.

Returns:

never null

getPlanningValues

public Collection<? extends Object> getPlanningValues()

Description copied from interface: Move

Returns all planning values that entities are being assigned to by this move. Required for AcceptorType.VALUE_TABU.

Duplicates entries in the returned Collection are best avoided. The returned Collection is recommended to be in a stable order. For example: use List or LinkedHashSet, but not HashSet.

Returns:

never null

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object