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

Class ExternalizedIndexVariableSupply<Solution_>

java.lang.Object

org.optaplanner.core.impl.domain.variable.index.ExternalizedIndexVariableSupply<Solution_>

All Implemented Interfaces:

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

public class ExternalizedIndexVariableSupply<Solution_>
extends Object
implements SourcedVariableListener<Solution_>, ListVariableListener<Solution_,Object>, IndexVariableSupply

Alternative to IndexVariableListener.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Object,Integer>	indexMap
protected ListVariableDescriptor<Solution_>	sourceVariableDescriptor

Constructor Summary

Constructors

Constructor	Description
ExternalizedIndexVariableSupply(ListVariableDescriptor<Solution_> sourceVariableDescriptor)

Method Summary

Modifier and Type	Method	Description
void	afterElementAdded(ScoreDirector<Solution_> scoreDirector, Object entity, int index)
void	afterElementMoved(ScoreDirector<Solution_> scoreDirector, Object sourceEntity, int sourceIndex, Object destinationEntity, int destinationIndex)
void	afterElementRemoved(ScoreDirector<Solution_> scoreDirector, Object entity, int index)
void	afterEntityAdded(ScoreDirector<Solution_> scoreDirector, Object entity)
void	afterEntityRemoved(ScoreDirector<Solution_> scoreDirector, Object entity)
void	beforeElementAdded(ScoreDirector<Solution_> scoreDirector, Object entity, int index)
void	beforeElementMoved(ScoreDirector<Solution_> scoreDirector, Object sourceEntity, int sourceIndex, Object destinationEntity, int destinationIndex)
void	beforeElementRemoved(ScoreDirector<Solution_> scoreDirector, Object entity, int index)
void	beforeEntityAdded(ScoreDirector<Solution_> scoreDirector, Object entity)
void	beforeEntityRemoved(ScoreDirector<Solution_> scoreDirector, Object entity)
void	close()	Called before this AbstractVariableListener is thrown away and not used anymore.
Integer	getIndex(Object element)	Get planningValue's index in the list variable it is an element of.
VariableDescriptor<Solution_>	getSourceVariableDescriptor()
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.AbstractVariableListener

requiresUniqueEntityEvents

Field Detail

sourceVariableDescriptor

protected final ListVariableDescriptor<Solution_> sourceVariableDescriptor

indexMap

protected Map<Object,Integer> indexMap

Constructor Detail

ExternalizedIndexVariableSupply

public ExternalizedIndexVariableSupply(ListVariableDescriptor<Solution_> sourceVariableDescriptor)

Method Detail

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

beforeElementAdded

public void beforeElementAdded(ScoreDirector<Solution_> scoreDirector,
                               Object entity,
                               int index)

Specified by:

beforeElementAdded in interface ListVariableListener<Solution_,Object>

afterElementAdded

public void afterElementAdded(ScoreDirector<Solution_> scoreDirector,
                              Object entity,
                              int index)

Specified by:

afterElementAdded in interface ListVariableListener<Solution_,Object>

beforeElementRemoved

public void beforeElementRemoved(ScoreDirector<Solution_> scoreDirector,
                                 Object entity,
                                 int index)

Specified by:

beforeElementRemoved in interface ListVariableListener<Solution_,Object>

afterElementRemoved

public void afterElementRemoved(ScoreDirector<Solution_> scoreDirector,
                                Object entity,
                                int index)

Specified by:

afterElementRemoved in interface ListVariableListener<Solution_,Object>

beforeElementMoved

public void beforeElementMoved(ScoreDirector<Solution_> scoreDirector,
                               Object sourceEntity,
                               int sourceIndex,
                               Object destinationEntity,
                               int destinationIndex)

Specified by:

beforeElementMoved in interface ListVariableListener<Solution_,Object>

afterElementMoved

public void afterElementMoved(ScoreDirector<Solution_> scoreDirector,
                              Object sourceEntity,
                              int sourceIndex,
                              Object destinationEntity,
                              int destinationIndex)

Specified by:

afterElementMoved in interface ListVariableListener<Solution_,Object>

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

getIndex

public Integer getIndex(Object element)

Description copied from interface: IndexVariableSupply

Get planningValue's index in the list variable it is an element of.

Specified by:

getIndex in interface IndexVariableSupply

Parameters:

element - never null

Returns:

planningValue's index in the list variable it is an element of or null if the value is unassigned

toString

public String toString()

Overrides:

toString in class Object