Package org.optaplanner.core.impl.heuristic.selector.value.decorator

Class FilteringValueSelector<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.FilteringValueSelector<Solution_>

All Implemented Interfaces:

EventListener, Selector<Solution_>, ValueSelector<Solution_>, PhaseLifecycleListener<Solution_>, SolverLifecycleListener<Solution_>

Direct Known Subclasses:

EntityIndependentFilteringValueSelector

public class FilteringValueSelector<Solution_>
extends AbstractValueSelector<Solution_>

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<Solution_>	childValueSelector
protected List<SelectionFilter<Solution_,Object>>	filterList
protected ScoreDirector<Solution_>	scoreDirector

Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FilteringValueSelector(ValueSelector<Solution_> childValueSelector, List<SelectionFilter<Solution_,Object>> filterList)

Method Summary

Modifier and Type	Method	Description
protected boolean	accept(ScoreDirector<Solution_> scoreDirector, Object entity)
static <Solution_> ValueSelector<Solution_>	create(ValueSelector<Solution_> valueSelector, List<SelectionFilter<Solution_,Object>> filterList)
protected long	determineBailOutSize(Object entity)
Iterator<Object>	endingIterator(Object entity)	If Selector.isNeverEnding() is true, then ValueSelector.iterator(Object) will never end.
long	getSize(Object entity)	Similar to IterableSelector.getSize(), but requires an entity.
GenuineVariableDescriptor<Solution_>	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<Solution_> phaseScope)
void	phaseStarted(AbstractPhaseScope<Solution_> 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<Solution_> childValueSelector

filterList

protected final List<SelectionFilter<Solution_,Object>> filterList

bailOutEnabled

protected final boolean bailOutEnabled

scoreDirector

protected ScoreDirector<Solution_> scoreDirector

Constructor Detail

FilteringValueSelector

protected FilteringValueSelector(ValueSelector<Solution_> childValueSelector,
                                 List<SelectionFilter<Solution_,Object>> filterList)

Method Detail

create

public static <Solution_> ValueSelector<Solution_> create(ValueSelector<Solution_> valueSelector,
                                                          List<SelectionFilter<Solution_,Object>> filterList)

phaseStarted

public void phaseStarted(AbstractPhaseScope<Solution_> phaseScope)

Specified by:

phaseStarted in interface PhaseLifecycleListener<Solution_>

Overrides:

phaseStarted in class AbstractSelector<Solution_>

phaseEnded

public void phaseEnded(AbstractPhaseScope<Solution_> phaseScope)

Specified by:

phaseEnded in interface PhaseLifecycleListener<Solution_>

Overrides:

phaseEnded in class AbstractSelector<Solution_>

getVariableDescriptor

public GenuineVariableDescriptor<Solution_> getVariableDescriptor()

Returns:

never null

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).

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

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

endingIterator

public Iterator<Object> endingIterator(Object entity)

Description copied from interface: ValueSelector

If Selector.isNeverEnding() is true, then ValueSelector.iterator(Object) will never end. This returns an ending Iterator, that tries to match ValueSelector.iterator(Object) as much as possible, but return each distinct element only once and therefore it might not respect the configuration of this ValueSelector entirely.

Parameters:

entity - never null

Returns:

never null

See Also:

ValueSelector.iterator(Object)

determineBailOutSize

protected long determineBailOutSize(Object entity)

accept

protected boolean accept(ScoreDirector<Solution_> scoreDirector,
                         Object entity)

toString

public String toString()

Overrides:

toString in class Object