Package ai.timefold.solver.core.impl.domain.entity.descriptor

Class EntityDescriptor<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.domain.entity.descriptor.EntityDescriptor<Solution_>

Type Parameters:

Solution_ - the solution type, the class with the PlanningSolution annotation

public class EntityDescriptor<Solution_>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Class[]	VARIABLE_ANNOTATION_CLASSES

Constructor Summary

Constructors

Constructor	Description
EntityDescriptor(int ordinal, SolutionDescriptor<Solution_> solutionDescriptor, Class<?> entityClass)

Method Summary

Modifier and Type	Method	Description
String	buildInvalidVariableNameExceptionMessage(String variableName)
int	countReinitializableVariables(Object entity)
int	countUninitializedVariables(Object entity)
List<Object>	extractEntities(Solution_ solution)
static List<Class<?>>	extractInheritedClasses(Class<?> entityClass)
Collection<CascadingUpdateShadowVariableDescriptor<Solution_>>	getDeclaredCascadingUpdateShadowVariableDescriptors()
Collection<GenuineVariableDescriptor<Solution_>>	getDeclaredGenuineVariableDescriptors()
Collection<ShadowVariableDescriptor<Solution_>>	getDeclaredShadowVariableDescriptors()
Collection<VariableDescriptor<Solution_>>	getDeclaredVariableDescriptors()
SelectionSorter<Solution_,Object>	getDecreasingDifficultySorter()
BiPredicate<Solution_,Object>	getEffectiveMovableEntityFilter()
PlanningPinToIndexReader	getEffectivePlanningPinToIndexReader()
Class<?>	getEntityClass()
PlanningEntityMetaModel<Solution_,?>	getEntityMetaModel()
List<GenuineVariableDescriptor<Solution_>>	getGenuineBasicVariableDescriptorList()
ListVariableDescriptor<Solution_>	getGenuineListVariableDescriptor()
long	getGenuineVariableCount()
GenuineVariableDescriptor<Solution_>	getGenuineVariableDescriptor(String variableName)
List<GenuineVariableDescriptor<Solution_>>	getGenuineVariableDescriptorList()
Collection<String>	getGenuineVariableNameSet()
<A> Predicate<A>	getHasNoNullVariablesPredicateBasicVar()
<A> Predicate<A>	getHasNoNullVariablesPredicateListVar()
Predicate<Object>	getIsInitializedPredicate()	Deprecated, for removal: This API element is subject to removal in a future version. Prefer getHasNoNullVariablesPredicateListVar().
long	getMaximumValueCount(Solution_ solution, Object entity)
int	getOrdinal()	A number unique within a SolutionDescriptor, increasing sequentially from zero.
ShadowVariableDescriptor<Solution_>	getShadowVariableDescriptor(String variableName)
Collection<ShadowVariableDescriptor<Solution_>>	getShadowVariableDescriptors()
@Nullable ShadowVariableLoopedVariableDescriptor<Solution_>	getShadowVariableLoopedDescriptor()
SolutionDescriptor<Solution_>	getSolutionDescriptor()
static Collection<Class<? extends Annotation>>	getVariableAnnotationClasses()
@Nullable VariableDescriptor<Solution_>	getVariableDescriptor(String variableName)
Map<String,VariableDescriptor<Solution_>>	getVariableDescriptorMap()
@NonNull VariableDescriptor<Solution_>	getVariableDescriptorOrFail(String variableName)
boolean	hasAnyDeclaredGenuineVariableDescriptor()
boolean	hasAnyGenuineBasicVariables()
boolean	hasAnyGenuineChainedVariables()
boolean	hasAnyGenuineListVariables()
boolean	hasBothGenuineListAndBasicVariables()
boolean	hasCascadingShadowVariables()
boolean	hasEffectiveMovableEntityFilter()
boolean	hasNoNullVariables(Object entity)
boolean	hasPinningFilter()
boolean	hasVariableDescriptor(String variableName)
boolean	isGenuine()
boolean	isInitialized(Object entity)
boolean	isMovable(Solution_ workingSolution, Object entity)
void	linkEntityDescriptors(DescriptorPolicy descriptorPolicy)
void	linkVariableDescriptors(DescriptorPolicy descriptorPolicy)
boolean	matchesEntity(Object entity)
void	processAnnotations(DescriptorPolicy descriptorPolicy)
void	processProblemScale(Solution_ solution, Object entity, ProblemScaleTracker tracker)
boolean	supportsPinning()
String	toString()
void	visitAllEntities(Solution_ solution, Consumer<Object> visitor)

Methods inherited from class java.lang.Object

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

Field Details

VARIABLE_ANNOTATION_CLASSES

protected static final Class[] VARIABLE_ANNOTATION_CLASSES

Constructor Details

EntityDescriptor

public EntityDescriptor(int ordinal,
 SolutionDescriptor<Solution_> solutionDescriptor,
 Class<?> entityClass)

Method Details

getVariableAnnotationClasses

public static Collection<Class<? extends Annotation>> getVariableAnnotationClasses()

getOrdinal

public int getOrdinal()

A number unique within a SolutionDescriptor, increasing sequentially from zero. Used for indexing in arrays to avoid object hash lookups in maps.

Returns:

zero or higher

getIsInitializedPredicate

@Deprecated(forRemoval=true)
public Predicate<Object> getIsInitializedPredicate()

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

Prefer getHasNoNullVariablesPredicateListVar().

