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

Class ShadowVariableDescriptor<Solution_>

java.lang.Object

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

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

Type Parameters:

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

Direct Known Subclasses:

AnchorShadowVariableDescriptor, CascadingUpdateShadowVariableDescriptor, CustomShadowVariableDescriptor, DeclarativeShadowVariableDescriptor, IndexShadowVariableDescriptor, InverseRelationShadowVariableDescriptor, LegacyCustomShadowVariableDescriptor, NextElementShadowVariableDescriptor, PiggybackShadowVariableDescriptor, PreviousElementShadowVariableDescriptor, ShadowVariableLoopedVariableDescriptor

public abstract class ShadowVariableDescriptor<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	ShadowVariableDescriptor(int ordinal, EntityDescriptor<Solution_> entityDescriptor, MemberAccessor variableMemberAccessor)

Method Summary

Modifier and Type	Method	Description
abstract Iterable<VariableListenerWithSources<Solution_>>	buildVariableListeners(SupplyManager supplyManager)
int	getGlobalShadowOrder()
abstract Demand<?>	getProvidedDemand()
abstract List<VariableDescriptor<Solution_>>	getSourceVariableDescriptorList()	Inverse of VariableDescriptor.getSinkVariableDescriptorList().
abstract Collection<Class<? extends AbstractVariableListener>>	getVariableListenerClasses()
boolean	hasVariableListener()
abstract boolean	isListVariableSource()	return true if the source variable is a list variable; otherwise, return false.
abstract void	processAnnotations(DescriptorPolicy descriptorPolicy)
void	setGlobalShadowOrder(int globalShadowOrder)
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, linkVariableDescriptors, registerSinkVariableDescriptor, setValue

Methods inherited from class java.lang.Object

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

Constructor Details

ShadowVariableDescriptor

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

Method Details

getGlobalShadowOrder

public int getGlobalShadowOrder()

setGlobalShadowOrder

public void setGlobalShadowOrder(int globalShadowOrder)

processAnnotations

public abstract void processAnnotations(DescriptorPolicy descriptorPolicy)

getSourceVariableDescriptorList

public abstract List<VariableDescriptor<Solution_>> getSourceVariableDescriptorList()

Inverse of VariableDescriptor.getSinkVariableDescriptorList().

Returns:

never null, only variables affect this shadow variable directly

getVariableListenerClasses

public abstract Collection<Class<? extends AbstractVariableListener>> getVariableListenerClasses()

getProvidedDemand

public abstract Demand<?> getProvidedDemand()

Returns:

never null

hasVariableListener

public boolean hasVariableListener()

isListVariableSource

public abstract boolean isListVariableSource()

return true if the source variable is a list variable; otherwise, return false.

buildVariableListeners

public abstract Iterable<VariableListenerWithSources<Solution_>> buildVariableListeners(SupplyManager supplyManager)

Parameters:

supplyManager - never null

Returns:

never null

toString

public String toString()

Overrides:

toString in class Object