Package org.optaplanner.core.impl.domain.variable.custom

Class PiggybackShadowVariableDescriptor<Solution_>

java.lang.Object

org.optaplanner.core.impl.domain.variable.descriptor.VariableDescriptor<Solution_>

org.optaplanner.core.impl.domain.variable.descriptor.ShadowVariableDescriptor<Solution_>

org.optaplanner.core.impl.domain.variable.custom.PiggybackShadowVariableDescriptor<Solution_>

Type Parameters:

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

public class PiggybackShadowVariableDescriptor<Solution_>
extends ShadowVariableDescriptor<Solution_>

Field Summary

Fields

Modifier and Type	Field	Description
protected CustomShadowVariableDescriptor<Solution_>	shadowVariableDescriptor

Fields inherited from class org.optaplanner.core.impl.domain.variable.descriptor.VariableDescriptor

entityDescriptor, sinkVariableDescriptorList, variableMemberAccessor, variableName

Constructor Summary

Constructors

Constructor	Description
PiggybackShadowVariableDescriptor(EntityDescriptor<Solution_> entityDescriptor, MemberAccessor variableMemberAccessor)

Method Summary

Modifier and Type	Method	Description
Iterable<VariableListenerWithSources<Solution_>>	buildVariableListeners(SupplyManager supplyManager)
Demand<?>	getProvidedDemand()
List<VariableDescriptor<Solution_>>	getSourceVariableDescriptorList()	Inverse of VariableDescriptor.getSinkVariableDescriptorList().
Collection<Class<? extends AbstractVariableListener>>	getVariableListenerClasses()
boolean	hasVariableListener()
void	linkVariableDescriptors(DescriptorPolicy descriptorPolicy)
void	processAnnotations(DescriptorPolicy descriptorPolicy)

Methods inherited from class org.optaplanner.core.impl.domain.variable.descriptor.ShadowVariableDescriptor

getGlobalShadowOrder, isGenuineAndUninitialized, setGlobalShadowOrder, toString

Methods inherited from class org.optaplanner.core.impl.domain.variable.descriptor.VariableDescriptor

getEntityDescriptor, getMemberAccessorSpeedNote, getSimpleEntityAndVariableName, getSinkVariableDescriptorList, getValue, getVariableName, getVariablePropertyType, isGenuineListVariable, isValuePotentialAnchor, registerSinkVariableDescriptor, setValue

Methods inherited from class java.lang.Object

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

Field Detail

shadowVariableDescriptor

protected CustomShadowVariableDescriptor<Solution_> shadowVariableDescriptor

Constructor Detail

PiggybackShadowVariableDescriptor

public PiggybackShadowVariableDescriptor(EntityDescriptor<Solution_> entityDescriptor,
                                         MemberAccessor variableMemberAccessor)

Method Detail

processAnnotations

public void processAnnotations(DescriptorPolicy descriptorPolicy)

Specified by:

processAnnotations in class ShadowVariableDescriptor<Solution_>

linkVariableDescriptors

public void linkVariableDescriptors(DescriptorPolicy descriptorPolicy)

Specified by:

linkVariableDescriptors in class VariableDescriptor<Solution_>

getSourceVariableDescriptorList

public List<VariableDescriptor<Solution_>> getSourceVariableDescriptorList()

Description copied from class: ShadowVariableDescriptor

Inverse of VariableDescriptor.getSinkVariableDescriptorList().

Specified by:

getSourceVariableDescriptorList in class ShadowVariableDescriptor<Solution_>

Returns:

never null, only variables affect this shadow variable directly

getVariableListenerClasses

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

Specified by:

getVariableListenerClasses in class ShadowVariableDescriptor<Solution_>

getProvidedDemand

public Demand<?> getProvidedDemand()

Specified by:

getProvidedDemand in class ShadowVariableDescriptor<Solution_>

Returns:

never null

hasVariableListener

public boolean hasVariableListener()

Overrides:

hasVariableListener in class ShadowVariableDescriptor<Solution_>

buildVariableListeners

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

Specified by:

buildVariableListeners in class ShadowVariableDescriptor<Solution_>

Parameters:

supplyManager - never null

Returns:

never null