OptaPlanner core 6.2.0.Beta1

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

java.lang.Object
  extended by org.optaplanner.core.impl.heuristic.move.AbstractMove
      extended by org.optaplanner.core.impl.heuristic.selector.move.generic.ChangeMove
All Implemented Interfaces:
Move
Direct Known Subclasses:
ChainedChangeMove

public class ChangeMove
extends AbstractMove


Field Summary
protected  Object entity
           
protected  Object toPlanningValue
           
protected  GenuineVariableDescriptor variableDescriptor
           
 
Constructor Summary
ChangeMove(Object entity, GenuineVariableDescriptor variableDescriptor, Object toPlanningValue)
           
 
Method Summary
 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.
 void doMove(ScoreDirector scoreDirector)
          Does the Move and updates the Solution and its ScoreDirector accordingly.
 boolean equals(Object o)
           
 Object getEntity()
           
 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 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

entity

protected final Object entity

variableDescriptor

protected final GenuineVariableDescriptor variableDescriptor

toPlanningValue

protected final Object toPlanningValue
Constructor Detail

ChangeMove

public ChangeMove(Object entity,
                  GenuineVariableDescriptor variableDescriptor,
                  Object toPlanningValue)
Method Detail

getEntity

public Object getEntity()

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:

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.

doMove

public void doMove(ScoreDirector scoreDirector)
Description copied from interface: Move
Does the Move and updates the Solution and its ScoreDirector accordingly. When the Solution is modified, the ScoreDirector should be correctly notified, otherwise later calculated Scores can be corrupted.

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

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

OptaPlanner core 6.2.0.Beta1

Copyright © 2006-2014 JBoss by Red Hat. All Rights Reserved.