Package ai.timefold.solver.core.impl.domain.variable.inverserelation

Class ExternalizedSingletonInverseVariableSupply<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.domain.variable.inverserelation.ExternalizedSingletonInverseVariableSupply<Solution_>

All Implemented Interfaces:

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

public class ExternalizedSingletonInverseVariableSupply<Solution_>
extends Object
implements SourcedVariableListener<Solution_>, VariableListener<Solution_,Object>, SingletonInverseVariableSupply

Alternative to SingletonInverseVariableListener.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Object,Object>	inverseEntityMap
protected final VariableDescriptor<Solution_>	sourceVariableDescriptor

Constructor Summary

Constructors

Constructor	Description
ExternalizedSingletonInverseVariableSupply(VariableDescriptor<Solution_> sourceVariableDescriptor)

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	afterVariableChanged(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object entity)
void	beforeEntityAdded(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object entity)
void	beforeEntityRemoved(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object entity)
void	beforeVariableChanged(@NonNull ScoreDirector<Solution_> scoreDirector, @NonNull Object entity)
void	close()	Called before this AbstractVariableListener is thrown away and not used anymore.
Object	getInverseSingleton(Object value)	If entity1.varA = x then the inverse of x is entity1.
VariableDescriptor<Solution_>	getSourceVariableDescriptor()
protected void	insert(Object entity)
void	resetWorkingSolution(@NonNull ScoreDirector<Solution_> scoreDirector)	Called when the entire working solution changes.
protected void	retract(Object entity)
String	toString()

Methods inherited from class java.lang.Object

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

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

requiresUniqueEntityEvents

Field Details

sourceVariableDescriptor

protected final VariableDescriptor<Solution_> sourceVariableDescriptor

inverseEntityMap

protected Map<Object,Object> inverseEntityMap

Constructor Details

ExternalizedSingletonInverseVariableSupply

public ExternalizedSingletonInverseVariableSupply(VariableDescriptor<Solution_> sourceVariableDescriptor)

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>

close

public void close()

Description copied from interface: AbstractVariableListener

Called before this AbstractVariableListener is thrown away and not used anymore.

Specified by:

close in interface AbstractVariableListener<Solution_,Object>

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

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>

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>

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>

insert

protected void insert(Object entity)

retract

protected void retract(Object entity)

getInverseSingleton

public Object getInverseSingleton(Object value)

Description copied from interface: SingletonInverseVariableSupply

If entity1.varA = x then the inverse of x is entity1.

Specified by:

getInverseSingleton in interface SingletonInverseVariableSupply

Parameters:

value - never null

Returns:

sometimes null, an entity for which the planning variable is the planningValue.

toString

public String toString()

Overrides:

toString in class Object