Class EntityDependentSortingValueSelector<Solution_>
java.lang.Object
org.optaplanner.core.impl.heuristic.selector.AbstractSelector<Solution_>
org.optaplanner.core.impl.heuristic.selector.AbstractDemandEnabledSelector<Solution_>
org.optaplanner.core.impl.heuristic.selector.value.decorator.EntityDependentSortingValueSelector<Solution_>
- All Implemented Interfaces:
EventListener
,Selector<Solution_>
,ValueSelector<Solution_>
,PhaseLifecycleListener<Solution_>
,SolverLifecycleListener<Solution_>
public final class EntityDependentSortingValueSelector<Solution_>
extends AbstractDemandEnabledSelector<Solution_>
implements ValueSelector<Solution_>
-
Field Summary
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, phaseLifecycleSupport, workingRandom
-
Constructor Summary
ConstructorDescriptionEntityDependentSortingValueSelector
(ValueSelector<Solution_> childValueSelector, SelectionCacheType cacheType, SelectionSorter<Solution_, Object> sorter) -
Method Summary
Modifier and TypeMethodDescriptionendingIterator
(Object entity) IfSelector.isNeverEnding()
is true, thenValueSelector.iterator(Object)
will never end.boolean
Unless this selector itself caches, this returnsSelectionCacheType.JUST_IN_TIME
, even if a selector child caches.long
Similar toIterableSelector.getSize()
, but requires an entity.int
hashCode()
boolean
If false, thenSelector.isNeverEnding()
is true.boolean
Is true ifSelector.isCountable()
is false or if this selector is in random order (for most cases).Similar toIterable.iterator()
, but requires an entity.void
phaseEnded
(AbstractPhaseScope<Solution_> phaseScope) void
phaseStarted
(AbstractPhaseScope<Solution_> phaseScope) toString()
Methods inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
solvingEnded, solvingStarted, stepEnded, stepStarted
Methods inherited from class java.lang.Object
clone, finalize, getClass, 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, solvingError, solvingStarted
-
Field Details
-
scoreDirector
-
-
Constructor Details
-
EntityDependentSortingValueSelector
public EntityDependentSortingValueSelector(ValueSelector<Solution_> childValueSelector, SelectionCacheType cacheType, SelectionSorter<Solution_, Object> sorter)
-
-
Method Details
-
getChildValueSelector
-
getCacheType
Description copied from interface:Selector
Unless this selector itself caches, this returnsSelectionCacheType.JUST_IN_TIME
, even if a selector child caches.- Specified by:
getCacheType
in interfaceSelector<Solution_>
- Overrides:
getCacheType
in classAbstractSelector<Solution_>
- Returns:
- never null
-
phaseStarted
- Specified by:
phaseStarted
in interfacePhaseLifecycleListener<Solution_>
- Overrides:
phaseStarted
in classAbstractSelector<Solution_>
-
phaseEnded
- Specified by:
phaseEnded
in interfacePhaseLifecycleListener<Solution_>
- Overrides:
phaseEnded
in classAbstractSelector<Solution_>
-
getVariableDescriptor
- Specified by:
getVariableDescriptor
in interfaceValueSelector<Solution_>
- Returns:
- never null
-
getSize
Description copied from interface:ValueSelector
Similar toIterableSelector.getSize()
, but requires an entity.- Specified by:
getSize
in interfaceValueSelector<Solution_>
- 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, thenSelector.isNeverEnding()
is true.- Specified by:
isCountable
in interfaceSelector<Solution_>
- Returns:
- true if all the
ValueRange
s 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 ifSelector.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).- Specified by:
isNeverEnding
in interfaceSelector<Solution_>
- Returns:
- true if the
Iterator.hasNext()
of theIterator
created byIterable.iterator()
never returns false (except when it's empty).
-
iterator
Description copied from interface:ValueSelector
Similar toIterable.iterator()
, but requires an entity.- Specified by:
iterator
in interfaceValueSelector<Solution_>
- Parameters:
entity
- never null- Returns:
- never null
-
endingIterator
Description copied from interface:ValueSelector
IfSelector.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 thisValueSelector
entirely.- Specified by:
endingIterator
in interfaceValueSelector<Solution_>
- Parameters:
entity
- never null- Returns:
- never null
- See Also:
-
equals
- Specified by:
equals
in classAbstractDemandEnabledSelector<Solution_>
-
hashCode
public int hashCode()- Specified by:
hashCode
in classAbstractDemandEnabledSelector<Solution_>
-
toString
-