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

public class EntitySelectorConfig
extends SelectorConfig<EntitySelectorConfig>

Field Summary

Fields

Modifier and Type	Field	Description
protected SelectionCacheType	cacheType
protected Class<?>	entityClass
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 EntitySorterManner	sorterManner
protected SelectionSorterOrder	sorterOrder
protected Class<? extends SelectionSorterWeightFactory>	sorterWeightFactoryClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NonNull EntitySelectorConfig	copyConfig()	Typically implemented by constructing a new instance and calling AbstractConfig.inherit(AbstractConfig) on it.
static <Solution_, T> @NonNull SelectionSorter<Solution_,T>	determineSorter(@NonNull EntitySorterManner entitySorterManner, @NonNull EntityDescriptor<Solution_> entityDescriptor)
@Nullable SelectionCacheType	getCacheType()
@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()
@Nullable EntitySorterManner	getSorterManner()
@Nullable SelectionSorterOrder	getSorterOrder()
@Nullable Class<? extends SelectionSorterWeightFactory>	getSorterWeightFactoryClass()
boolean	hasNearbySelectionConfig()	Verifies if the current configuration has any Nearby Selection settings.
static <Solution_> boolean	hasSorter(@NonNull EntitySorterManner entitySorterManner, @NonNull EntityDescriptor<Solution_> entityDescriptor)
@NonNull EntitySelectorConfig	inherit(@NonNull 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	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)
void	setSorterManner(@Nullable EntitySorterManner sorterManner)
void	setSorterOrder(@Nullable SelectionSorterOrder sorterOrder)
void	setSorterWeightFactoryClass(@Nullable Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)
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 EntitySelectorConfig	withCacheType(@NonNull SelectionCacheType cacheType)
@NonNull EntitySelectorConfig	withEntityClass(@NonNull Class<?> entityClass)
@NonNull EntitySelectorConfig	withFilterClass(@NonNull Class<? extends SelectionFilter> filterClass)
@NonNull EntitySelectorConfig	withId(@NonNull String id)
@NonNull EntitySelectorConfig	withMimicSelectorRef(@NonNull String mimicSelectorRef)
@NonNull EntitySelectorConfig	withNearbySelectionConfig(@NonNull NearbySelectionConfig nearbySelectionConfig)
@NonNull EntitySelectorConfig	withProbabilityWeightFactoryClass(@NonNull Class<? extends SelectionProbabilityWeightFactory> factoryClass)
@NonNull EntitySelectorConfig	withSelectedCountLimit(long selectedCountLimit)
@NonNull EntitySelectorConfig	withSelectionOrder(@NonNull SelectionOrder selectionOrder)
@NonNull EntitySelectorConfig	withSorterClass(@NonNull Class<? extends SelectionSorter> sorterClass)
@NonNull EntitySelectorConfig	withSorterComparatorClass(@NonNull Class<? extends Comparator> comparatorClass)
@NonNull EntitySelectorConfig	withSorterManner(@NonNull EntitySorterManner sorterManner)
@NonNull EntitySelectorConfig	withSorterOrder(@NonNull SelectionSorterOrder sorterOrder)
@NonNull EntitySelectorConfig	withSorterWeightFactoryClass(@NonNull Class<? extends SelectionSorterWeightFactory> weightFactoryClass)

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

entityClass

protected Class<?> entityClass

cacheType

protected SelectionCacheType cacheType

selectionOrder

protected SelectionOrder selectionOrder

nearbySelectionConfig

protected NearbySelectionConfig nearbySelectionConfig

filterClass

protected Class<? extends SelectionFilter> filterClass

sorterManner

protected EntitySorterManner 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

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

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

withMimicSelectorRef

public @NonNull EntitySelectorConfig withMimicSelectorRef(@NonNull String mimicSelectorRef)

withEntityClass

public @NonNull EntitySelectorConfig withEntityClass(@NonNull Class<?> entityClass)

withCacheType

public @NonNull EntitySelectorConfig withCacheType(@NonNull SelectionCacheType cacheType)

withSelectionOrder

public @NonNull EntitySelectorConfig withSelectionOrder(@NonNull SelectionOrder selectionOrder)

withNearbySelectionConfig

public @NonNull EntitySelectorConfig withNearbySelectionConfig(@NonNull NearbySelectionConfig nearbySelectionConfig)

withFilterClass

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

withSorterManner

public @NonNull EntitySelectorConfig withSorterManner(@NonNull EntitySorterManner sorterManner)

withSorterComparatorClass

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

withSorterWeightFactoryClass

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

withSorterOrder

public @NonNull EntitySelectorConfig withSorterOrder(@NonNull SelectionSorterOrder sorterOrder)

withSorterClass

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

withProbabilityWeightFactoryClass

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

withSelectedCountLimit

public @NonNull EntitySelectorConfig withSelectedCountLimit(long selectedCountLimit)

inherit

public @NonNull EntitySelectorConfig inherit(@NonNull 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 @NonNull 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(@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<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(@NonNull EntitySorterManner entitySorterManner,
 @NonNull EntityDescriptor<Solution_> entityDescriptor)

determineSorter

public static <Solution_,
T>
@NonNull SelectionSorter<Solution_,T> determineSorter(@NonNull EntitySorterManner entitySorterManner,
 @NonNull 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>