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

Class EntitySelectorConfig

java.lang.Object

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

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

ai.timefold.solver.core.config.heuristic.selector.entity.EntitySelectorConfig

@NullMarked
public class EntitySelectorConfig
extends SelectorConfig<EntitySelectorConfig>

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable SelectionCacheType	cacheType
protected @Nullable Class<? extends Comparator>	comparatorClass
protected @Nullable Class<? extends ComparatorFactory>	comparatorFactoryClass
protected @Nullable Class<?>	entityClass
protected @Nullable Class<? extends SelectionFilter>	filterClass
protected @Nullable String	id
protected @Nullable String	mimicSelectorRef
protected @Nullable NearbySelectionConfig	nearbySelectionConfig
protected @Nullable Class<? extends SelectionProbabilityWeightFactory>	probabilityWeightFactoryClass
protected @Nullable Long	selectedCountLimit
protected @Nullable SelectionOrder	selectionOrder
protected @Nullable Class<? extends SelectionSorter>	sorterClass
protected @Nullable Class<? extends Comparator>	sorterComparatorClass	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of comparatorClass.
protected @Nullable EntitySorterManner	sorterManner
protected @Nullable SelectionSorterOrder	sorterOrder
protected @Nullable Class<? extends SelectionSorterWeightFactory>	sorterWeightFactoryClass	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of comparatorFactoryClass.

Constructor Summary

Constructors

Constructor	Description
EntitySelectorConfig()
EntitySelectorConfig(@Nullable EntitySelectorConfig inheritedConfig)
EntitySelectorConfig(Class<?> entityClass)

Method Summary

Modifier and Type	Method	Description
EntitySelectorConfig	copyConfig()	Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.
static <Solution_, T> SelectionSorter<Solution_,T>	determineSorter(EntitySorterManner entitySorterManner, EntityDescriptor<Solution_> entityDescriptor)
@Nullable SelectionCacheType	getCacheType()
@Nullable Class<? extends Comparator>	getComparatorClass()
@Nullable Class<? extends ComparatorFactory>	getComparatorFactoryClass()
@Nullable Class<?>	getEntityClass()
@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()	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of getComparatorClass()
@Nullable EntitySorterManner	getSorterManner()
@Nullable SelectionSorterOrder	getSorterOrder()
@Nullable Class<? extends SelectionSorterWeightFactory>	getSorterWeightFactoryClass()	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of getComparatorFactoryClass()
boolean	hasNearbySelectionConfig()	Verifies if the current configuration has any Nearby Selection settings.
static <Solution_> boolean	hasSorter(EntitySorterManner entitySorterManner, EntityDescriptor<Solution_> entityDescriptor)
EntitySelectorConfig	inherit(EntitySelectorConfig inheritedConfig)	Inherits each property of the inheritedConfig unless that property (or a semantic alternative) is defined by this instance (which overwrites the inherited behaviour).
static EntitySelectorConfig	newMimicSelectorConfig(String mimicSelectorRef)
void	setCacheType(@Nullable SelectionCacheType cacheType)
void	setComparatorClass(@Nullable Class<? extends Comparator> comparatorClass)
void	setComparatorFactoryClass(@Nullable Class<? extends ComparatorFactory> comparatorFactoryClass)
void	setEntityClass(@Nullable Class<?> entityClass)
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)	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of setComparatorClass(Class)
void	setSorterManner(@Nullable EntitySorterManner sorterManner)
void	setSorterOrder(@Nullable SelectionSorterOrder sorterOrder)
void	setSorterWeightFactoryClass(@Nullable Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of setComparatorFactoryClass(Class)
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).
EntitySelectorConfig	withCacheType(SelectionCacheType cacheType)
EntitySelectorConfig	withComparatorClass(Class<? extends Comparator> comparatorClass)
EntitySelectorConfig	withComparatorFactoryClass(Class<? extends ComparatorFactory> comparatorFactoryClass)
EntitySelectorConfig	withEntityClass(Class<?> entityClass)
EntitySelectorConfig	withFilterClass(Class<? extends SelectionFilter> filterClass)
EntitySelectorConfig	withId(String id)
EntitySelectorConfig	withMimicSelectorRef(String mimicSelectorRef)
EntitySelectorConfig	withNearbySelectionConfig(NearbySelectionConfig nearbySelectionConfig)
EntitySelectorConfig	withProbabilityWeightFactoryClass(Class<? extends SelectionProbabilityWeightFactory> factoryClass)
EntitySelectorConfig	withSelectedCountLimit(long selectedCountLimit)
EntitySelectorConfig	withSelectionOrder(SelectionOrder selectionOrder)
EntitySelectorConfig	withSorterClass(Class<? extends SelectionSorter> sorterClass)
EntitySelectorConfig	withSorterComparatorClass(Class<? extends Comparator> comparatorClass)	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of withComparatorClass(Class)
EntitySelectorConfig	withSorterManner(EntitySorterManner sorterManner)
EntitySelectorConfig	withSorterOrder(SelectionSorterOrder sorterOrder)
EntitySelectorConfig	withSorterWeightFactoryClass(Class<? extends SelectionSorterWeightFactory> weightFactoryClass)	Deprecated, for removal: This API element is subject to removal in a future version. Deprecated in favor of withComparatorFactoryClass(Class)

