Package org.optaplanner.core.impl.heuristic.selector.entity.decorator

Class SortingEntitySelector<Solution_>

java.lang.Object

org.optaplanner.core.impl.heuristic.selector.AbstractSelector<Solution_>

org.optaplanner.core.impl.heuristic.selector.entity.AbstractEntitySelector<Solution_>

org.optaplanner.core.impl.heuristic.selector.entity.decorator.AbstractCachingEntitySelector<Solution_>

org.optaplanner.core.impl.heuristic.selector.entity.decorator.SortingEntitySelector<Solution_>

All Implemented Interfaces:

Iterable<Object>, EventListener, ListIterable<Object>, SelectionCacheLifecycleListener<Solution_>, EntitySelector<Solution_>, IterableSelector<Solution_,Object>, ListIterableSelector<Solution_,Object>, Selector<Solution_>, PhaseLifecycleListener<Solution_>, SolverLifecycleListener<Solution_>

public class SortingEntitySelector<Solution_>
extends AbstractCachingEntitySelector<Solution_>

Field Summary

Fields

Modifier and Type	Field	Description
protected SelectionSorter<Solution_,Object>	sorter

Fields inherited from class org.optaplanner.core.impl.heuristic.selector.entity.decorator.AbstractCachingEntitySelector

cachedEntityList, cacheType, childEntitySelector

Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Constructor	Description
SortingEntitySelector(EntitySelector<Solution_> childEntitySelector, SelectionCacheType cacheType, SelectionSorter<Solution_,Object> sorter)

Method Summary

Modifier and Type	Method	Description
void	constructCache(SolverScope<Solution_> solverScope)
boolean	isNeverEnding()	Is true if Selector.isCountable() is false or if this selector is in random order (for most cases).
Iterator<Object>	iterator()
ListIterator<Object>	listIterator()
ListIterator<Object>	listIterator(int index)
String	toString()

Methods inherited from class org.optaplanner.core.impl.heuristic.selector.entity.decorator.AbstractCachingEntitySelector

disposeCache, endingIterator, getCacheType, getChildEntitySelector, getEntityDescriptor, getSize, isCountable

Methods inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector

phaseEnded, phaseStarted, solvingEnded, solvingStarted, stepEnded, stepStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface org.optaplanner.core.impl.heuristic.selector.IterableSelector

spliterator

Methods inherited from interface org.optaplanner.core.impl.phase.event.PhaseLifecycleListener

phaseEnded, phaseStarted, stepEnded, stepStarted

Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener

solvingEnded, solvingStarted

Field Detail

sorter

protected final SelectionSorter<Solution_,Object> sorter

Constructor Detail

SortingEntitySelector

public SortingEntitySelector(EntitySelector<Solution_> childEntitySelector,
                             SelectionCacheType cacheType,
                             SelectionSorter<Solution_,Object> sorter)

Method Detail

constructCache

public void constructCache(SolverScope<Solution_> solverScope)

Specified by:

constructCache in interface SelectionCacheLifecycleListener<Solution_>

Overrides:

constructCache in class AbstractCachingEntitySelector<Solution_>

isNeverEnding

public boolean isNeverEnding()

Description copied from interface: Selector

Is true if Selector.isCountable() is false or if this selector is in random order (for most cases). Is never true when this selector is in shuffled order (which is less scalable but more exact).

Returns:

true if the Iterator.hasNext() of the Iterator created by Iterable.iterator() never returns false (except when it's empty).

iterator

public Iterator<Object> iterator()

listIterator

public ListIterator<Object> listIterator()

Returns:

never null, see List.listIterator().

See Also:

List.listIterator()

listIterator

public ListIterator<Object> listIterator(int index)

Parameters:

index - lower than the size of this ListIterable, see List.listIterator(int).

Returns:

never null, see List.listIterator(int).

See Also:

List.listIterator()

toString

public String toString()

Overrides:

toString in class Object