OptaPlanner core 6.0.1.Final

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

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.CachingEntitySelector
All Implemented Interfaces:
Iterable<Object>, EventListener, ListIterable<Object>, SelectionCacheLifecycleListener, EntitySelector, IterableSelector<Object>, ListIterableSelector<Object>, Selector, SolverPhaseLifecycleListener, SolverLifecycleListener

public class CachingEntitySelector
extends AbstractCachingEntitySelector

A EntitySelector that caches the result of its child EntitySelector.

Keep this code in sync with CachingValueSelector and CachingMoveSelector.


Field Summary
protected  boolean randomSelection
           
 
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, solverPhaseLifecycleSupport, workingRandom
 
Constructor Summary
CachingEntitySelector(EntitySelector childEntitySelector, SelectionCacheType cacheType, boolean randomSelection)
           
 
Method Summary
 boolean isNeverEnding()
          Is true if Selector.isContinuous() is true 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
constructCache, disposeCache, endingIterator, getCacheType, getChildEntitySelector, getEntityDescriptor, getSize, isContinuous
 
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.SolverPhaseLifecycleListener
phaseEnded, phaseStarted, stepEnded, stepStarted
 
Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener
solvingEnded, solvingStarted
 

Field Detail

randomSelection

protected final boolean randomSelection
Constructor Detail

CachingEntitySelector

public CachingEntitySelector(EntitySelector childEntitySelector,
                             SelectionCacheType cacheType,
                             boolean randomSelection)
Method Detail

isNeverEnding

public boolean isNeverEnding()
Description copied from interface: Selector
Is true if Selector.isContinuous() is true 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.

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.0.1.Final

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