Package ai.timefold.solver.core.config.heuristic.selector.value

Class ValueSelectorConfig

java.lang.Object

ai.timefold.solver.core.config.AbstractConfig<Config_>

ai.timefold.solver.core.config.heuristic.selector.SelectorConfig<ValueSelectorConfig>

ai.timefold.solver.core.config.heuristic.selector.value.ValueSelectorConfig

public class ValueSelectorConfig
extends SelectorConfig<ValueSelectorConfig>

Field Summary

Fields

Modifier and Type	Field	Description
protected SelectionCacheType	cacheType
protected Class<?>	downcastEntityClass
protected Class<? extends SelectionFilter>	filterClass
protected String	id
protected String	mimicSelectorRef
protected NearbySelectionConfig	nearbySelectionConfig
protected Class<? extends SelectionProbabilityWeightFactory>	probabilityWeightFactoryClass
protected Long	selectedCountLimit
protected SelectionOrder	selectionOrder
protected Class<? extends SelectionSorter>	sorterClass
protected Class<? extends Comparator>	sorterComparatorClass
protected ValueSorterManner	sorterManner
protected SelectionSorterOrder	sorterOrder
protected Class<? extends SelectionSorterWeightFactory>	sorterWeightFactoryClass
protected String	variableName

Constructor Summary

Constructors

Constructor	Description
ValueSelectorConfig()
ValueSelectorConfig(ValueSelectorConfig inheritedConfig)
ValueSelectorConfig(String variableName)

Method Summary

Modifier and Type	Method	Description
ValueSelectorConfig	copyConfig()	Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.
static <Solution_> SelectionSorter<Solution_,Object>	determineSorter(ValueSorterManner valueSorterManner, GenuineVariableDescriptor<Solution_> variableDescriptor)
SelectionCacheType	getCacheType()
Class<?>	getDowncastEntityClass()
Class<? extends SelectionFilter>	getFilterClass()
String	getId()
String	getMimicSelectorRef()
NearbySelectionConfig	getNearbySelectionConfig()
Class<? extends SelectionProbabilityWeightFactory>	getProbabilityWeightFactoryClass()
Long	getSelectedCountLimit()
SelectionOrder	getSelectionOrder()
Class<? extends SelectionSorter>	getSorterClass()
Class<? extends Comparator>	getSorterComparatorClass()
ValueSorterManner	getSorterManner()
SelectionSorterOrder	getSorterOrder()
Class<? extends SelectionSorterWeightFactory>	getSorterWeightFactoryClass()
String	getVariableName()
boolean	hasNearbySelectionConfig()	Verifies if the current configuration has any Nearby Selection settings.
static <Solution_> boolean	hasSorter(ValueSorterManner valueSorterManner, GenuineVariableDescriptor<Solution_> variableDescriptor)
ValueSelectorConfig	inherit(ValueSelectorConfig inheritedConfig)	Inherits each property of the inheritedConfig unless that property (or a semantic alternative) is defined by this instance (which overwrites the inherited behaviour).
void	setCacheType(SelectionCacheType cacheType)
void	setDowncastEntityClass(Class<?> downcastEntityClass)
void	setFilterClass(Class<? extends SelectionFilter> filterClass)
void	setId(String id)
void	setMimicSelectorRef(String mimicSelectorRef)
void	setNearbySelectionConfig(NearbySelectionConfig nearbySelectionConfig)
void	setProbabilityWeightFactoryClass(Class<? extends SelectionProbabilityWeightFactory> probabilityWeightFactoryClass)
void	setSelectedCountLimit(Long selectedCountLimit)
void	setSelectionOrder(SelectionOrder selectionOrder)
void	setSorterClass(Class<? extends SelectionSorter> sorterClass)
void	setSorterComparatorClass(Class<? extends Comparator> sorterComparatorClass)
void	setSorterManner(ValueSorterManner sorterManner)
void	setSorterOrder(SelectionSorterOrder sorterOrder)
void	setSorterWeightFactoryClass(Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)
void	setVariableName(String variableName)
String	toString()
void	visitReferencedClasses(Consumer<Class<?>> classVisitor)	Call the class visitor on each (possibly null) Class instance provided to this config by the user (including those provided in child configs).
ValueSelectorConfig	withCacheType(SelectionCacheType cacheType)
ValueSelectorConfig	withDowncastEntityClass(Class<?> entityClass)
ValueSelectorConfig	withFilterClass(Class<? extends SelectionFilter> filterClass)
ValueSelectorConfig	withId(String id)
ValueSelectorConfig	withMimicSelectorRef(String mimicSelectorRef)
ValueSelectorConfig	withNearbySelectionConfig(NearbySelectionConfig nearbySelectionConfig)
ValueSelectorConfig	withProbabilityWeightFactoryClass(Class<? extends SelectionProbabilityWeightFactory> factoryClass)
ValueSelectorConfig	withSelectedCountLimit(long selectedCountLimit)
ValueSelectorConfig	withSelectionOrder(SelectionOrder selectionOrder)
ValueSelectorConfig	withSorterClass(Class<? extends SelectionSorter> sorterClass)
ValueSelectorConfig	withSorterComparatorClass(Class<? extends Comparator> comparatorClass)
ValueSelectorConfig	withSorterManner(ValueSorterManner sorterManner)
ValueSelectorConfig	withSorterOrder(SelectionSorterOrder sorterOrder)
ValueSelectorConfig	withSorterWeightFactoryClass(Class<? extends SelectionSorterWeightFactory> weightFactoryClass)
ValueSelectorConfig	withVariableName(String variableName)

Methods inherited from class java.lang.Object

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

Field Details

id

protected String id

mimicSelectorRef

protected String mimicSelectorRef

downcastEntityClass

protected Class<?> downcastEntityClass

