OptaPlanner core 6.0.0.CR2

org.optaplanner.core.impl.heuristic.selector.entity.mimic
Class MimicRecordingEntitySelector

java.lang.Object
  extended by org.optaplanner.core.impl.heuristic.selector.AbstractSelector
      extended by org.optaplanner.core.impl.heuristic.selector.entity.AbstractEntitySelector
          extended by org.optaplanner.core.impl.heuristic.selector.entity.mimic.MimicRecordingEntitySelector
All Implemented Interfaces:
Iterable<Object>, EventListener, ListIterable<Object>, EntitySelector, IterableSelector<Object>, ListIterableSelector<Object>, Selector, SolverPhaseLifecycleListener, SolverLifecycleListener

public class MimicRecordingEntitySelector
extends AbstractEntitySelector


Field Summary
protected  EntitySelector childEntitySelector
           
protected  List<MimicReplayingEntitySelector> replayingEntitySelectorList
           
 
Fields inherited from class org.optaplanner.core.impl.heuristic.selector.AbstractSelector
logger, solverPhaseLifecycleSupport, workingRandom
 
Constructor Summary
MimicRecordingEntitySelector(EntitySelector childEntitySelector)
           
 
Method Summary
 void addMimicReplayingEntitySelector(MimicReplayingEntitySelector replayingEntitySelector)
           
 Iterator<Object> endingIterator()
          If Selector.isNeverEnding() is true, then Iterable.iterator() will never end.
 PlanningEntityDescriptor getEntityDescriptor()
           
 long getSize()
          A random JIT Selector with Selector.isNeverEnding() true should return a size as if it would be able to return each distinct element only once, because the size can be used in SelectionProbabilityWeightFactory.
 boolean isContinuous()
          If true, then Selector.isNeverEnding() is also true.
 boolean isNeverEnding()
          Is true if Selector.isContinuous() is true or if this selector is in random order (for most cases).
 Iterator<Object> iterator()
           
 ListIterator<Object> listIterator()
          See List.listIterator()
 ListIterator<Object> listIterator(int index)
          See List.listIterator()
 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.SolverPhaseLifecycleListener
phaseEnded, phaseStarted, stepEnded, stepStarted
 
Methods inherited from interface org.optaplanner.core.impl.solver.event.SolverLifecycleListener
solvingEnded, solvingStarted
 

Field Detail

childEntitySelector

protected final EntitySelector childEntitySelector

replayingEntitySelectorList

protected final List<MimicReplayingEntitySelector> replayingEntitySelectorList
Constructor Detail

MimicRecordingEntitySelector

public MimicRecordingEntitySelector(EntitySelector childEntitySelector)
Method Detail

addMimicReplayingEntitySelector

public void addMimicReplayingEntitySelector(MimicReplayingEntitySelector replayingEntitySelector)

getEntityDescriptor

public PlanningEntityDescriptor getEntityDescriptor()
Returns:
never null

isContinuous

public boolean isContinuous()
Description copied from interface: Selector
If true, then Selector.isNeverEnding() is also true.

Returns:
true if any of the value ranges are continuous (as in for example every double value between 1.2 and 1.4)

isNeverEnding

public boolean isNeverEnding()
Description copied from interface: Selector
Is true if Selector.isContinuous() is true 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.

getSize

public long getSize()
Description copied from interface: IterableSelector
A random JIT Selector with Selector.isNeverEnding() true should return a size as if it would be able to return each distinct element only once, because the size can be used in SelectionProbabilityWeightFactory.

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

iterator

public Iterator<Object> iterator()

endingIterator

public Iterator<Object> endingIterator()
Description copied from interface: EntitySelector
If Selector.isNeverEnding() is true, then Iterable.iterator() will never end. This returns an ending Iterator, that tries to match Iterable.iterator() as much as possible, but might not respect the configuration of this EntitySelector entirely.

Returns:
never null
See Also:
Iterable.iterator()

listIterator

public ListIterator<Object> listIterator()
Description copied from interface: ListIterable
See List.listIterator()

Returns:
never null, see List.listIterator().

listIterator

public ListIterator<Object> listIterator(int index)
Description copied from interface: ListIterable
See List.listIterator()

Parameters:
index - lower than the size of this ListIterable, see List.listIterator(int).
Returns:
never null, see List.listIterator(int).

toString

public String toString()
Overrides:
toString in class Object

OptaPlanner core 6.0.0.CR2

Copyright © 2006-2013 JBoss by Red Hat. All Rights Reserved.