Package ai.timefold.solver.core.impl.move.director

Class VariableChangeRecordingScoreDirector<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.move.director.VariableChangeRecordingScoreDirector<Solution_>

All Implemented Interfaces:

ScoreDirector<Solution_>, RevertableScoreDirector<Solution_>, VariableDescriptorAwareScoreDirector<Solution_>

public final class VariableChangeRecordingScoreDirector<Solution_>
extends Object
implements RevertableScoreDirector<Solution_>

Constructor Summary

Constructors

Constructor	Description
VariableChangeRecordingScoreDirector(ScoreDirector<Solution_> backingScoreDirector)
VariableChangeRecordingScoreDirector(ScoreDirector<Solution_> backingScoreDirector, boolean requiresIndexCache)

Method Summary

Modifier and Type	Method	Description
void	afterListVariableChanged(ListVariableDescriptor<Solution_> variableDescriptor, Object entity, int fromIndex, int toIndex)	Notify the score director after a list variable changes.
void	afterListVariableElementAssigned(ListVariableDescriptor<Solution_> variableDescriptor, Object element)	Call this for each element that was assigned (added to a list variable of one entity without being removed from a list variable of another entity).
void	afterListVariableElementUnassigned(ListVariableDescriptor<Solution_> variableDescriptor, Object element)	Call this for each element that was unassigned (removed from a list variable of one entity without being added to a list variable of another entity).
void	afterVariableChanged(VariableDescriptor<Solution_> variableDescriptor, Object entity)
void	beforeListVariableChanged(ListVariableDescriptor<Solution_> variableDescriptor, Object entity, int fromIndex, int toIndex)	Notify the score director before a list variable changes.
void	beforeListVariableElementAssigned(ListVariableDescriptor<Solution_> variableDescriptor, Object element)	Call this for each element that will be assigned (added to a list variable of one entity without being removed from a list variable of another entity).
void	beforeListVariableElementUnassigned(ListVariableDescriptor<Solution_> variableDescriptor, Object element)	Call this for each element that will be unassigned (removed from a list variable of one entity without being added to a list variable of another entity).
void	beforeVariableChanged(VariableDescriptor<Solution_> variableDescriptor, Object entity)
void	changeVariableFacade(VariableDescriptor<Solution_> variableDescriptor, Object entity, Object newValue)
List<?>	copyChanges()	Use this method to get a copy of all non-commited changes executed by the director so far.
InnerScoreDirector<Solution_,?>	getBacking()	Returns the score director to which events are delegated.
VariableChangeRecordingScoreDirector<Solution_>	getNonDelegating()	The VariableChangeRecordingScoreDirector score director includes two main tasks: tracking any variable change and firing events to a delegated score director.
SolutionDescriptor<Solution_>	getSolutionDescriptor()
VariableDescriptorCache<Solution_>	getVariableDescriptorCache()
Solution_	getWorkingSolution()	The PlanningSolution that is used to calculate the Score.
<E> E	lookUpWorkingObject(E externalObject)	Translates an entity or fact instance (often from another Thread or JVM) to this ScoreDirector's internal working instance.
<E> E	lookUpWorkingObjectOrReturnNull(E externalObject)	As defined by ScoreDirector.lookUpWorkingObject(Object), but doesn't fail fast if no workingObject was ever added for the externalObject.
void	triggerVariableListeners()
void	undoChanges()	Use this method to revert all changes made by moves.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.timefold.solver.core.api.score.director.ScoreDirector

afterEntityAdded, afterEntityRemoved, afterProblemFactAdded, afterProblemFactRemoved, afterProblemPropertyChanged, beforeEntityAdded, beforeEntityRemoved, beforeProblemFactAdded, beforeProblemFactRemoved, beforeProblemPropertyChanged

Methods inherited from interface ai.timefold.solver.core.impl.score.director.VariableDescriptorAwareScoreDirector

afterListVariableChanged, afterListVariableElementAssigned, afterListVariableElementUnassigned, afterVariableChanged, beforeListVariableChanged, beforeListVariableElementAssigned, beforeListVariableElementUnassigned, beforeVariableChanged

Constructor Details

VariableChangeRecordingScoreDirector

public VariableChangeRecordingScoreDirector(ScoreDirector<Solution_> backingScoreDirector)

VariableChangeRecordingScoreDirector

public VariableChangeRecordingScoreDirector(ScoreDirector<Solution_> backingScoreDirector,
 boolean requiresIndexCache)

