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

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

All Implemented Interfaces:

EventListener, Selector, ValueSelector, PhaseLifecycleListener, SolverLifecycleListener

public class InitializedValueSelector
extends AbstractValueSelector

Prevents creating chains without an anchor.

Filters out every value that is a planning entity for which the planning variable (on which this ValueSelector applies to) is uninitialized.

Mainly used for chained planning variables, but supports other planning variables too.

Field Summary

protected boolean	bailOutEnabled
protected ValueSelector	childValueSelector
protected GenuineVariableDescriptor	variableDescriptor

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

logger, phaseLifecycleSupport, workingRandom

Constructor Summary

InitializedValueSelector(ValueSelector childValueSelector)

Method Summary

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	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.
String	toString()

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

getCacheType, phaseEnded, phaseStarted, 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.heuristic.selector.Selector

getCacheType

Methods inherited from interface org.optaplanner.core.impl.phase.event.PhaseLifecycleListener

phaseEnded, phaseStarted, stepEnded, stepStarted

Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener

solvingEnded, solvingStarted

Field Detail

variableDescriptor

protected final GenuineVariableDescriptor variableDescriptor

childValueSelector

protected final ValueSelector childValueSelector

bailOutEnabled

protected final boolean bailOutEnabled

Constructor Detail

InitializedValueSelector

public InitializedValueSelector(ValueSelector childValueSelector)

Method Detail

getVariableDescriptor

public GenuineVariableDescriptor 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.

Returns:

never null

See Also:

ValueSelector.iterator(Object)

determineBailOutSize

protected long determineBailOutSize(Object entity)

toString

public String toString()

Overrides:

toString in class Object