Class FilteringValueSelector
- java.lang.Object
-
- org.optaplanner.core.impl.heuristic.selector.AbstractSelector
-
- org.optaplanner.core.impl.heuristic.selector.value.AbstractValueSelector
-
- org.optaplanner.core.impl.heuristic.selector.value.decorator.FilteringValueSelector
-
- All Implemented Interfaces:
EventListener
,Selector
,ValueSelector
,PhaseLifecycleListener
,SolverLifecycleListener
- Direct Known Subclasses:
EntityIndependentFilteringValueSelector
public class FilteringValueSelector extends AbstractValueSelector
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
FilteringValueSelector.JustInTimeFilteringValueIterator
-
Field Summary
Fields Modifier and Type Field Description protected boolean
bailOutEnabled
protected ValueSelector
childValueSelector
protected List<SelectionFilter>
filterList
protected ScoreDirector
scoreDirector
-
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, phaseLifecycleSupport, workingRandom
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
FilteringValueSelector(ValueSelector childValueSelector, List<SelectionFilter> filterList)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
accept(ScoreDirector scoreDirector, Object entity)
static ValueSelector
create(ValueSelector valueSelector, List<SelectionFilter> filterList)
protected long
determineBailOutSize(Object entity)
Iterator<Object>
endingIterator(Object entity)
IfSelector.isNeverEnding()
is true, thenValueSelector.iterator(Object)
will never end.long
getSize(Object entity)
Similar toIterableSelector.getSize()
, but requires an entity.GenuineVariableDescriptor
getVariableDescriptor()
boolean
isCountable()
If false, thenSelector.isNeverEnding()
is true.boolean
isNeverEnding()
Is true ifSelector.isCountable()
is false or if this selector is in random order (for most cases).Iterator<Object>
iterator(Object entity)
Similar toIterable.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
getCacheType, 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.heuristic.selector.Selector
getCacheType
-
Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener
solvingEnded, solvingStarted
-
-
-
-
Field Detail
-
childValueSelector
protected final ValueSelector childValueSelector
-
filterList
protected final List<SelectionFilter> filterList
-
bailOutEnabled
protected final boolean bailOutEnabled
-
scoreDirector
protected ScoreDirector scoreDirector
-
-
Constructor Detail
-
FilteringValueSelector
protected FilteringValueSelector(ValueSelector childValueSelector, List<SelectionFilter> filterList)
-
-
Method Detail
-
create
public static ValueSelector create(ValueSelector valueSelector, List<SelectionFilter> filterList)
-
phaseStarted
public void phaseStarted(AbstractPhaseScope phaseScope)
- Specified by:
phaseStarted
in interfacePhaseLifecycleListener
- Overrides:
phaseStarted
in classAbstractSelector
-
phaseEnded
public void phaseEnded(AbstractPhaseScope phaseScope)
- Specified by:
phaseEnded
in interfacePhaseLifecycleListener
- Overrides:
phaseEnded
in classAbstractSelector
-
getVariableDescriptor
public GenuineVariableDescriptor getVariableDescriptor()
- Returns:
- never null
-
isCountable
public boolean isCountable()
Description copied from interface:Selector
If false, thenSelector.isNeverEnding()
is true.- 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).- Returns:
- true if the
Iterator.hasNext()
of theIterator
created byIterable.iterator()
never returns false (except when it's empty).
-
getSize
public long getSize(Object entity)
Description copied from interface:ValueSelector
Similar toIterableSelector.getSize()
, but requires an entity.- Parameters:
entity
- never null- Returns:
- the approximate number of elements generated by this
Selector
, always>= 0
-
iterator
public Iterator<Object> iterator(Object entity)
Description copied from interface:ValueSelector
Similar toIterable.iterator()
, but requires an entity.- Parameters:
entity
- never null- Returns:
- never null
-
endingIterator
public Iterator<Object> endingIterator(Object entity)
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.- Parameters:
entity
- never null- Returns:
- never null
- See Also:
ValueSelector.iterator(Object)
-
determineBailOutSize
protected long determineBailOutSize(Object entity)
-
accept
protected boolean accept(ScoreDirector scoreDirector, Object entity)
-
-