org.optaplanner.core.config.heuristic.selector.entity
Class EntitySelectorConfig

java.lang.Object
  org.optaplanner.core.config.heuristic.selector.SelectorConfig
      org.optaplanner.core.config.heuristic.selector.entity.EntitySelectorConfig

public class EntitySelectorConfig
extends SelectorConfig

Field Summary

protected SelectionCacheType	cacheType
protected Class<?>	entityClass
protected List<Class<? extends SelectionFilter>>	filterClassList
protected Class<? extends SelectionProbabilityWeightFactory>	probabilityWeightFactoryClass
protected SelectionOrder	selectionOrder
protected Class<? extends SelectionSorter>	sorterClass
protected Class<? extends Comparator>	sorterComparatorClass
protected SelectionSorterOrder	sorterOrder
protected Class<? extends SelectionSorterWeightFactory>	sorterWeightFactoryClass

Constructor Summary

EntitySelectorConfig()

Method Summary

EntitySelector	buildEntitySelector(EnvironmentMode environmentMode, SolutionDescriptor solutionDescriptor, SelectionCacheType minimumCacheType, SelectionOrder inheritedSelectionOrder)
protected boolean	determineBaseRandomSelection(PlanningEntityDescriptor entityDescriptor, SelectionCacheType resolvedCacheType, SelectionOrder resolvedSelectionOrder)
SelectionCacheType	getCacheType()
Class<?>	getEntityClass()
List<Class<? extends SelectionFilter>>	getFilterClassList()
Class<? extends SelectionProbabilityWeightFactory>	getProbabilityWeightFactoryClass()
SelectionOrder	getSelectionOrder()
Class<? extends SelectionSorter>	getSorterClass()
Class<? extends Comparator>	getSorterComparatorClass()
SelectionSorterOrder	getSorterOrder()
Class<? extends SelectionSorterWeightFactory>	getSorterWeightFactoryClass()
void	inherit(EntitySelectorConfig inheritedConfig)
protected boolean	isBaseInherentlyCached()
void	setCacheType(SelectionCacheType cacheType)
void	setEntityClass(Class<?> entityClass)
void	setFilterClassList(List<Class<? extends SelectionFilter>> filterClassList)
void	setProbabilityWeightFactoryClass(Class<? extends SelectionProbabilityWeightFactory> probabilityWeightFactoryClass)
void	setSelectionOrder(SelectionOrder selectionOrder)
void	setSorterClass(Class<? extends SelectionSorter> sorterClass)
void	setSorterComparatorClass(Class<? extends Comparator> sorterComparatorClass)
void	setSorterOrder(SelectionSorterOrder sorterOrder)
void	setSorterWeightFactoryClass(Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)
String	toString()

Methods inherited from class org.optaplanner.core.config.heuristic.selector.SelectorConfig

deduceEntityDescriptor, deduceVariableDescriptor, deduceVariableDescriptors, inherit, validateCacheTypeVersusSelectionOrder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

entityClass

protected Class<?> entityClass

cacheType

protected SelectionCacheType cacheType

selectionOrder

protected SelectionOrder selectionOrder

filterClassList

protected List<Class<? extends SelectionFilter>> filterClassList

sorterComparatorClass

protected Class<? extends Comparator> sorterComparatorClass

sorterWeightFactoryClass

protected Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass

sorterOrder

protected SelectionSorterOrder sorterOrder

sorterClass

protected Class<? extends SelectionSorter> sorterClass

probabilityWeightFactoryClass

protected Class<? extends SelectionProbabilityWeightFactory> probabilityWeightFactoryClass

Constructor Detail

EntitySelectorConfig

public EntitySelectorConfig()

Method Detail

getEntityClass

public Class<?> getEntityClass()

setEntityClass

public void setEntityClass(Class<?> entityClass)

getCacheType

public SelectionCacheType getCacheType()

setCacheType

public void setCacheType(SelectionCacheType cacheType)

getSelectionOrder

public SelectionOrder getSelectionOrder()

setSelectionOrder

public void setSelectionOrder(SelectionOrder selectionOrder)

getFilterClassList

public List<Class<? extends SelectionFilter>> getFilterClassList()

setFilterClassList

public void setFilterClassList(List<Class<? extends SelectionFilter>> filterClassList)

getSorterComparatorClass

public Class<? extends Comparator> getSorterComparatorClass()

setSorterComparatorClass

public void setSorterComparatorClass(Class<? extends Comparator> sorterComparatorClass)

getSorterWeightFactoryClass

public Class<? extends SelectionSorterWeightFactory> getSorterWeightFactoryClass()

setSorterWeightFactoryClass

public void setSorterWeightFactoryClass(Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)

getSorterOrder

public SelectionSorterOrder getSorterOrder()

setSorterOrder

public void setSorterOrder(SelectionSorterOrder sorterOrder)

getSorterClass

public Class<? extends SelectionSorter> getSorterClass()

setSorterClass

public void setSorterClass(Class<? extends SelectionSorter> sorterClass)

getProbabilityWeightFactoryClass

public Class<? extends SelectionProbabilityWeightFactory> getProbabilityWeightFactoryClass()

setProbabilityWeightFactoryClass

public void setProbabilityWeightFactoryClass(Class<? extends SelectionProbabilityWeightFactory> probabilityWeightFactoryClass)

buildEntitySelector

public EntitySelector buildEntitySelector(EnvironmentMode environmentMode,
                                          SolutionDescriptor solutionDescriptor,
                                          SelectionCacheType minimumCacheType,
                                          SelectionOrder inheritedSelectionOrder)

Parameters:

environmentMode - never null

solutionDescriptor - never null

minimumCacheType - never null, If caching is used (different from SelectionCacheType.JUST_IN_TIME), then it should be at least this SelectionCacheType because an ancestor already uses such caching and less would be pointless.

inheritedSelectionOrder - never null

Returns:

never null

determineBaseRandomSelection

protected boolean determineBaseRandomSelection(PlanningEntityDescriptor entityDescriptor,
                                               SelectionCacheType resolvedCacheType,
                                               SelectionOrder resolvedSelectionOrder)

isBaseInherentlyCached

protected boolean isBaseInherentlyCached()

inherit

public void inherit(EntitySelectorConfig inheritedConfig)

toString

public String toString()

Overrides:

toString in class SelectorConfig