OptaPlanner core 6.2.0.Beta1

org.optaplanner.core.impl.heuristic.selector.value.decorator
Class EntityDependentSortingValueSelector

java.lang.Object
  extended by org.optaplanner.core.impl.heuristic.selector.AbstractSelector
      extended by org.optaplanner.core.impl.heuristic.selector.value.AbstractValueSelector
          extended by org.optaplanner.core.impl.heuristic.selector.value.decorator.EntityDependentSortingValueSelector
All Implemented Interfaces:
EventListener, Selector, ValueSelector, PhaseLifecycleListener, SolverLifecycleListener

public class EntityDependentSortingValueSelector
extends AbstractValueSelector


Field Summary
protected  SelectionCacheType cacheType
           
protected  ValueSelector childValueSelector
           
protected  ScoreDirector scoreDirector
           
protected  SelectionSorter sorter
           
 
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, phaseLifecycleSupport, workingRandom
 
Constructor Summary
EntityDependentSortingValueSelector(ValueSelector childValueSelector, SelectionCacheType cacheType, SelectionSorter sorter)
           
 
Method Summary
 SelectionCacheType getCacheType()
          Unless this selector itself caches, this returns SelectionCacheType.JUST_IN_TIME, even if a selector child caches.
 ValueSelector getChildValueSelector()
           
 long getSize(Object entity)
          Similar to IterableSelector.getSize(), but requires an entity.
 GenuineVariableDescriptor getVariableDescriptor()
           
 boolean isCountable()
          If false, then Selector.isNeverEnding() is true.
 boolean isNeverEnding()
          Is true if Selector.isCountable() is false or if this selector is in random order (for most cases).
 Iterator<Object> iterator(Object entity)
          Similar to Iterable.iterator(), but requires an entity.
 void phaseEnded(AbstractPhaseScope phaseScope)
           
 void phaseStarted(AbstractPhaseScope phaseScope)
           
 String toString()
           
 
Methods inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
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
stepEnded, stepStarted
 
Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener
solvingEnded, solvingStarted
 

Field Detail

childValueSelector

protected final ValueSelector childValueSelector

cacheType

protected final SelectionCacheType cacheType

sorter

protected final SelectionSorter sorter

scoreDirector

protected ScoreDirector scoreDirector
Constructor Detail

EntityDependentSortingValueSelector

public EntityDependentSortingValueSelector(ValueSelector childValueSelector,
                                           SelectionCacheType cacheType,
                                           SelectionSorter sorter)
Method Detail

getChildValueSelector

public ValueSelector getChildValueSelector()

getCacheType

public SelectionCacheType getCacheType()
Description copied from interface: Selector
Unless this selector itself caches, this returns SelectionCacheType.JUST_IN_TIME, even if a selector child caches.

Specified by:
getCacheType in interface Selector
Overrides:
getCacheType in class AbstractSelector
Returns:
never null

phaseStarted

public void phaseStarted(AbstractPhaseScope phaseScope)
Specified by:
phaseStarted in interface PhaseLifecycleListener
Overrides:
phaseStarted in class AbstractSelector

phaseEnded

public void phaseEnded(AbstractPhaseScope phaseScope)
Specified by:
phaseEnded in interface PhaseLifecycleListener
Overrides:
phaseEnded in class AbstractSelector

getVariableDescriptor

public GenuineVariableDescriptor getVariableDescriptor()
Returns:
never null

getSize

public long getSize(Object entity)
Description copied from interface: ValueSelector
Similar to IterableSelector.getSize(), but requires an entity.

Parameters:
entity - never null
Returns:
the approximate number of elements generated by this Selector, always >= 0

isCountable

public boolean isCountable()
Description copied from interface: Selector
If false, then Selector.isNeverEnding() is true.

Returns:
true if all the ValueRanges are countable (for example a double value range between 1.2 and 1.4 is not countable)

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(Object entity)
Description copied from interface: ValueSelector
Similar to Iterable.iterator(), but requires an entity.

Parameters:
entity - never null
Returns:
never null

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.