Class AbstractCachingValueSelector<Solution_>
- java.lang.Object
-
- org.optaplanner.core.impl.heuristic.selector.AbstractSelector<Solution_>
-
- org.optaplanner.core.impl.heuristic.selector.value.AbstractValueSelector<Solution_>
-
- org.optaplanner.core.impl.heuristic.selector.value.decorator.AbstractCachingValueSelector<Solution_>
-
- All Implemented Interfaces:
EventListener,SelectionCacheLifecycleListener<Solution_>,Selector<Solution_>,ValueSelector<Solution_>,PhaseLifecycleListener<Solution_>,SolverLifecycleListener<Solution_>
- Direct Known Subclasses:
CachingValueSelector,ShufflingValueSelector,SortingValueSelector
public abstract class AbstractCachingValueSelector<Solution_> extends AbstractValueSelector<Solution_> implements SelectionCacheLifecycleListener<Solution_>
-
-
Field Summary
Fields Modifier and Type Field Description protected List<Object>cachedValueListprotected SelectionCacheTypecacheTypeprotected EntityIndependentValueSelector<Solution_>childValueSelector-
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, phaseLifecycleSupport, workingRandom
-
-
Constructor Summary
Constructors Constructor Description AbstractCachingValueSelector(EntityIndependentValueSelector<Solution_> childValueSelector, SelectionCacheType cacheType)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidconstructCache(SolverScope<Solution_> solverScope)voiddisposeCache(SolverScope<Solution_> solverScope)Iterator<Object>endingIterator()Iterator<Object>endingIterator(Object entity)IfSelector.isNeverEnding()is true, thenValueSelector.iterator(Object)will never end.SelectionCacheTypegetCacheType()Unless this selector itself caches, this returnsSelectionCacheType.JUST_IN_TIME, even if a selector child caches.ValueSelector<Solution_>getChildValueSelector()longgetSize()longgetSize(Object entity)Similar toIterableSelector.getSize(), but requires an entity.GenuineVariableDescriptor<Solution_>getVariableDescriptor()booleanisCountable()If false, thenSelector.isNeverEnding()is true.-
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, toString, 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.heuristic.selector.Selector
isNeverEnding
-
Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener
solvingEnded, solvingStarted
-
Methods inherited from interface org.optaplanner.core.impl.heuristic.selector.value.ValueSelector
iterator
-
-
-
-
Field Detail
-
childValueSelector
protected final EntityIndependentValueSelector<Solution_> childValueSelector
-
cacheType
protected final SelectionCacheType cacheType
-
-
Constructor Detail
-
AbstractCachingValueSelector
public AbstractCachingValueSelector(EntityIndependentValueSelector<Solution_> childValueSelector, SelectionCacheType cacheType)
-
-
Method Detail
-
getChildValueSelector
public ValueSelector<Solution_> getChildValueSelector()
-
getCacheType
public SelectionCacheType getCacheType()
Description copied from interface:SelectorUnless this selector itself caches, this returnsSelectionCacheType.JUST_IN_TIME, even if a selector child caches.- Specified by:
getCacheTypein interfaceSelector<Solution_>- Overrides:
getCacheTypein classAbstractSelector<Solution_>- Returns:
- never null
-
constructCache
public void constructCache(SolverScope<Solution_> solverScope)
- Specified by:
constructCachein interfaceSelectionCacheLifecycleListener<Solution_>
-
disposeCache
public void disposeCache(SolverScope<Solution_> solverScope)
- Specified by:
disposeCachein interfaceSelectionCacheLifecycleListener<Solution_>
-
getVariableDescriptor
public GenuineVariableDescriptor<Solution_> getVariableDescriptor()
- Specified by:
getVariableDescriptorin interfaceValueSelector<Solution_>- Returns:
- never null
-
isCountable
public boolean isCountable()
Description copied from interface:SelectorIf false, thenSelector.isNeverEnding()is true.- Specified by:
isCountablein interfaceSelector<Solution_>- Returns:
- true if all the
ValueRanges are countable (for example a double value range between 1.2 and 1.4 is not countable)
-
getSize
public long getSize(Object entity)
Description copied from interface:ValueSelectorSimilar toIterableSelector.getSize(), but requires an entity.- Specified by:
getSizein interfaceValueSelector<Solution_>- Parameters:
entity- never null- Returns:
- the approximate number of elements generated by this
Selector, always>= 0
-
getSize
public long getSize()
-
endingIterator
public Iterator<Object> endingIterator(Object entity)
Description copied from interface:ValueSelectorIfSelector.isNeverEnding()is true, thenValueSelector.iterator(Object)will never end. This returns an endingIterator, that tries to matchValueSelector.iterator(Object)as much as possible, but return each distinct element only once and therefore it might not respect the configuration of thisValueSelectorentirely.- Specified by:
endingIteratorin interfaceValueSelector<Solution_>- Parameters:
entity- never null- Returns:
- never null
- See Also:
ValueSelector.iterator(Object)
-
-