Using entityDescriptor::isInitialized directly breaks node sharing because it creates multiple instances of this Predicate.

Returns:

never null, always the same Predicate instance to isInitialized(Object)

getHasNoNullVariablesPredicateBasicVar

public <A> Predicate<A> getHasNoNullVariablesPredicateBasicVar()

getHasNoNullVariablesPredicateListVar

public <A> Predicate<A> getHasNoNullVariablesPredicateListVar()

processAnnotations

public void processAnnotations(DescriptorPolicy descriptorPolicy)

linkEntityDescriptors

public void linkEntityDescriptors(DescriptorPolicy descriptorPolicy)

linkVariableDescriptors

public void linkVariableDescriptors(DescriptorPolicy descriptorPolicy)

getSolutionDescriptor

public SolutionDescriptor<Solution_> getSolutionDescriptor()

getEntityClass

public Class<?> getEntityClass()

matchesEntity

public boolean matchesEntity(Object entity)

hasPinningFilter

public boolean hasPinningFilter()

hasEffectiveMovableEntityFilter

public boolean hasEffectiveMovableEntityFilter()

hasCascadingShadowVariables

public boolean hasCascadingShadowVariables()

supportsPinning

public boolean supportsPinning()

getEffectiveMovableEntityFilter

public BiPredicate<Solution_,Object> getEffectiveMovableEntityFilter()

getDecreasingDifficultySorter

public SelectionSorter<Solution_,Object> getDecreasingDifficultySorter()

getGenuineVariableNameSet

public Collection<String> getGenuineVariableNameSet()

getGenuineVariableDescriptor

public GenuineVariableDescriptor<Solution_> getGenuineVariableDescriptor(String variableName)

getShadowVariableLoopedDescriptor

public @Nullable ShadowVariableLoopedVariableDescriptor<Solution_> getShadowVariableLoopedDescriptor()

hasBothGenuineListAndBasicVariables

public boolean hasBothGenuineListAndBasicVariables()

hasAnyGenuineBasicVariables

public boolean hasAnyGenuineBasicVariables()

hasAnyGenuineChainedVariables

public boolean hasAnyGenuineChainedVariables()

hasAnyGenuineListVariables

public boolean hasAnyGenuineListVariables()

isGenuine

public boolean isGenuine()

getGenuineListVariableDescriptor

public ListVariableDescriptor<Solution_> getGenuineListVariableDescriptor()

getGenuineVariableDescriptorList

public List<GenuineVariableDescriptor<Solution_>> getGenuineVariableDescriptorList()

getGenuineBasicVariableDescriptorList

public List<GenuineVariableDescriptor<Solution_>> getGenuineBasicVariableDescriptorList()

getGenuineVariableCount

public long getGenuineVariableCount()

getShadowVariableDescriptors

public Collection<ShadowVariableDescriptor<Solution_>> getShadowVariableDescriptors()

getShadowVariableDescriptor

public ShadowVariableDescriptor<Solution_> getShadowVariableDescriptor(String variableName)

getVariableDescriptorMap

public Map<String,VariableDescriptor<Solution_>> getVariableDescriptorMap()

hasVariableDescriptor

public boolean hasVariableDescriptor(String variableName)

getVariableDescriptor

public @Nullable VariableDescriptor<Solution_> getVariableDescriptor(String variableName)

getVariableDescriptorOrFail

public @NonNull VariableDescriptor<Solution_> getVariableDescriptorOrFail(String variableName)

hasAnyDeclaredGenuineVariableDescriptor

public boolean hasAnyDeclaredGenuineVariableDescriptor()

getDeclaredGenuineVariableDescriptors

public Collection<GenuineVariableDescriptor<Solution_>> getDeclaredGenuineVariableDescriptors()

getDeclaredShadowVariableDescriptors

public Collection<ShadowVariableDescriptor<Solution_>> getDeclaredShadowVariableDescriptors()

getDeclaredCascadingUpdateShadowVariableDescriptors

public Collection<CascadingUpdateShadowVariableDescriptor<Solution_>> getDeclaredCascadingUpdateShadowVariableDescriptors()

getDeclaredVariableDescriptors

public Collection<VariableDescriptor<Solution_>> getDeclaredVariableDescriptors()

buildInvalidVariableNameExceptionMessage

public String buildInvalidVariableNameExceptionMessage(String variableName)

extractInheritedClasses

public static List<Class<?>> extractInheritedClasses(Class<?> entityClass)

extractEntities

public List<Object> extractEntities(Solution_ solution)

visitAllEntities

public void visitAllEntities(Solution_ solution,
 Consumer<Object> visitor)

getEffectivePlanningPinToIndexReader

public PlanningPinToIndexReader getEffectivePlanningPinToIndexReader()

getMaximumValueCount

public long getMaximumValueCount(Solution_ solution,
 Object entity)

processProblemScale

public void processProblemScale(Solution_ solution,
 Object entity,
 ProblemScaleTracker tracker)

countUninitializedVariables

public int countUninitializedVariables(Object entity)

isInitialized

public boolean isInitialized(Object entity)

hasNoNullVariables

public boolean hasNoNullVariables(Object entity)

countReinitializableVariables

public int countReinitializableVariables(Object entity)

isMovable

public boolean isMovable(Solution_ workingSolution,
 Object entity)

getEntityMetaModel

public PlanningEntityMetaModel<Solution_,?> getEntityMetaModel()

toString

public String toString()

Overrides:

toString in class Object