Class FromEntityPropertyValueSelector<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.FromEntityPropertyValueSelector<Solution_>
-
- Type Parameters:
Solution_- the solution type, the class with thePlanningSolutionannotation
- All Implemented Interfaces:
EventListener,Selector<Solution_>,ValueSelector<Solution_>,PhaseLifecycleListener<Solution_>,SolverLifecycleListener<Solution_>
public class FromEntityPropertyValueSelector<Solution_> extends AbstractValueSelector<Solution_>
This is the commonValueSelectorimplementation.
-
-
Field Summary
Fields Modifier and Type Field Description protected booleanrandomSelectionprotected ValueRangeDescriptor<Solution_>valueRangeDescriptorprotected Solution_workingSolution-
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, phaseLifecycleSupport, workingRandom
-
-
Constructor Summary
Constructors Constructor Description FromEntityPropertyValueSelector(ValueRangeDescriptor<Solution_> valueRangeDescriptor, boolean randomSelection)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Iterator<Object>endingIterator(Object entity)IfSelector.isNeverEnding()is true, thenValueSelector.iterator(Object)will never end.longgetSize(Object entity)Similar toIterableSelector.getSize(), but requires an entity.GenuineVariableDescriptor<Solution_>getVariableDescriptor()booleanisCountable()If false, thenSelector.isNeverEnding()is true.booleanisNeverEnding()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.voidphaseEnded(AbstractPhaseScope<Solution_> phaseScope)voidphaseStarted(AbstractPhaseScope<Solution_> phaseScope)StringtoString()-
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
-
valueRangeDescriptor
protected final ValueRangeDescriptor<Solution_> valueRangeDescriptor
-
randomSelection
protected final boolean randomSelection
-
workingSolution
protected Solution_ workingSolution
-
-
Constructor Detail
-
FromEntityPropertyValueSelector
public FromEntityPropertyValueSelector(ValueRangeDescriptor<Solution_> valueRangeDescriptor, boolean randomSelection)
-
-
Method Detail
-
getVariableDescriptor
public GenuineVariableDescriptor<Solution_> getVariableDescriptor()
- Returns:
- never null
-
phaseStarted
public void phaseStarted(AbstractPhaseScope<Solution_> phaseScope)
- Specified by:
phaseStartedin interfacePhaseLifecycleListener<Solution_>- Overrides:
phaseStartedin classAbstractSelector<Solution_>
-
phaseEnded
public void phaseEnded(AbstractPhaseScope<Solution_> phaseScope)
- Specified by:
phaseEndedin interfacePhaseLifecycleListener<Solution_>- Overrides:
phaseEndedin classAbstractSelector<Solution_>
-
isCountable
public boolean isCountable()
Description copied from interface:SelectorIf false, thenSelector.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:SelectorIs 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 theIteratorcreated byIterable.iterator()never returns false (except when it's empty).
-
getSize
public long getSize(Object entity)
Description copied from interface:ValueSelectorSimilar 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:ValueSelectorSimilar toIterable.iterator(), but requires an entity.- Parameters:
entity- never null- Returns:
- never null
-
endingIterator
public Iterator<Object> endingIterator(Object entity)
Description copied from interface:ValueSelectorIfSelector.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 thisValueSelectorentirely.- Parameters:
entity- never null- Returns:
- never null
- See Also:
ValueSelector.iterator(Object)
-
-