Methods inherited from class java.lang.Object

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

Field Details

id

protected @Nullable String id

mimicSelectorRef

protected @Nullable String mimicSelectorRef

entityClass

protected @Nullable Class<?> entityClass

cacheType

protected @Nullable SelectionCacheType cacheType

selectionOrder

protected @Nullable SelectionOrder selectionOrder

nearbySelectionConfig

protected @Nullable NearbySelectionConfig nearbySelectionConfig

filterClass

protected @Nullable Class<? extends SelectionFilter> filterClass

sorterManner

protected @Nullable EntitySorterManner sorterManner

sorterComparatorClass

@Deprecated(forRemoval=true,
            since="1.28.0")
protected @Nullable Class<? extends Comparator> sorterComparatorClass

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of comparatorClass.

comparatorClass

protected @Nullable Class<? extends Comparator> comparatorClass

sorterWeightFactoryClass

@Deprecated(forRemoval=true,
            since="1.28.0")
protected @Nullable Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of comparatorFactoryClass.

comparatorFactoryClass

protected @Nullable Class<? extends ComparatorFactory> comparatorFactoryClass

sorterOrder

protected @Nullable SelectionSorterOrder sorterOrder

sorterClass

protected @Nullable Class<? extends SelectionSorter> sorterClass

probabilityWeightFactoryClass

protected @Nullable Class<? extends SelectionProbabilityWeightFactory> probabilityWeightFactoryClass

selectedCountLimit

protected @Nullable Long selectedCountLimit

Constructor Details

EntitySelectorConfig

public EntitySelectorConfig()

EntitySelectorConfig

public EntitySelectorConfig(Class<?> entityClass)

EntitySelectorConfig

public EntitySelectorConfig(@Nullable EntitySelectorConfig inheritedConfig)

Method Details

newMimicSelectorConfig

public static EntitySelectorConfig newMimicSelectorConfig(String mimicSelectorRef)

getId

public @Nullable String getId()

setId

public void setId(@Nullable String id)

getMimicSelectorRef

public @Nullable String getMimicSelectorRef()

setMimicSelectorRef

public void setMimicSelectorRef(@Nullable String mimicSelectorRef)

getEntityClass

public @Nullable Class<?> getEntityClass()

setEntityClass

public void setEntityClass(@Nullable Class<?> entityClass)

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 EntitySorterManner getSorterManner()

setSorterManner

public void setSorterManner(@Nullable EntitySorterManner sorterManner)

getSorterComparatorClass

