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(@NonNull String variableName)
ValueSelectorConfig(@Nullable ValueSelectorConfig inheritedConfig)

Method Summary

Modifier and Type	Method	Description
@NonNull ValueSelectorConfig	copyConfig()	Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.
static <Solution_> @NonNull SelectionSorter<Solution_,Object>	determineSorter(@NonNull ValueSorterManner valueSorterManner, @NonNull GenuineVariableDescriptor<Solution_> variableDescriptor)
@Nullable SelectionCacheType	getCacheType()
@Nullable Class<?>	getDowncastEntityClass()
@Nullable Class<? extends SelectionFilter>	getFilterClass()
@Nullable String	getId()
@Nullable String	getMimicSelectorRef()
@Nullable NearbySelectionConfig	getNearbySelectionConfig()
@Nullable Class<? extends SelectionProbabilityWeightFactory>	getProbabilityWeightFactoryClass()
@Nullable Long	getSelectedCountLimit()
@Nullable SelectionOrder	getSelectionOrder()
@Nullable Class<? extends SelectionSorter>	getSorterClass()
@Nullable Class<? extends Comparator>	getSorterComparatorClass()
@Nullable ValueSorterManner	getSorterManner()
@Nullable SelectionSorterOrder	getSorterOrder()
@Nullable Class<? extends SelectionSorterWeightFactory>	getSorterWeightFactoryClass()
@Nullable String	getVariableName()
boolean	hasNearbySelectionConfig()	Verifies if the current configuration has any Nearby Selection settings.
static <Solution_> boolean	hasSorter(@NonNull ValueSorterManner valueSorterManner, @NonNull GenuineVariableDescriptor<Solution_> variableDescriptor)
@NonNull ValueSelectorConfig	inherit(@NonNull 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(@Nullable SelectionCacheType cacheType)
void	setDowncastEntityClass(@Nullable Class<?> downcastEntityClass)
void	setFilterClass(@Nullable Class<? extends SelectionFilter> filterClass)
void	setId(@Nullable String id)
void	setMimicSelectorRef(@Nullable String mimicSelectorRef)
void	setNearbySelectionConfig(@Nullable NearbySelectionConfig nearbySelectionConfig)
void	setProbabilityWeightFactoryClass(@Nullable Class<? extends SelectionProbabilityWeightFactory> probabilityWeightFactoryClass)
void	setSelectedCountLimit(@Nullable Long selectedCountLimit)
void	setSelectionOrder(@Nullable SelectionOrder selectionOrder)
void	setSorterClass(@Nullable Class<? extends SelectionSorter> sorterClass)
void	setSorterComparatorClass(@Nullable Class<? extends Comparator> sorterComparatorClass)
void	setSorterManner(@Nullable ValueSorterManner sorterManner)
void	setSorterOrder(@Nullable SelectionSorterOrder sorterOrder)
void	setSorterWeightFactoryClass(@Nullable Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)
void	setVariableName(@Nullable String variableName)
String	toString()
void	visitReferencedClasses(@NonNull 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).
@NonNull ValueSelectorConfig	withCacheType(@NonNull SelectionCacheType cacheType)
@NonNull ValueSelectorConfig	withDowncastEntityClass(@NonNull Class<?> entityClass)
@NonNull ValueSelectorConfig	withFilterClass(@NonNull Class<? extends SelectionFilter> filterClass)
@NonNull ValueSelectorConfig	withId(@NonNull String id)
@NonNull ValueSelectorConfig	withMimicSelectorRef(@NonNull String mimicSelectorRef)
@NonNull ValueSelectorConfig	withNearbySelectionConfig(@NonNull NearbySelectionConfig nearbySelectionConfig)
@NonNull ValueSelectorConfig	withProbabilityWeightFactoryClass(@NonNull Class<? extends SelectionProbabilityWeightFactory> factoryClass)
@NonNull ValueSelectorConfig	withSelectedCountLimit(long selectedCountLimit)
@NonNull ValueSelectorConfig	withSelectionOrder(@NonNull SelectionOrder selectionOrder)
@NonNull ValueSelectorConfig	withSorterClass(@NonNull Class<? extends SelectionSorter> sorterClass)
@NonNull ValueSelectorConfig	withSorterComparatorClass(@NonNull Class<? extends Comparator> comparatorClass)
@NonNull ValueSelectorConfig	withSorterManner(@NonNull ValueSorterManner sorterManner)
@NonNull ValueSelectorConfig	withSorterOrder(@NonNull SelectionSorterOrder sorterOrder)
@NonNull ValueSelectorConfig	withSorterWeightFactoryClass(@NonNull Class<? extends SelectionSorterWeightFactory> weightFactoryClass)
@NonNull ValueSelectorConfig	withVariableName(@NonNull 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(@NonNull String variableName)

ValueSelectorConfig

public ValueSelectorConfig(@Nullable ValueSelectorConfig inheritedConfig)

Method Details

getId

public @Nullable String getId()

setId

public void setId(@Nullable String id)

getMimicSelectorRef

public @Nullable String getMimicSelectorRef()

setMimicSelectorRef

public void setMimicSelectorRef(@Nullable String mimicSelectorRef)

getDowncastEntityClass

public @Nullable Class<?> getDowncastEntityClass()

setDowncastEntityClass

public void setDowncastEntityClass(@Nullable Class<?> downcastEntityClass)

getVariableName

public @Nullable String getVariableName()

setVariableName

public void setVariableName(@Nullable String variableName)

getCacheType

public @Nullable SelectionCacheType getCacheType()

setCacheType

public void setCacheType(@Nullable SelectionCacheType cacheType)

getSelectionOrder

public @Nullable SelectionOrder getSelectionOrder()

setSelectionOrder

public void setSelectionOrder(@Nullable SelectionOrder selectionOrder)

getNearbySelectionConfig

public @Nullable NearbySelectionConfig getNearbySelectionConfig()

setNearbySelectionConfig

public void setNearbySelectionConfig(@Nullable NearbySelectionConfig nearbySelectionConfig)

getFilterClass

public @Nullable Class<? extends SelectionFilter> getFilterClass()

setFilterClass

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

getSorterManner

public @Nullable ValueSorterManner getSorterManner()

setSorterManner

public void setSorterManner(@Nullable ValueSorterManner sorterManner)

getSorterComparatorClass

public @Nullable Class<? extends Comparator> getSorterComparatorClass()

setSorterComparatorClass

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

getSorterWeightFactoryClass

public @Nullable Class<? extends SelectionSorterWeightFactory> getSorterWeightFactoryClass()

setSorterWeightFactoryClass

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

getSorterOrder

public @Nullable SelectionSorterOrder getSorterOrder()

setSorterOrder

public void setSorterOrder(@Nullable SelectionSorterOrder sorterOrder)

getSorterClass

public @Nullable Class<? extends SelectionSorter> getSorterClass()

setSorterClass

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

getProbabilityWeightFactoryClass

public @Nullable Class<? extends SelectionProbabilityWeightFactory> getProbabilityWeightFactoryClass()

setProbabilityWeightFactoryClass

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

getSelectedCountLimit

public @Nullable Long getSelectedCountLimit()

setSelectedCountLimit

public void setSelectedCountLimit(@Nullable Long selectedCountLimit)

withId

public @NonNull ValueSelectorConfig withId(@NonNull String id)

withMimicSelectorRef

public @NonNull ValueSelectorConfig withMimicSelectorRef(@NonNull String mimicSelectorRef)

withDowncastEntityClass

public @NonNull ValueSelectorConfig withDowncastEntityClass(@NonNull Class<?> entityClass)

withVariableName

public @NonNull ValueSelectorConfig withVariableName(@NonNull String variableName)

withCacheType

public @NonNull ValueSelectorConfig withCacheType(@NonNull SelectionCacheType cacheType)

withSelectionOrder

public @NonNull ValueSelectorConfig withSelectionOrder(@NonNull SelectionOrder selectionOrder)

withNearbySelectionConfig

public @NonNull ValueSelectorConfig withNearbySelectionConfig(@NonNull NearbySelectionConfig nearbySelectionConfig)

withFilterClass

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

withSorterManner

public @NonNull ValueSelectorConfig withSorterManner(@NonNull ValueSorterManner sorterManner)

withSorterComparatorClass

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

withSorterWeightFactoryClass

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

withSorterOrder

public @NonNull ValueSelectorConfig withSorterOrder(@NonNull SelectionSorterOrder sorterOrder)

withSorterClass

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

withProbabilityWeightFactoryClass

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

withSelectedCountLimit

public @NonNull ValueSelectorConfig withSelectedCountLimit(long selectedCountLimit)

inherit

public @NonNull ValueSelectorConfig inherit(@NonNull 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>

Returns:

this

copyConfig

public @NonNull 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(@NonNull 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. Can accept null instances of Class.

toString

public String toString()

Overrides:

toString in class AbstractConfig<ValueSelectorConfig>

hasSorter

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

determineSorter

public static <Solution_>
@NonNull SelectionSorter<Solution_,Object> determineSorter(@NonNull ValueSorterManner valueSorterManner,
 @NonNull 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>