OptaPlanner core 6.2.0.Beta1

org.optaplanner.core.impl.heuristic.selector.entity.decorator
Class SortingEntitySelector

java.lang.Object
  extended by org.optaplanner.core.impl.heuristic.selector.AbstractSelector
      extended by org.optaplanner.core.impl.heuristic.selector.entity.AbstractEntitySelector
          extended by org.optaplanner.core.impl.heuristic.selector.entity.decorator.AbstractCachingEntitySelector
              extended by org.optaplanner.core.impl.heuristic.selector.entity.decorator.SortingEntitySelector
All Implemented Interfaces:
Iterable<Object>, EventListener, ListIterable<Object>, SelectionCacheLifecycleListener, EntitySelector, IterableSelector<Object>, ListIterableSelector<Object>, Selector, PhaseLifecycleListener, SolverLifecycleListener

public class SortingEntitySelector
extends AbstractCachingEntitySelector


Field Summary
protected  SelectionSorter 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
SortingEntitySelector(EntitySelector childEntitySelector, SelectionCacheType cacheType, SelectionSorter sorter)
           
 
Method Summary
 void constructCache(DefaultSolverScope 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()
          See List.listIterator()
 ListIterator<Object> listIterator(int index)
          See List.listIterator()
 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 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 sorter
Constructor Detail

SortingEntitySelector

public SortingEntitySelector(EntitySelector childEntitySelector,
                             SelectionCacheType cacheType,
                             SelectionSorter sorter)
Method Detail

constructCache

public void constructCache(DefaultSolverScope solverScope)
Specified by:
constructCache in interface SelectionCacheLifecycleListener
Overrides:
constructCache in class AbstractCachingEntitySelector

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()
Description copied from interface: ListIterable
See List.listIterator()

Returns:
never null, see List.listIterator().

listIterator

public ListIterator<Object> listIterator(int index)
Description copied from interface: ListIterable
See List.listIterator()

Parameters:
index - lower than the size of this ListIterable, see List.listIterator(int).
Returns:
never null, see List.listIterator(int).

toString

public String toString()
Overrides:
toString in class Object

OptaPlanner core 6.2.0.Beta1

Copyright © 2006-2014 JBoss by Red Hat. All Rights Reserved.