@Deprecated(forRemoval=true,
            since="1.28.0")
public @Nullable Class<? extends Comparator> getSorterComparatorClass()

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of getComparatorClass()

setSorterComparatorClass

@Deprecated(forRemoval=true,
            since="1.28.0")
public void setSorterComparatorClass(@Nullable Class<? extends Comparator> sorterComparatorClass)

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of setComparatorClass(Class)

getComparatorClass

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

setComparatorClass

public void setComparatorClass(@Nullable Class<? extends Comparator> comparatorClass)

getSorterWeightFactoryClass

@Deprecated(forRemoval=true,
            since="1.28.0")
public @Nullable Class<? extends SelectionSorterWeightFactory> getSorterWeightFactoryClass()

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of getComparatorFactoryClass()

setSorterWeightFactoryClass

@Deprecated(forRemoval=true,
            since="1.28.0")
public void setSorterWeightFactoryClass(@Nullable Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of setComparatorFactoryClass(Class)

Parameters:

sorterWeightFactoryClass - the class

getComparatorFactoryClass

public @Nullable Class<? extends ComparatorFactory> getComparatorFactoryClass()

setComparatorFactoryClass

public void setComparatorFactoryClass(@Nullable Class<? extends ComparatorFactory> comparatorFactoryClass)

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 EntitySelectorConfig withId(String id)

withMimicSelectorRef

public EntitySelectorConfig withMimicSelectorRef(String mimicSelectorRef)

withEntityClass

public EntitySelectorConfig withEntityClass(Class<?> entityClass)

withCacheType

public EntitySelectorConfig withCacheType(SelectionCacheType cacheType)

withSelectionOrder

public EntitySelectorConfig withSelectionOrder(SelectionOrder selectionOrder)

withNearbySelectionConfig

public EntitySelectorConfig withNearbySelectionConfig(NearbySelectionConfig nearbySelectionConfig)

withFilterClass

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

withSorterManner

public EntitySelectorConfig withSorterManner(EntitySorterManner sorterManner)

withSorterComparatorClass

@Deprecated(forRemoval=true,
            since="1.28.0")
public EntitySelectorConfig withSorterComparatorClass(Class<? extends Comparator> comparatorClass)

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of withComparatorClass(Class)

withComparatorClass

public EntitySelectorConfig withComparatorClass(Class<? extends Comparator> comparatorClass)

withSorterWeightFactoryClass

@Deprecated(forRemoval=true,
            since="1.28.0")
public EntitySelectorConfig withSorterWeightFactoryClass(Class<? extends SelectionSorterWeightFactory> weightFactoryClass)

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of withComparatorFactoryClass(Class)

Parameters:

weightFactoryClass - the factory class

withComparatorFactoryClass

public EntitySelectorConfig withComparatorFactoryClass(Class<? extends ComparatorFactory> comparatorFactoryClass)

withSorterOrder

public EntitySelectorConfig withSorterOrder(SelectionSorterOrder sorterOrder)

withSorterClass

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

withProbabilityWeightFactoryClass

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

withSelectedCountLimit

public EntitySelectorConfig withSelectedCountLimit(long selectedCountLimit)

inherit

public EntitySelectorConfig inherit(EntitySelectorConfig 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<EntitySelectorConfig>

Returns:

this

copyConfig

public EntitySelectorConfig 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<EntitySelectorConfig>

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<EntitySelectorConfig>

Parameters:

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

toString

public String toString()

Overrides:

toString in class AbstractConfig<EntitySelectorConfig>

hasSorter

public static <Solution_> boolean hasSorter(EntitySorterManner entitySorterManner,
 EntityDescriptor<Solution_> entityDescriptor)

determineSorter

public static <Solution_,
T>
SelectionSorter<Solution_,T> determineSorter(EntitySorterManner entitySorterManner,
 EntityDescriptor<Solution_> entityDescriptor)

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<EntitySelectorConfig>