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(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)
SelectionCacheType	getCacheType()
Class<?>	getEntityClass()
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()
EntitySorterManner	getSorterManner()
SelectionSorterOrder	getSorterOrder()
Class<? extends SelectionSorterWeightFactory>	getSorterWeightFactoryClass()
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(SelectionCacheType cacheType)
void	setEntityClass(Class<?> entityClass)
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(EntitySorterManner sorterManner)
void	setSorterOrder(SelectionSorterOrder sorterOrder)
void	setSorterWeightFactoryClass(Class<? extends SelectionSorterWeightFactory> sorterWeightFactoryClass)
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	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)
EntitySelectorConfig	withSorterManner(EntitySorterManner sorterManner)
EntitySelectorConfig	withSorterOrder(SelectionSorterOrder sorterOrder)
EntitySelectorConfig	withSorterWeightFactoryClass(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(EntitySelectorConfig inheritedConfig)

Method Details

newMimicSelectorConfig

public static EntitySelectorConfig newMimicSelectorConfig(String mimicSelectorRef)

getId

public String getId()

setId

public void setId(String id)

getMimicSelectorRef

public String getMimicSelectorRef()

setMimicSelectorRef

public void setMimicSelectorRef(String mimicSelectorRef)

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)

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

setSorterManner

public void setSorterManner(EntitySorterManner 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 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

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

withSorterWeightFactoryClass

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

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>

Parameters:

inheritedConfig - never null

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, never null. 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>