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

Class VariableTracker<Solution_>

java.lang.Object

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

All Implemented Interfaces:

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

public class VariableTracker<Solution_>
extends Object
implements SourcedVariableListener<Solution_>, VariableListener<Solution_,Object>, Supply

Tracks variable listener events for a given genuine or shadow variable (except PlanningListVariable).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	VariableTracker.TrackerDemand	In order for the VariableTracker 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
VariableTracker(VariableDescriptor<Solution_> variableDescriptor)

Method Summary

Modifier and Type	Method	Description
void	afterEntityAdded(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object object)
void	afterEntityRemoved(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object object)
void	afterVariableChanged(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object entity)
void	beforeEntityAdded(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object object)
void	beforeEntityRemoved(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object object)
void	beforeVariableChanged(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object entity)
VariableTracker<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

Methods inherited from interface ai.timefold.solver.core.api.domain.variable.VariableListener

requiresUniqueEntityEvents

Constructor Details

VariableTracker

public VariableTracker(VariableDescriptor<Solution_> variableDescriptor)

Method Details

getSourceVariableDescriptor

public VariableDescriptor<Solution_> getSourceVariableDescriptor()

Specified by:

getSourceVariableDescriptor in interface SourcedVariableListener<Solution_>

beforeEntityAdded

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

Specified by:

beforeEntityAdded in interface AbstractVariableListener<Solution_,Object>

afterEntityAdded

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

Specified by:

afterEntityAdded in interface AbstractVariableListener<Solution_,Object>

beforeEntityRemoved

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

Specified by:

beforeEntityRemoved in interface AbstractVariableListener<Solution_,Object>

afterEntityRemoved

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

Specified by:

afterEntityRemoved in interface AbstractVariableListener<Solution_,Object>

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>

beforeVariableChanged

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

Specified by:

beforeVariableChanged in interface VariableListener<Solution_,Object>

afterVariableChanged

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

Specified by:

afterVariableChanged in interface VariableListener<Solution_,Object>

getEntitiesMissingBeforeAfterEvents

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

demand

public VariableTracker<Solution_>.TrackerDemand demand()