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

Class CompositeValueRangeDescriptor<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.domain.valuerange.descriptor.AbstractValueRangeDescriptor<Solution_>

ai.timefold.solver.core.impl.domain.valuerange.descriptor.CompositeValueRangeDescriptor<Solution_>

Type Parameters:

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

All Implemented Interfaces:

EntityIndependentValueRangeDescriptor<Solution_>, ValueRangeDescriptor<Solution_>

public class CompositeValueRangeDescriptor<Solution_>
extends AbstractValueRangeDescriptor<Solution_>
implements EntityIndependentValueRangeDescriptor<Solution_>

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<ValueRangeDescriptor<Solution_>>	childValueRangeDescriptorList
protected boolean	entityIndependent

Fields inherited from class ai.timefold.solver.core.impl.domain.valuerange.descriptor.AbstractValueRangeDescriptor

addNullInValueRange, variableDescriptor

Constructor Summary

Constructors

Constructor	Description
CompositeValueRangeDescriptor(GenuineVariableDescriptor<Solution_> variableDescriptor, boolean addNullInValueRange, List<ValueRangeDescriptor<Solution_>> childValueRangeDescriptorList)

Method Summary

Modifier and Type	Method	Description
<T> ValueRange<T>	extractValueRange(Solution_ solution)	As specified by ValueRangeDescriptor.extractValueRange(Solution_, java.lang.Object).
<Value_> ValueRange<Value_>	extractValueRange(Solution_ solution, Object entity)
long	extractValueRangeSize(Solution_ solution)	As specified by ValueRangeDescriptor.extractValueRangeSize(Solution_, java.lang.Object).
long	extractValueRangeSize(Solution_ solution, Object entity)
boolean	isCountable()
boolean	isEntityIndependent()	If this method return true, this instance is safe to cast to EntityIndependentValueRangeDescriptor, otherwise it requires an entity to determine the ValueRange.

Methods inherited from class ai.timefold.solver.core.impl.domain.valuerange.descriptor.AbstractValueRangeDescriptor

doNullInValueRangeWrapping, getVariableDescriptor, mightContainEntity, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.timefold.solver.core.impl.domain.valuerange.descriptor.ValueRangeDescriptor

getVariableDescriptor, mightContainEntity

Field Details

childValueRangeDescriptorList

protected final List<ValueRangeDescriptor<Solution_>> childValueRangeDescriptorList

entityIndependent

protected boolean entityIndependent

Constructor Details

CompositeValueRangeDescriptor

public CompositeValueRangeDescriptor(GenuineVariableDescriptor<Solution_> variableDescriptor,
 boolean addNullInValueRange,
 List<ValueRangeDescriptor<Solution_>> childValueRangeDescriptorList)

Method Details

isCountable

public boolean isCountable()

Specified by:

isCountable in interface ValueRangeDescriptor<Solution_>

Returns:

true if the ValueRange is countable (for example a double value range between 1.2 and 1.4 is not countable)

isEntityIndependent

public boolean isEntityIndependent()

Description copied from interface: ValueRangeDescriptor

If this method return true, this instance is safe to cast to EntityIndependentValueRangeDescriptor, otherwise it requires an entity to determine the ValueRange.

Specified by:

isEntityIndependent in interface ValueRangeDescriptor<Solution_>

Returns:

true if the ValueRange is the same for all entities of the same solution

extractValueRange

public <Value_> ValueRange<Value_> extractValueRange(Solution_ solution,
 Object entity)

Specified by:

extractValueRange in interface ValueRangeDescriptor<Solution_>

Parameters:

solution - never null

entity - never null. To avoid this parameter, use EntityIndependentValueRangeDescriptor.extractValueRange(Solution_) instead.

Returns:

never null

extractValueRange

public <T> ValueRange<T> extractValueRange(Solution_ solution)

Description copied from interface: EntityIndependentValueRangeDescriptor

As specified by ValueRangeDescriptor.extractValueRange(Solution_, java.lang.Object).

Specified by:

extractValueRange in interface EntityIndependentValueRangeDescriptor<Solution_>

Parameters:

solution - never null

Returns:

never null

See Also:

• ValueRangeDescriptor.extractValueRange(Solution_, java.lang.Object)

extractValueRangeSize

public long extractValueRangeSize(Solution_ solution,
 Object entity)

Specified by:

extractValueRangeSize in interface ValueRangeDescriptor<Solution_>

Parameters:

solution - never null

entity - never null. To avoid this parameter, use EntityIndependentValueRangeDescriptor.extractValueRangeSize(Solution_) instead.

Returns:

never null

extractValueRangeSize

public long extractValueRangeSize(Solution_ solution)

Description copied from interface: EntityIndependentValueRangeDescriptor

As specified by ValueRangeDescriptor.extractValueRangeSize(Solution_, java.lang.Object).

Specified by:

extractValueRangeSize in interface EntityIndependentValueRangeDescriptor<Solution_>

Parameters:

solution - never null

Returns:

never null

See Also:

• ValueRangeDescriptor.extractValueRangeSize(Solution_, java.lang.Object)