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

Class CollectionInverseVariableListener<Solution_>

java.lang.Object

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

All Implemented Interfaces:

InnerBasicVariableListener<Solution_,Object>, InnerVariableListener<Solution_,BasicVariableChangeEvent<Object>>, CollectionInverseVariableSupply, Supply, Closeable, AutoCloseable

public class CollectionInverseVariableListener<Solution_>
extends Object
implements InnerBasicVariableListener<Solution_,Object>, CollectionInverseVariableSupply

Field Summary

Fields

Modifier and Type	Field	Description
protected final InverseRelationShadowVariableDescriptor<Solution_>	shadowVariableDescriptor
protected final VariableDescriptor<Solution_>	sourceVariableDescriptor

Constructor Summary

Constructors

Constructor	Description
CollectionInverseVariableListener(InverseRelationShadowVariableDescriptor<Solution_> shadowVariableDescriptor, VariableDescriptor<Solution_> sourceVariableDescriptor)

Method Summary

Modifier and Type	Method	Description
void	afterChange(InnerScoreDirector<Solution_,?> scoreDirector, BasicVariableChangeEvent<Object> event)
void	beforeChange(InnerScoreDirector<Solution_,?> scoreDirector, BasicVariableChangeEvent<Object> event)
Collection<?>	getInverseCollection(Object planningValue)	If entity1.varA = x then an inverse of x is entity1.
protected void	insert(InnerScoreDirector<Solution_,?> scoreDirector, Object entity)
void	resetWorkingSolution(InnerScoreDirector<Solution_,?> scoreDirector)	Called when the entire working solution changes.
protected void	retract(InnerScoreDirector<Solution_,?> scoreDirector, Object entity)

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.impl.domain.variable.InnerVariableListener

close, requiresUniqueEntityEvents

Field Details

shadowVariableDescriptor

protected final InverseRelationShadowVariableDescriptor<Solution_> shadowVariableDescriptor

sourceVariableDescriptor

protected final VariableDescriptor<Solution_> sourceVariableDescriptor

Constructor Details

CollectionInverseVariableListener

public CollectionInverseVariableListener(InverseRelationShadowVariableDescriptor<Solution_> shadowVariableDescriptor,
 VariableDescriptor<Solution_> sourceVariableDescriptor)

Method Details

resetWorkingSolution

public void resetWorkingSolution(InnerScoreDirector<Solution_,?> scoreDirector)

Description copied from interface: InnerVariableListener

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 InnerVariableListener<Solution_,BasicVariableChangeEvent<Object>>

beforeChange

public void beforeChange(InnerScoreDirector<Solution_,?> scoreDirector,
 BasicVariableChangeEvent<Object> event)

Specified by:

beforeChange in interface InnerVariableListener<Solution_,BasicVariableChangeEvent<Object>>

afterChange

public void afterChange(InnerScoreDirector<Solution_,?> scoreDirector,
 BasicVariableChangeEvent<Object> event)

Specified by:

afterChange in interface InnerVariableListener<Solution_,BasicVariableChangeEvent<Object>>

insert

protected void insert(InnerScoreDirector<Solution_,?> scoreDirector,
 Object entity)

retract

protected void retract(InnerScoreDirector<Solution_,?> scoreDirector,
 Object entity)

getInverseCollection

public Collection<?> getInverseCollection(Object planningValue)

Description copied from interface: CollectionInverseVariableSupply

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

Specified by:

getInverseCollection in interface CollectionInverseVariableSupply

Parameters:

planningValue - never null

Returns:

never null, a Collection of entities for which the planning variable is the planningValue.