Class FilteringValueSelector<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.FilteringValueSelector<Solution_>
- All Implemented Interfaces:
EventListener
,Selector<Solution_>
,ValueSelector<Solution_>
,PhaseLifecycleListener<Solution_>
,SolverLifecycleListener<Solution_>
- Direct Known Subclasses:
EntityIndependentFilteringValueSelector
public class FilteringValueSelector<Solution_>
extends AbstractDemandEnabledSelector<Solution_>
implements ValueSelector<Solution_>
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected class
-
Field Summary
Modifier and TypeFieldDescriptionprotected final boolean
protected final ValueSelector<Solution_>
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, phaseLifecycleSupport, workingRandom
-
Constructor Summary
ModifierConstructorDescriptionprotected
FilteringValueSelector
(ValueSelector<Solution_> childValueSelector, List<SelectionFilter<Solution_, Object>> filterList) -
Method Summary
Modifier and TypeMethodDescriptionstatic <Solution_>
ValueSelector<Solution_>create
(ValueSelector<Solution_> valueSelector, List<SelectionFilter<Solution_, Object>> filterList) protected long
determineBailOutSize
(Object entity) endingIterator
(Object entity) IfSelector.isNeverEnding()
is true, thenValueSelector.iterator(Object)
will never end.boolean
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
getCacheType, 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.heuristic.selector.Selector
getCacheType
Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener
solvingEnded, solvingError, solvingStarted
-
Field Details
-
childValueSelector
-
bailOutEnabled
protected final boolean bailOutEnabled
-
-
Constructor Details
-
FilteringValueSelector
protected FilteringValueSelector(ValueSelector<Solution_> childValueSelector, List<SelectionFilter<Solution_, Object>> filterList)
-
-
Method Details
-
create
public static <Solution_> ValueSelector<Solution_> create(ValueSelector<Solution_> valueSelector, List<SelectionFilter<Solution_, Object>> filterList) -
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
-
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).
-
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
-
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:
-
determineBailOutSize
-
equals
- Specified by:
equals
in classAbstractDemandEnabledSelector<Solution_>
-
hashCode
public int hashCode()- Specified by:
hashCode
in classAbstractDemandEnabledSelector<Solution_>
-
toString
-