org.drools.planner.core.heuristic.selector.entity.decorator
Class FilteringEntitySelector

java.lang.Object
  extended by org.drools.planner.core.heuristic.selector.AbstractSelector
      extended by org.drools.planner.core.heuristic.selector.entity.AbstractEntitySelector
          extended by org.drools.planner.core.heuristic.selector.entity.decorator.FilteringEntitySelector
All Implemented Interfaces:
Iterable<Object>, EventListener, ListIterable<Object>, EntitySelector, Selector, SolverPhaseLifecycleListener, SolverLifecycleListener

public class FilteringEntitySelector
extends AbstractEntitySelector

TODO This class isn't used because EntitySelector's are upgraded to SelectionCacheType.STEP.


Field Summary
protected  boolean bailOutEnabled
           
protected  EntitySelector childEntitySelector
           
protected  List<SelectionFilter> entityFilterList
           
protected  ScoreDirector scoreDirector
           
 
Fields inherited from class org.drools.planner.core.heuristic.selector.AbstractSelector
logger, solverPhaseLifecycleSupport, workingRandom
 
Constructor Summary
FilteringEntitySelector(EntitySelector childEntitySelector, List<SelectionFilter> entityFilterList)
           
 
Method Summary
protected  long determineBailOutSize()
           
 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()
 void phaseEnded(AbstractSolverPhaseScope phaseScope)
           
 void phaseStarted(AbstractSolverPhaseScope phaseScope)
           
 String toString()
           
 
Methods inherited from class org.drools.planner.core.heuristic.selector.AbstractSelector
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.drools.planner.core.phase.event.SolverPhaseLifecycleListener
stepEnded, stepStarted
 
Methods inherited from interface org.drools.planner.core.solver.event.SolverLifecycleListener
solvingEnded, solvingStarted
 

Field Detail

childEntitySelector

protected final EntitySelector childEntitySelector

entityFilterList

protected final List<SelectionFilter> entityFilterList

bailOutEnabled

protected final boolean bailOutEnabled

scoreDirector

protected ScoreDirector scoreDirector
Constructor Detail

FilteringEntitySelector

public FilteringEntitySelector(EntitySelector childEntitySelector,
                               List<SelectionFilter> entityFilterList)
Method Detail

phaseStarted

public void phaseStarted(AbstractSolverPhaseScope phaseScope)
Specified by:
phaseStarted in interface SolverPhaseLifecycleListener
Overrides:
phaseStarted in class AbstractSelector

phaseEnded

public void phaseEnded(AbstractSolverPhaseScope phaseScope)
Specified by:
phaseEnded in interface SolverPhaseLifecycleListener
Overrides:
phaseEnded in class AbstractSelector

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: Selector
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()

determineBailOutSize

protected long determineBailOutSize()

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


Copyright © 2001-2012 JBoss by Red Hat. All Rights Reserved.