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

Class VariableDescriptor<Solution_>

java.lang.Object

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

Type Parameters:

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

Direct Known Subclasses:

GenuineVariableDescriptor, ShadowVariableDescriptor

public abstract class VariableDescriptor<Solution_>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected VariableMetaModel<Solution_,?,?>	cachedMetamodel
protected final EntityDescriptor<Solution_>	entityDescriptor
protected final int	ordinal
protected final String	simpleEntityAndVariableName
protected List<ShadowVariableDescriptor<Solution_>>	sinkVariableDescriptorList
protected final MemberAccessor	variableMemberAccessor
protected final String	variableName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	canBeUsedAsSource()
EntityDescriptor<Solution_>	getEntityDescriptor()
String	getMemberAccessorSpeedNote()
int	getOrdinal()	A number unique within an EntityDescriptor, increasing sequentially from zero.
String	getSimpleEntityAndVariableName()
List<ShadowVariableDescriptor<Solution_>>	getSinkVariableDescriptorList()	Inverse of ShadowVariableDescriptor.getSourceVariableDescriptorList().
<Value_> Value_	getValue(Object entity)
VariableMetaModel<Solution_,?,?>	getVariableMetaModel()
String	getVariableName()
Class<?>	getVariablePropertyType()
final boolean	isGenuineAndUninitialized(Object entity)
final boolean	isListVariable()
boolean	isValuePotentialAnchor(Object value)
abstract void	linkVariableDescriptors(DescriptorPolicy descriptorPolicy)
void	registerSinkVariableDescriptor(ShadowVariableDescriptor<Solution_> shadowVariableDescriptor)
void	setValue(Object entity, Object value)

Methods inherited from class java.lang.Object

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

Field Details

ordinal

protected final int ordinal

entityDescriptor

protected final EntityDescriptor<Solution_> entityDescriptor

variableMemberAccessor

protected final MemberAccessor variableMemberAccessor

variableName

protected final String variableName

simpleEntityAndVariableName

protected final String simpleEntityAndVariableName

cachedMetamodel

protected VariableMetaModel<Solution_,?,?> cachedMetamodel

sinkVariableDescriptorList

protected List<ShadowVariableDescriptor<Solution_>> sinkVariableDescriptorList

Constructor Details

VariableDescriptor

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

VariableDescriptor

protected VariableDescriptor(int ordinal,
 EntityDescriptor<Solution_> entityDescriptor,
 MemberAccessor variableMemberAccessor,
 boolean allowPrimitive)

Method Details

getOrdinal

public int getOrdinal()

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

Returns:

zero or higher

getEntityDescriptor

public EntityDescriptor<Solution_> getEntityDescriptor()

getVariableName

public String getVariableName()

getSimpleEntityAndVariableName

public String getSimpleEntityAndVariableName()

getVariablePropertyType

public Class<?> getVariablePropertyType()

linkVariableDescriptors

public abstract void linkVariableDescriptors(DescriptorPolicy descriptorPolicy)

isListVariable

public final boolean isListVariable()

canBeUsedAsSource

public boolean canBeUsedAsSource()

registerSinkVariableDescriptor

public void registerSinkVariableDescriptor(ShadowVariableDescriptor<Solution_> shadowVariableDescriptor)

getSinkVariableDescriptorList

public List<ShadowVariableDescriptor<Solution_>> getSinkVariableDescriptorList()

Inverse of ShadowVariableDescriptor.getSourceVariableDescriptorList().

Returns:

never null, only direct shadow variables that are affected by this variable

isValuePotentialAnchor

public boolean isValuePotentialAnchor(Object value)

Parameters:

value - never null

Returns:

true if it might be an anchor, false if it is definitely not an anchor

getValue

public <Value_> Value_ getValue(Object entity)

setValue

public void setValue(Object entity,
 Object value)

getMemberAccessorSpeedNote

public String getMemberAccessorSpeedNote()

isGenuineAndUninitialized

public final boolean isGenuineAndUninitialized(Object entity)

getVariableMetaModel

public VariableMetaModel<Solution_,?,?> getVariableMetaModel()