Method Details

copyChanges

public List<?> copyChanges()

Description copied from interface: RevertableScoreDirector

Use this method to get a copy of all non-commited changes executed by the director so far.

Specified by:

copyChanges in interface RevertableScoreDirector<Solution_>

undoChanges

public void undoChanges()

Description copied from interface: RevertableScoreDirector

Use this method to revert all changes made by moves. The score director that implements this logic must be able to track every single change in the solution and restore it to its original state.

Specified by:

undoChanges in interface RevertableScoreDirector<Solution_>

beforeVariableChanged

public void beforeVariableChanged(VariableDescriptor<Solution_> variableDescriptor,
 Object entity)

Specified by:

beforeVariableChanged in interface VariableDescriptorAwareScoreDirector<Solution_>

afterVariableChanged

public void afterVariableChanged(VariableDescriptor<Solution_> variableDescriptor,
 Object entity)

Specified by:

afterVariableChanged in interface VariableDescriptorAwareScoreDirector<Solution_>

beforeListVariableChanged

public void beforeListVariableChanged(ListVariableDescriptor<Solution_> variableDescriptor,
 Object entity,
 int fromIndex,
 int toIndex)

Description copied from interface: VariableDescriptorAwareScoreDirector

Notify the score director before a list variable changes.

The list variable change includes:

• Changing position (index) of one or more elements.
• Removing one or more elements from the list variable.
• Adding one or more elements to the list variable.
• Any mix of the above.

For the sake of variable listeners' efficiency, the change notification requires an index range that contains elements affected by the change. The range starts at fromIndex (inclusive) and ends at toIndex (exclusive).

The range has to comply with the following contract:

1. fromIndex must be greater than or equal to 0; toIndex must be less than or equal to the list variable size.
2. toIndex must be greater than or equal to fromIndex.
3. The range must contain all elements that are going to be changed.
4. The range is allowed to contain elements that are not going to be changed.
5. The range may be empty (fromIndex equals toIndex) if none of the existing list variable elements are going to be changed.

VariableDescriptorAwareScoreDirector.beforeListVariableElementUnassigned(ListVariableDescriptor, Object) must be called for each element that will be unassigned (removed from a list variable of one entity without being added to a list variable of another entity).

Specified by:

beforeListVariableChanged in interface VariableDescriptorAwareScoreDirector<Solution_>

Parameters:

variableDescriptor - descriptor of the list variable being changed

entity - the entity owning the list variable being changed

fromIndex - low endpoint (inclusive) of the changed range

toIndex - high endpoint (exclusive) of the changed range

afterListVariableChanged

public void afterListVariableChanged(ListVariableDescriptor<Solution_> variableDescriptor,
 Object entity,
 int fromIndex,
 int toIndex)

Description copied from interface: VariableDescriptorAwareScoreDirector

Notify the score director after a list variable changes.

The list variable change includes:

• Changing position (index) of one or more elements.
• Removing one or more elements from the list variable.
• Adding one or more elements to the list variable.
• Any mix of the above.

For the sake of variable listeners' efficiency, the change notification requires an index range that contains elements affected by the change. The range starts at fromIndex (inclusive) and ends at toIndex (exclusive).

The range has to comply with the following contract:

1. fromIndex must be greater than or equal to 0; toIndex must be less than or equal to the list variable size.
2. toIndex must be greater than or equal to fromIndex.
3. The range must contain all elements that have changed.
4. The range is allowed to contain elements that have not changed.
5. The range may be empty (fromIndex equals toIndex) if none of the existing list variable elements have changed.

VariableDescriptorAwareScoreDirector.afterListVariableElementUnassigned(ListVariableDescriptor, Object) must be called for each element that was unassigned (removed from a list variable of one entity without being added to a list variable of another entity).

Specified by:

afterListVariableChanged in interface VariableDescriptorAwareScoreDirector<Solution_>

Parameters:

variableDescriptor - descriptor of the list variable being changed

entity - the entity owning the list variable being changed

fromIndex - low endpoint (inclusive) of the changed range

toIndex - high endpoint (exclusive) of the changed range

beforeListVariableElementAssigned

public void beforeListVariableElementAssigned(ListVariableDescriptor<Solution_> variableDescriptor,
 Object element)

Description copied from interface: VariableDescriptorAwareScoreDirector

