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

Class ListVariableDescriptor<Solution_>

java.lang.Object

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

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

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

public final class ListVariableDescriptor<Solution_>
extends GenuineVariableDescriptor<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

Constructor	Description
ListVariableDescriptor(int ordinal, EntityDescriptor<Solution_> entityDescriptor, MemberAccessor variableMemberAccessor)

Method Summary

Modifier and Type	Method	Description
boolean	acceptsValueType(Class<?> valueType)
void	addElement(Object entity, int index, Object element)
boolean	allowsUnassignedValues()
int	countUnassigned(Solution_ solution)
<Value_> Value_	getElement(Object entity, int index)
Class<?>	getElementType()
<A, B> BiPredicate<A,B>	getEntityContainsPinnedValuePredicate()
int	getFirstUnpinnedIndex(Object entity)
<A> BiPredicate<A,Object>	getInListPredicate()
InverseRelationShadowVariableDescriptor<Solution_>	getInverseRelationShadowVariableDescriptor()
int	getListSize(Object entity)
Object	getRandomUnpinnedElement(Object entity, Random workingRandom)
ListVariableStateDemand<Solution_>	getStateDemand()
List<Object>	getUnpinnedSubList(Object entity)
int	getUnpinnedSubListSize(Object entity)
List<Object>	getValue(Object entity)
boolean	isElementPinned(Solution_ workingSolution, Object entity, int index)
boolean	isInitialized(Object entity)	A basic planning variable allowing unassigned and @PlanningListVariable are always considered initialized.
protected void	processPropertyAnnotations(DescriptorPolicy descriptorPolicy)
protected void	processValueRangeRefs(DescriptorPolicy descriptorPolicy, String[] valueRangeProviderRefs)
Object	removeElement(Object entity, int index)
<Value_> Value_	setElement(Object entity, int index, Value_ element)
boolean	supportsPinning()

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

getDecreasingStrengthSorter, getIncreasingStrengthSorter, getValueRangeDescriptor, getValueRangeSize, isReinitializable, isValueRangeEntityIndependent, linkVariableDescriptors, processAnnotations, processStrength, toString

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

canBeUsedAsSource, getEntityDescriptor, getMemberAccessorSpeedNote, getOrdinal, getSimpleEntityAndVariableName, getSinkVariableDescriptorList, 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

ListVariableDescriptor

public ListVariableDescriptor(int ordinal,
 EntityDescriptor<Solution_> entityDescriptor,
 MemberAccessor variableMemberAccessor)

Method Details

getStateDemand

public ListVariableStateDemand<Solution_> getStateDemand()

getInListPredicate

public <A> BiPredicate<A,Object> getInListPredicate()

getEntityContainsPinnedValuePredicate

public <A,
B> BiPredicate<A,B> getEntityContainsPinnedValuePredicate()

allowsUnassignedValues

public boolean allowsUnassignedValues()

processPropertyAnnotations

protected void processPropertyAnnotations(DescriptorPolicy descriptorPolicy)

Specified by:

processPropertyAnnotations in class GenuineVariableDescriptor<Solution_>

processValueRangeRefs

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

Overrides:

processValueRangeRefs in class GenuineVariableDescriptor<Solution_>

acceptsValueType

public boolean acceptsValueType(Class<?> valueType)

Specified by:

acceptsValueType in class GenuineVariableDescriptor<Solution_>

isInitialized

public boolean isInitialized(Object entity)

Description copied from class: GenuineVariableDescriptor

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

Specified by:

isInitialized in class GenuineVariableDescriptor<Solution_>

Parameters:

entity - never null

Returns:

true if the variable on that entity is initialized

getElementType

public Class<?> getElementType()

countUnassigned

public int countUnassigned(Solution_ solution)

getInverseRelationShadowVariableDescriptor

public InverseRelationShadowVariableDescriptor<Solution_> getInverseRelationShadowVariableDescriptor()

getValue

public List<Object> getValue(Object entity)

Overrides:

getValue in class VariableDescriptor<Solution_>

removeElement

public Object removeElement(Object entity,
 int index)

addElement

public void addElement(Object entity,
 int index,
 Object element)

getElement

public <Value_> Value_ getElement(Object entity,
 int index)

setElement

public <Value_> Value_ setElement(Object entity,
 int index,
 Value_ element)

getListSize

public int getListSize(Object entity)

supportsPinning

public boolean supportsPinning()

isElementPinned

public boolean isElementPinned(Solution_ workingSolution,
 Object entity,
 int index)

getRandomUnpinnedElement

public Object getRandomUnpinnedElement(Object entity,
 Random workingRandom)

getUnpinnedSubListSize

public int getUnpinnedSubListSize(Object entity)

getUnpinnedSubList

public List<Object> getUnpinnedSubList(Object entity)

getFirstUnpinnedIndex

public int getFirstUnpinnedIndex(Object entity)