Package org.optaplanner.core.impl.domain.variable.anchor

Class ExternalizedAnchorVariableSupply<Solution_>

java.lang.Object

org.optaplanner.core.impl.domain.variable.anchor.ExternalizedAnchorVariableSupply<Solution_>

All Implemented Interfaces:

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

public class ExternalizedAnchorVariableSupply<Solution_>
extends Object
implements SourcedVariableListener<Solution_>, VariableListener<Solution_,Object>, AnchorVariableSupply

Alternative to AnchorVariableListener.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Object,Object>	anchorMap
protected final SingletonInverseVariableSupply	nextVariableSupply
protected final VariableDescriptor<Solution_>	previousVariableDescriptor

Constructor Summary

Constructors

Constructor	Description
ExternalizedAnchorVariableSupply(VariableDescriptor<Solution_> previousVariableDescriptor, SingletonInverseVariableSupply nextVariableSupply)

Method Summary

Modifier and Type	Method	Description
void	afterEntityAdded(ScoreDirector<Solution_> scoreDirector, Object entity)
void	afterEntityRemoved(ScoreDirector<Solution_> scoreDirector, Object entity)
void	afterVariableChanged(ScoreDirector<Solution_> scoreDirector, Object entity)
void	beforeEntityAdded(ScoreDirector<Solution_> scoreDirector, Object entity)
void	beforeEntityRemoved(ScoreDirector<Solution_> scoreDirector, Object entity)
void	beforeVariableChanged(ScoreDirector<Solution_> scoreDirector, Object entity)
void	close()	Called before this AbstractVariableListener is thrown away and not used anymore.
Object	getAnchor(Object entity)
VariableDescriptor<Solution_>	getSourceVariableDescriptor()
protected void	insert(Object entity)
void	resetWorkingSolution(ScoreDirector<Solution_> scoreDirector)	Called when the entire working solution changes.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.optaplanner.core.api.domain.variable.VariableListener

requiresUniqueEntityEvents

Field Details

previousVariableDescriptor

protected final VariableDescriptor<Solution_> previousVariableDescriptor

nextVariableSupply

protected final SingletonInverseVariableSupply nextVariableSupply

anchorMap

protected Map<Object,Object> anchorMap

Constructor Details

ExternalizedAnchorVariableSupply

public ExternalizedAnchorVariableSupply(VariableDescriptor<Solution_> previousVariableDescriptor,
 SingletonInverseVariableSupply nextVariableSupply)

Method Details

getSourceVariableDescriptor

public VariableDescriptor<Solution_> getSourceVariableDescriptor()

Specified by:

getSourceVariableDescriptor in interface SourcedVariableListener<Solution_>

resetWorkingSolution

public void resetWorkingSolution(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>

Parameters:

scoreDirector - never null

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(ScoreDirector<Solution_> scoreDirector,
 Object entity)

Specified by:

beforeEntityAdded in interface AbstractVariableListener<Solution_,Object>

Parameters:

scoreDirector - never null

entity - never null

afterEntityAdded

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

Specified by:

afterEntityAdded in interface AbstractVariableListener<Solution_,Object>

Parameters:

scoreDirector - never null

entity - never null

beforeVariableChanged

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

Specified by:

beforeVariableChanged in interface VariableListener<Solution_,Object>

Parameters:

scoreDirector - never null

entity - never null

afterVariableChanged

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

Specified by:

afterVariableChanged in interface VariableListener<Solution_,Object>

Parameters:

scoreDirector - never null

entity - never null

beforeEntityRemoved

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

Specified by:

beforeEntityRemoved in interface AbstractVariableListener<Solution_,Object>

Parameters:

scoreDirector - never null

entity - never null

afterEntityRemoved

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

Specified by:

afterEntityRemoved in interface AbstractVariableListener<Solution_,Object>

Parameters:

scoreDirector - never null

entity - never null

insert

protected void insert(Object entity)

getAnchor

public Object getAnchor(Object entity)

Specified by:

getAnchor in interface AnchorVariableSupply

Parameters:

entity - never null

Returns:

sometimes null, the anchor for the entity

toString

public String toString()

Overrides:

toString in class Object