Call this for each element that will be assigned (added to a list variable of one entity without being removed from a list variable of another entity).

Specified by:

beforeListVariableElementAssigned in interface VariableDescriptorAwareScoreDirector<Solution_>

Parameters:

variableDescriptor - the list variable descriptor

element - the assigned element

afterListVariableElementAssigned

public void afterListVariableElementAssigned(ListVariableDescriptor<Solution_> variableDescriptor,
 Object element)

Description copied from interface: VariableDescriptorAwareScoreDirector

Call this for each element that was assigned (added to a list variable of one entity without being removed from a list variable of another entity).

Specified by:

afterListVariableElementAssigned in interface VariableDescriptorAwareScoreDirector<Solution_>

Parameters:

variableDescriptor - the list variable descriptor

element - the assigned element

beforeListVariableElementUnassigned

public void beforeListVariableElementUnassigned(ListVariableDescriptor<Solution_> variableDescriptor,
 Object element)

Description copied from interface: VariableDescriptorAwareScoreDirector

Call this for each element that will be unassigned (removed from a list variable of one entity without being added to a list variable of another entity).

Specified by:

beforeListVariableElementUnassigned in interface VariableDescriptorAwareScoreDirector<Solution_>

Parameters:

variableDescriptor - the list variable descriptor

element - the unassigned element

afterListVariableElementUnassigned

public void afterListVariableElementUnassigned(ListVariableDescriptor<Solution_> variableDescriptor,
 Object element)

Description copied from interface: VariableDescriptorAwareScoreDirector

Call this for each element that was unassigned (removed from a list variable of one entity without being added to a list variable of another entity).

Specified by:

afterListVariableElementUnassigned in interface VariableDescriptorAwareScoreDirector<Solution_>

Parameters:

variableDescriptor - the list variable descriptor

element - the unassigned element

getSolutionDescriptor

public SolutionDescriptor<Solution_> getSolutionDescriptor()

Specified by:

getSolutionDescriptor in interface VariableDescriptorAwareScoreDirector<Solution_>

getBacking

public InnerScoreDirector<Solution_,?> getBacking()

Returns the score director to which events are delegated.

getNonDelegating

public VariableChangeRecordingScoreDirector<Solution_> getNonDelegating()

The VariableChangeRecordingScoreDirector score director includes two main tasks: tracking any variable change and firing events to a delegated score director. This method returns a copy of the score director that only tracks variable changes without firing any delegated score director events.

getWorkingSolution

public Solution_ getWorkingSolution()

Description copied from interface: ScoreDirector

The PlanningSolution that is used to calculate the Score.

Because a Score is best calculated incrementally (by deltas), the ScoreDirector needs to be notified when its working solution changes.

Specified by:

getWorkingSolution in interface ScoreDirector<Solution_>

getVariableDescriptorCache

public VariableDescriptorCache<Solution_> getVariableDescriptorCache()

Specified by:

getVariableDescriptorCache in interface VariableDescriptorAwareScoreDirector<Solution_>

triggerVariableListeners

public void triggerVariableListeners()

Specified by:

triggerVariableListeners in interface ScoreDirector<Solution_>

lookUpWorkingObject

public <E> E lookUpWorkingObject(E externalObject)

Description copied from interface: ScoreDirector

Translates an entity or fact instance (often from another Thread or JVM) to this ScoreDirector's internal working instance. Useful for move rebasing and in a ProblemChange.

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

Specified by:

lookUpWorkingObject in interface ScoreDirector<Solution_>

Type Parameters:

E - the object type

Returns:

null if externalObject is null

lookUpWorkingObjectOrReturnNull

public <E> E lookUpWorkingObjectOrReturnNull(E externalObject)

Description copied from interface: ScoreDirector

As defined by ScoreDirector.lookUpWorkingObject(Object), but doesn't fail fast if no workingObject was ever added for the externalObject. It's recommended to use ScoreDirector.lookUpWorkingObject(Object) instead, especially in move rebasing code.

Specified by:

lookUpWorkingObjectOrReturnNull in interface ScoreDirector<Solution_>

Type Parameters:

E - the object type

Returns:

null if externalObject is null or if there is no workingObject for externalObject

changeVariableFacade

public void changeVariableFacade(VariableDescriptor<Solution_> variableDescriptor,
 Object entity,
 Object newValue)

Specified by:

changeVariableFacade in interface VariableDescriptorAwareScoreDirector<Solution_>