Package ai.timefold.solver.core.impl.domain.variable.listener.support.violation

Class ListVariableTracker<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.domain.variable.listener.support.violation.ListVariableTracker<Solution_>

All Implemented Interfaces:

AbstractVariableListener<Solution_,Object>, ListVariableListener<Solution_,Object,Object>, SourcedVariableListener<Solution_>, Supply, Closeable, AutoCloseable

public class ListVariableTracker<Solution_>
extends Object
implements SourcedVariableListener<Solution_>, ListVariableListener<Solution_,Object,Object>, Supply

Tracks variable listener events for a given PlanningListVariable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ListVariableTracker.TrackerDemand	In order for the ListVariableTracker to be registered as a variable listener, it needs to be passed to the InnerScoreDirector.getSupplyManager(), which requires a Demand.

Constructor Summary

Constructors

Constructor	Description
ListVariableTracker(ListVariableDescriptor<Solution_> variableDescriptor)

Method Summary

Modifier and Type	Method	Description
void	afterEntityAdded(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object entity)
void	afterEntityRemoved(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object entity)
void	afterListVariableChanged(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object entity, int fromIndex, int toIndex)	Tells the listener that some elements within the range starting at fromIndex (inclusive) and ending at toIndex (exclusive) changed.
void	afterListVariableElementUnassigned(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object element)	The listener must unset all shadow variables it is responsible for when an element is unassigned from the source list variable.
void	beforeEntityAdded(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object entity)
void	beforeEntityRemoved(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object entity)
void	beforeListVariableChanged(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object entity, int fromIndex, int toIndex)	Tells the listener that some elements within the range starting at fromIndex (inclusive) and ending at toIndex (exclusive) will change.
ListVariableTracker<Solution_>.TrackerDemand	demand()
List<String>	getEntitiesMissingBeforeAfterEvents(List<VariableId<Solution_>> changedVariables)
VariableDescriptor<Solution_>	getSourceVariableDescriptor()
void	resetWorkingSolution(@NonNull ScoreDirector<Solution_> scoreDirector)	Called when the entire working solution changes.

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.domain.variable.AbstractVariableListener

close

Constructor Details

ListVariableTracker

public ListVariableTracker(ListVariableDescriptor<Solution_> variableDescriptor)

Method Details

getSourceVariableDescriptor

public VariableDescriptor<Solution_> getSourceVariableDescriptor()

Specified by:

getSourceVariableDescriptor in interface SourcedVariableListener<Solution_>

resetWorkingSolution

public void resetWorkingSolution(@NonNull ScoreDirector<Solution_> scoreDirector)

Description copied from interface: AbstractVariableListener

Called when the entire working solution changes. In this event, the other before..()/after...() methods will not be called. At this point, implementations should clear state, if any.

Specified by:

resetWorkingSolution in interface AbstractVariableListener<Solution_,Object>

beforeEntityAdded

public void beforeEntityAdded(@NonNull ScoreDirector<Solution_> scoreDirector,
 @NonNull Object entity)

Specified by:

beforeEntityAdded in interface AbstractVariableListener<Solution_,Object>

afterEntityAdded

public void afterEntityAdded(@NonNull ScoreDirector<Solution_> scoreDirector,
 @NonNull Object entity)

Specified by:

afterEntityAdded in interface AbstractVariableListener<Solution_,Object>

beforeEntityRemoved

public void beforeEntityRemoved(@NonNull ScoreDirector<Solution_> scoreDirector,
 @NonNull Object entity)

Specified by:

beforeEntityRemoved in interface AbstractVariableListener<Solution_,Object>

afterEntityRemoved

public void afterEntityRemoved(@NonNull ScoreDirector<Solution_> scoreDirector,
 @NonNull Object entity)

Specified by:

afterEntityRemoved in interface AbstractVariableListener<Solution_,Object>

afterListVariableElementUnassigned

public void afterListVariableElementUnassigned(@NonNull ScoreDirector<Solution_> scoreDirector,
 @NonNull Object element)

Description copied from interface: ListVariableListener

The listener must unset all shadow variables it is responsible for when an element is unassigned from the source list variable. For example, a Task's startTime shadow variable must be reset to null after a task is unassigned from Employee.tasks when the move that assigned it there is undone during Construction Heuristic phase.

Specified by:

afterListVariableElementUnassigned in interface ListVariableListener<Solution_,Object,Object>

Parameters:

scoreDirector - score director

element - the unassigned element

beforeListVariableChanged

public void beforeListVariableChanged(@NonNull ScoreDirector<Solution_> scoreDirector,
 @NonNull Object entity,
 int fromIndex,
 int toIndex)

Description copied from interface: ListVariableListener

Tells the listener that some elements within the range starting at fromIndex (inclusive) and ending at toIndex (exclusive) will change. Be aware that the ListVariableListener.afterListVariableChanged(ai.timefold.solver.core.api.score.director.ScoreDirector<Solution_>, Entity_, int, int) call after the change is done often has a different fromIndex and toIndex because the number of elements in the list variable can change.

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.

The range has the following properties:

1. fromIndex is greater than or equal to 0; toIndex is less than or equal to the list variable size.
2. toIndex is greater than or equal to fromIndex.
3. The range contains all elements that are going to be changed.
4. The range may 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.

Specified by:

beforeListVariableChanged in interface ListVariableListener<Solution_,Object,Object>

Parameters:

scoreDirector - score director

entity - entity with the changed list variable

fromIndex - low endpoint (inclusive) of the changed range

toIndex - high endpoint (exclusive) of the changed range

afterListVariableChanged

public void afterListVariableChanged(@NonNull ScoreDirector<Solution_> scoreDirector,
 @NonNull Object entity,
 int fromIndex,
 int toIndex)

Description copied from interface: ListVariableListener

Tells the listener that some elements within the range starting at fromIndex (inclusive) and ending at toIndex (exclusive) changed.

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.

The range has the following properties:

1. fromIndex is greater than or equal to 0; toIndex is less than or equal to the list variable size.
2. toIndex is greater than or equal to fromIndex.
3. The range contains all elements that have changed.
4. The range may 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.

Specified by:

afterListVariableChanged in interface ListVariableListener<Solution_,Object,Object>

Parameters:

scoreDirector - score director

entity - entity with the changed list variable

fromIndex - low endpoint (inclusive) of the changed range

toIndex - high endpoint (exclusive) of the changed range

getEntitiesMissingBeforeAfterEvents

public List<String> getEntitiesMissingBeforeAfterEvents(List<VariableId<Solution_>> changedVariables)

demand

public ListVariableTracker<Solution_>.TrackerDemand demand()