org.optaplanner.core.impl.heuristic.selector.value
Interface ValueSelector

All Superinterfaces:

EventListener, PhaseLifecycleListener, Selector, SolverLifecycleListener

All Known Subinterfaces:

EntityIndependentValueSelector

All Known Implementing Classes:

AbstractCachingValueSelector, AbstractValueSelector, CachingValueSelector, DowncastingValueSelector, EntityDependentSortingValueSelector, FromEntityPropertyValueSelector, FromSolutionPropertyValueSelector, InitializedValueSelector, ProbabilityValueSelector, ReinitializeVariableValueSelector, SelectedCountLimitValueSelector, ShufflingValueSelector, SortingValueSelector

public interface ValueSelector
extends Selector

Selects values from the ValueRangeProvider) for a {@link PlanningVariable} annotated property.

See Also:

AbstractValueSelector

Method Summary

long	getSize(Object entity) Similar to IterableSelector.getSize(), but requires an entity.
GenuineVariableDescriptor	getVariableDescriptor()
Iterator<Object>	iterator(Object entity) Similar to Iterable.iterator(), but requires an entity.

Methods inherited from interface org.optaplanner.core.impl.heuristic.selector.Selector

getCacheType, isCountable, isNeverEnding

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

Method Detail

getSize

long getSize(Object entity)

Similar to IterableSelector.getSize(), but requires an entity.

Parameters:

entity - never null

Returns:

the approximate number of elements generated by this Selector, always >= 0

Throws:

IllegalStateException - if Selector.isCountable() returns false, but not if only Selector.isNeverEnding() returns true

iterator

Iterator<Object> iterator(Object entity)

Similar to Iterable.iterator(), but requires an entity.

Parameters:

entity - never null

Returns:

never null

getVariableDescriptor

GenuineVariableDescriptor getVariableDescriptor()

Returns:

never null