variableName

protected String variableName

cacheType

protected SelectionCacheType cacheType

selectionOrder

protected SelectionOrder selectionOrder

nearbySelectionConfig

protected NearbySelectionConfig nearbySelectionConfig

filterClass

protected Class<? extends SelectionFilter> filterClass

sorterManner

protected ValueSorterManner sorterManner

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

selectedCountLimit

protected Long selectedCountLimit

Constructor Details

ValueSelectorConfig

public ValueSelectorConfig()

ValueSelectorConfig

public ValueSelectorConfig(String variableName)

ValueSelectorConfig

public ValueSelectorConfig(ValueSelectorConfig inheritedConfig)

Method Details

getId

public String getId()

setId

public void setId(String id)

getMimicSelectorRef

public String getMimicSelectorRef()

setMimicSelectorRef

public void setMimicSelectorRef(String mimicSelectorRef)

getDowncastEntityClass

public Class<?> getDowncastEntityClass()

setDowncastEntityClass

public void setDowncastEntityClass(Class<?> downcastEntityClass)

getVariableName

public String getVariableName()

setVariableName

public void setVariableName(String variableName)

getCacheType

public SelectionCacheType getCacheType()

setCacheType

public void setCacheType(SelectionCacheType cacheType)

getSelectionOrder

public SelectionOrder getSelectionOrder()

setSelectionOrder

public void setSelectionOrder(SelectionOrder selectionOrder)

getNearbySelectionConfig

public NearbySelectionConfig getNearbySelectionConfig()

setNearbySelectionConfig

public void setNearbySelectionConfig(NearbySelectionConfig nearbySelectionConfig)

getFilterClass

public Class<? extends SelectionFilter> getFilterClass()

setFilterClass

public void setFilterClass(Class<? extends SelectionFilter> filterClass)

getSorterManner

public ValueSorterManner getSorterManner()

setSorterManner

public void setSorterManner(ValueSorterManner sorterManner)

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)

getSelectedCountLimit

public Long getSelectedCountLimit()

setSelectedCountLimit

public void setSelectedCountLimit(Long selectedCountLimit)

withId

public ValueSelectorConfig withId(String id)

withMimicSelectorRef

public ValueSelectorConfig withMimicSelectorRef(String mimicSelectorRef)

withDowncastEntityClass

public ValueSelectorConfig withDowncastEntityClass(Class<?> entityClass)

withVariableName

public ValueSelectorConfig withVariableName(String variableName)

withCacheType

public ValueSelectorConfig withCacheType(SelectionCacheType cacheType)

withSelectionOrder

public ValueSelectorConfig withSelectionOrder(SelectionOrder selectionOrder)

withNearbySelectionConfig

public ValueSelectorConfig withNearbySelectionConfig(NearbySelectionConfig nearbySelectionConfig)

withFilterClass

public ValueSelectorConfig withFilterClass(Class<? extends SelectionFilter> filterClass)

withSorterManner

public ValueSelectorConfig withSorterManner(ValueSorterManner sorterManner)

withSorterComparatorClass

public ValueSelectorConfig withSorterComparatorClass(Class<? extends Comparator> comparatorClass)

withSorterWeightFactoryClass

public ValueSelectorConfig withSorterWeightFactoryClass(Class<? extends SelectionSorterWeightFactory> weightFactoryClass)

withSorterOrder

public ValueSelectorConfig withSorterOrder(SelectionSorterOrder sorterOrder)

withSorterClass

public ValueSelectorConfig withSorterClass(Class<? extends SelectionSorter> sorterClass)

withProbabilityWeightFactoryClass

public ValueSelectorConfig withProbabilityWeightFactoryClass(Class<? extends SelectionProbabilityWeightFactory> factoryClass)

withSelectedCountLimit

public ValueSelectorConfig withSelectedCountLimit(long selectedCountLimit)

inherit

public ValueSelectorConfig inherit(ValueSelectorConfig inheritedConfig)

Description copied from class: AbstractConfig

Inherits each property of the inheritedConfig unless that property (or a semantic alternative) is defined by this instance (which overwrites the inherited behaviour).

After the inheritance, if a property on this AbstractConfig composition is replaced, it should not affect the inherited composition instance.

Specified by:

inherit in class AbstractConfig<ValueSelectorConfig>

Parameters:

inheritedConfig - never null

Returns:

this

copyConfig

public ValueSelectorConfig copyConfig()

Description copied from class: AbstractConfig

Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.

Specified by:

copyConfig in class AbstractConfig<ValueSelectorConfig>

Returns:

new instance

visitReferencedClasses

public void visitReferencedClasses(Consumer<Class<?>> classVisitor)

Description copied from class: AbstractConfig

Call the class visitor on each (possibly null) Class instance provided to this config by the user (including those provided in child configs). Required to create the bean factory in Quarkus.

Specified by:

visitReferencedClasses in class AbstractConfig<ValueSelectorConfig>

Parameters:

classVisitor - The visitor of classes, never null. Can accept null instances of Class.

toString

public String toString()

Overrides:

toString in class AbstractConfig<ValueSelectorConfig>

hasSorter

public static <Solution_> boolean hasSorter(ValueSorterManner valueSorterManner,
 GenuineVariableDescriptor<Solution_> variableDescriptor)

determineSorter

public static <Solution_>
SelectionSorter<Solution_,Object> determineSorter(ValueSorterManner valueSorterManner,
 GenuineVariableDescriptor<Solution_> variableDescriptor)

hasNearbySelectionConfig

public boolean hasNearbySelectionConfig()

Description copied from class: SelectorConfig

Verifies if the current configuration has any Nearby Selection settings.

Specified by:

hasNearbySelectionConfig in class SelectorConfig<ValueSelectorConfig>