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

Class GenuineVariableDescriptor<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.domain.variable.descriptor.VariableDescriptor<Solution_>

ai.timefold.solver.core.impl.domain.variable.descriptor.GenuineVariableDescriptor<Solution_>

Type Parameters:

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

Direct Known Subclasses:

BasicVariableDescriptor, ListVariableDescriptor

public abstract class GenuineVariableDescriptor<Solution_>
extends VariableDescriptor<Solution_>

Field Summary

Fields inherited from class ai.timefold.solver.core.impl.domain.variable.descriptor.VariableDescriptor

cachedMetamodel, entityDescriptor, ordinal, simpleEntityAndVariableName, sinkVariableDescriptorList, variableMemberAccessor, variableName

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GenuineVariableDescriptor(int ordinal, EntityDescriptor<Solution_> entityDescriptor, MemberAccessor variableMemberAccessor)

Method Summary

Modifier and Type	Method	Description
abstract boolean	acceptsValueType(Class<?> valueType)
boolean	canExtractValueRangeFromSolution()	Returns true if the value range can be directly extracted from the solution.
SelectionSorter<Solution_,Object>	getAscendingSorter()
SelectionSorter<Solution_,Object>	getDescendingSorter()
ValueRangeDescriptor<Solution_>	getValueRangeDescriptor()
abstract boolean	isInitialized(Object entity)	A basic planning variable allowing unassigned and PlanningListVariable are always considered initialized.
boolean	isReinitializable(Object entity)	Decides whether an entity is eligible for initialization.
void	linkVariableDescriptors(DescriptorPolicy descriptorPolicy)
void	processAnnotations(DescriptorPolicy descriptorPolicy)
protected abstract void	processPropertyAnnotations(DescriptorPolicy descriptorPolicy)
protected void	processSorting(String comparatorPropertyName, Class<? extends Comparator> comparatorClass, String comparatorFactoryPropertyName, Class<? extends ComparatorFactory> comparatorFactoryClass)
protected void	processValueRangeRefs(DescriptorPolicy descriptorPolicy, String[] valueRangeProviderRefs)
String	toString()

Methods inherited from class ai.timefold.solver.core.impl.domain.variable.descriptor.VariableDescriptor

canBeUsedAsSource, getEntityDescriptor, getMemberAccessorSpeedNote, getOrdinal, getSimpleEntityAndVariableName, getSinkVariableDescriptorList, getValue, getVariableMetaModel, getVariableName, getVariablePropertyType, isGenuineAndUninitialized, isListVariable, isValuePotentialAnchor, registerSinkVariableDescriptor, setValue

Methods inherited from class java.lang.Object

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

Constructor Details

GenuineVariableDescriptor

protected GenuineVariableDescriptor(int ordinal,
 EntityDescriptor<Solution_> entityDescriptor,
 MemberAccessor variableMemberAccessor)

Method Details

processAnnotations

public void processAnnotations(DescriptorPolicy descriptorPolicy)

processPropertyAnnotations

protected abstract void processPropertyAnnotations(DescriptorPolicy descriptorPolicy)

processValueRangeRefs

protected void processValueRangeRefs(DescriptorPolicy descriptorPolicy,
 String[] valueRangeProviderRefs)

processSorting

protected void processSorting(String comparatorPropertyName,
 Class<? extends Comparator> comparatorClass,
 String comparatorFactoryPropertyName,
 Class<? extends ComparatorFactory> comparatorFactoryClass)

linkVariableDescriptors

public void linkVariableDescriptors(DescriptorPolicy descriptorPolicy)

Specified by:

linkVariableDescriptors in class VariableDescriptor<Solution_>

acceptsValueType

public abstract boolean acceptsValueType(Class<?> valueType)

getValueRangeDescriptor

public ValueRangeDescriptor<Solution_> getValueRangeDescriptor()

canExtractValueRangeFromSolution

public boolean canExtractValueRangeFromSolution()

Returns true if the value range can be directly extracted from the solution.

See Also:

• FromSolutionPropertyValueRangeDescriptor

isInitialized

public abstract boolean isInitialized(Object entity)

A basic planning variable allowing unassigned and PlanningListVariable are always considered initialized.

Parameters:

entity - never null

Returns:

true if the variable on that entity is initialized

isReinitializable

public boolean isReinitializable(Object entity)

Decides whether an entity is eligible for initialization. This is not an opposite of isInitialized() because even a variable that allows unassigned, which is always considered initialized, is reinitializable if its value is null.

getAscendingSorter

public SelectionSorter<Solution_,Object> getAscendingSorter()

getDescendingSorter

public SelectionSorter<Solution_,Object> getDescendingSorter()

toString

public String toString()

Overrides:

toString in class Object