All Known Implementing Classes:: BavetConstraintFactory, InnerConstraintFactory

public interface ConstraintFactory

The factory to create every ConstraintStream (for example with forEach(Class)) which ends in a Constraint returned by ConstraintProvider.defineConstraints(ConstraintFactory).

Method Summary

Modifier and Type

Method

Description

<A> @NonNull UniConstraintStream<A>

forEach(@NonNull Class<A> sourceClass)

Start a ConstraintStream of all instances of the sourceClass that are known as problem facts or planning entities.

default <A> @NonNull UniConstraintStream<A>

forEachIncludingNullVars(@NonNull Class<A> sourceClass)

Deprecated, for removal: This API element is subject to removal in a future version.
Use forEachIncludingUnassigned(Class) instead.

<A> @NonNull UniConstraintStream<A>

forEachIncludingUnassigned(@NonNull Class<A> sourceClass)

As defined by forEach(Class), but without any filtering of unassigned planning entities (for PlanningVariable.allowsUnassigned()) or shadow entities not assigned to any applicable list variable (for PlanningListVariable.allowsUnassignedValues()).

default <A> @NonNull BiConstraintStream<A,A>

forEachUniquePair(@NonNull Class<A> sourceClass)

Create a new BiConstraintStream for every unique combination of A and another A with a higher PlanningId.

default <A> @NonNull BiConstraintStream<A,A>

forEachUniquePair(@NonNull Class<A> sourceClass, @NonNull BiJoiner<A,A> joiner)

Create a new BiConstraintStream for every unique combination of A and another A with a higher PlanningId for which the BiJoiner is true (for the properties it extracts from both facts).

<A> @NonNull BiConstraintStream<A,A>

forEachUniquePair(@NonNull Class<A> sourceClass, @NonNull BiJoiner<A,A>... joiners)

As defined by forEachUniquePair(Class, BiJoiner).

default <A> @NonNull BiConstraintStream<A,A>

forEachUniquePair(@NonNull Class<A> sourceClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2)

As defined by forEachUniquePair(Class, BiJoiner).

default <A> @NonNull BiConstraintStream<A,A>

forEachUniquePair(@NonNull Class<A> sourceClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3)

As defined by forEachUniquePair(Class, BiJoiner).

default <A> @NonNull BiConstraintStream<A,A>

forEachUniquePair(@NonNull Class<A> sourceClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3, @NonNull BiJoiner<A,A> joiner4)

As defined by forEachUniquePair(Class, BiJoiner).

<A> @NonNull UniConstraintStream<A>

from(@NonNull Class<A> fromClass)

Deprecated, for removal: This API element is subject to removal in a future version.
This method is deprecated in favor of forEach(Class), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.

<A> @NonNull UniConstraintStream<A>

fromUnfiltered(@NonNull Class<A> fromClass)

Deprecated, for removal: This API element is subject to removal in a future version.
Prefer forEachIncludingUnassigned(Class).

default <A> @NonNull BiConstraintStream<A,A>

fromUniquePair(@NonNull Class<A> fromClass)

Deprecated, for removal: This API element is subject to removal in a future version.
Prefer forEachUniquePair(Class), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.

default <A> @NonNull BiConstraintStream<A,A>

fromUniquePair(@NonNull Class<A> fromClass, @NonNull BiJoiner<A,A> joiner)

Deprecated, for removal: This API element is subject to removal in a future version.
Prefer forEachUniquePair(Class, BiJoiner), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.

<A> @NonNull BiConstraintStream<A,A>

fromUniquePair(@NonNull Class<A> fromClass, @NonNull BiJoiner<A,A>... joiners)

Deprecated, for removal: This API element is subject to removal in a future version.
Prefer forEachUniquePair(Class, BiJoiner...), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.

default <A> @NonNull BiConstraintStream<A,A>

fromUniquePair(@NonNull Class<A> fromClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2)

Deprecated, for removal: This API element is subject to removal in a future version.
Prefer forEachUniquePair(Class, BiJoiner, BiJoiner), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.

default <A> @NonNull BiConstraintStream<A,A>

fromUniquePair(@NonNull Class<A> fromClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3)

Deprecated, for removal: This API element is subject to removal in a future version.
Prefer forEachUniquePair(Class, BiJoiner, BiJoiner, BiJoiner), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.

default <A> @NonNull BiConstraintStream<A,A>

fromUniquePair(@NonNull Class<A> fromClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3, @NonNull BiJoiner<A,A> joiner4)

Deprecated, for removal: This API element is subject to removal in a future version.
Prefer forEachUniquePair(Class, BiJoiner, BiJoiner, BiJoiner, BiJoiner), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.

@NonNull String

getDefaultConstraintPackage()

Deprecated, for removal: This API element is subject to removal in a future version.
Do not rely on any constraint package in user code.

Method Details
- getDefaultConstraintPackage
  
  @Deprecated(forRemoval=true, since="1.13.0") @NonNull String getDefaultConstraintPackage()
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Do not rely on any constraint package in user code.
- forEach
  
  <A> @NonNull UniConstraintStream<A> forEach(@NonNull Class<A> sourceClass)
  Start a ConstraintStream of all instances of the sourceClass that are known as problem facts or planning entities.
  If the sourceClass is a PlanningEntity, then it is automatically filtered to only contain entities for which each genuine PlanningVariable (of the sourceClass or a superclass thereof) has a non-null value.
  If the sourceClass is a shadow entity (an entity without any genuine planning variables), and if there exists a genuine PlanningEntity with a PlanningListVariable which accepts instances of this shadow entity as values in that list, and if that list variable allows unassigned values, then this stream will filter out all sourceClass instances which are not present in any instances of that list variable. This is achieved in one of two ways:
  
  If the sourceClass has InverseRelationShadowVariable field referencing instance of an entity with the list variable, the value of that field will be used to determine if the value is assigned. Null in that field means the instance of sourceClass is unassigned.
  
  As fallback, the value is considered assigned if there exists an instance of the entity where its list variable contains the value. This will perform significantly worse and only exists so that using the InverseRelationShadowVariable can remain optional. Adding the field is strongly recommended.
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
- forEachIncludingNullVars
  
  @Deprecated(forRemoval=true, since="1.8.0") default <A> @NonNull UniConstraintStream<A> forEachIncludingNullVars(@NonNull Class<A> sourceClass)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Use forEachIncludingUnassigned(Class) instead.
  
  As defined by forEachIncludingUnassigned(Class).
- forEachIncludingUnassigned
  
  <A> @NonNull UniConstraintStream<A> forEachIncludingUnassigned(@NonNull Class<A> sourceClass)
  
  As defined by forEach(Class), but without any filtering of unassigned planning entities (for PlanningVariable.allowsUnassigned()) or shadow entities not assigned to any applicable list variable (for PlanningListVariable.allowsUnassignedValues()).
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
- forEachUniquePair
  
  default <A> @NonNull BiConstraintStream<A,A> forEachUniquePair(@NonNull Class<A> sourceClass)
  
  Create a new BiConstraintStream for every unique combination of A and another A with a higher PlanningId.
  Important: Filtering this is slower and less scalable than using a joiner, because it barely applies hashing and/or indexing on the properties, so it creates and checks almost every combination of A and A.
  This method is syntactic sugar for UniConstraintStream.join(Class). It automatically adds a lessThan joiner on the PlanningId of A.
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
  
  Returns:
  
  a stream that matches every unique combination of A and another A
- forEachUniquePair
  
  default <A> @NonNull BiConstraintStream<A,A> forEachUniquePair(@NonNull Class<A> sourceClass, @NonNull BiJoiner<A,A> joiner)
  
  Create a new BiConstraintStream for every unique combination of A and another A with a higher PlanningId for which the BiJoiner is true (for the properties it extracts from both facts).
  Important: This is faster and more scalable than not using a forEachUniquePair(Class) joiner} followed by a filter, because it applies hashing and/or indexing on the properties, so it doesn't create nor checks almost every combination of A and A.
  This method is syntactic sugar for UniConstraintStream.join(Class, BiJoiner). It automatically adds a lessThan joiner on the PlanningId of A.
  This method has overloaded methods with multiple BiJoiner parameters.
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
  
  Returns:
  
  a stream that matches every unique combination of A and another A for which the BiJoiner is true
- forEachUniquePair
  
  default <A> @NonNull BiConstraintStream<A,A> forEachUniquePair(@NonNull Class<A> sourceClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2)
  
  As defined by forEachUniquePair(Class, BiJoiner).
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
  
  Returns:
  
  a stream that matches every unique combination of A and another A for which all the joiners are true
- forEachUniquePair
  
  default <A> @NonNull BiConstraintStream<A,A> forEachUniquePair(@NonNull Class<A> sourceClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3)
  
  As defined by forEachUniquePair(Class, BiJoiner).
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
  
  Returns:
  
  a stream that matches every unique combination of A and another A for which all the joiners are true
- forEachUniquePair
  
  default <A> @NonNull BiConstraintStream<A,A> forEachUniquePair(@NonNull Class<A> sourceClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3, @NonNull BiJoiner<A,A> joiner4)
  
  As defined by forEachUniquePair(Class, BiJoiner).
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
  
  Returns:
  
  a stream that matches every unique combination of A and another A for which all the joiners are true
- forEachUniquePair
  
  <A> @NonNull BiConstraintStream<A,A> forEachUniquePair(@NonNull Class<A> sourceClass, @NonNull BiJoiner<A,A>... joiners)
  
  As defined by forEachUniquePair(Class, BiJoiner).
  This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 BiJoiner parameters.
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
  
  Returns:
  
  a stream that matches every unique combination of A and another A for which all the joiners are true
- from
  
  @Deprecated(forRemoval=true) <A> @NonNull UniConstraintStream<A> from(@NonNull Class<A> fromClass)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  This method is deprecated in favor of forEach(Class), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.
  This method is deprecated. Migrate uses of this method to forEach(Class), but first understand this:
  
  If none of your planning variables allow unassigned values, then the replacement by forEach(Class) has little to no impact. Subsequent conditional propagation calls (UniConstraintStream.ifExists(java.lang.Class<B>, ai.timefold.solver.core.api.score.stream.bi.BiJoiner<A, B>) etc.) will now also filter out planning entities with null variables, consistently with forEach(Class) family of methods and with joining.
  
  If any of your planning variables allow unassigned values, then there is severe impact. Calls to the forEach(Class) family of methods will now filter out planning entities with null variables, so most constraints no longer need to do null checks, but the constraint that penalizes unassigned entities (typically a medium constraint) must now use forEachIncludingUnassigned(Class) instead. Subsequent joins and conditional propagation calls will now also consistently filter out planning entities with null variables.
  
  The original Javadoc of this method follows:
  Start a ConstraintStream of all instances of the fromClass that are known as problem facts or planning entities.
  If the fromClass is a PlanningEntity, then it is automatically filtered to only contain fully initialized entities, for which each genuine PlanningVariable (of the fromClass or a superclass thereof) is initialized. This filtering will NOT automatically apply to genuine planning variables of subclass planning entities of the fromClass.
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
- fromUnfiltered
  
  @Deprecated(forRemoval=true) <A> @NonNull UniConstraintStream<A> fromUnfiltered(@NonNull Class<A> fromClass)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Prefer forEachIncludingUnassigned(Class).
  
  This method is deprecated. Migrate uses of this method to forEachIncludingUnassigned(Class), but first understand that subsequent joins and conditional propagation calls (UniConstraintStream.ifExists(java.lang.Class<B>, ai.timefold.solver.core.api.score.stream.bi.BiJoiner<A, B>) etc.) will now also consistently filter out planning entities with null variables.
  The original Javadoc of this method follows:
  As defined by from(Class), but without any filtering of uninitialized planning entities.
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
- fromUniquePair
  
  @Deprecated(forRemoval=true) default <A> @NonNull BiConstraintStream<A,A> fromUniquePair(@NonNull Class<A> fromClass)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Prefer forEachUniquePair(Class), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.
  
  This method is deprecated. Migrate uses of this method to forEachUniquePair(Class), but first understand that the same precautions apply as with the use of from(Class).
  The original Javadoc of this method follows:
  Create a new BiConstraintStream for every unique combination of A and another A with a higher PlanningId.
  Important: Filtering this is slower and less scalable than using a joiner, because it barely applies hashing and/or indexing on the properties, so it creates and checks almost every combination of A and A.
  This method is syntactic sugar for UniConstraintStream.join(Class). It automatically adds a lessThan joiner on the PlanningId of A.
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
  
  Returns:
  
  a stream that matches every unique combination of A and another A
- fromUniquePair
  
  @Deprecated(forRemoval=true) default <A> @NonNull BiConstraintStream<A,A> fromUniquePair(@NonNull Class<A> fromClass, @NonNull BiJoiner<A,A> joiner)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Prefer forEachUniquePair(Class, BiJoiner), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.
  
  This method is deprecated. Migrate uses of this method to forEachUniquePair(Class, BiJoiner), but first understand that the same precautions apply as with the use of from(Class).
  The original Javadoc of this method follows:
  Create a new BiConstraintStream for every unique combination of A and another A with a higher PlanningId for which the BiJoiner is true (for the properties it extracts from both facts).
  Important: This is faster and more scalable than not using a fromUniquePair(Class) joiner} followed by a filter, because it applies hashing and/or indexing on the properties, so it doesn't create nor checks almost every combination of A and A.
  This method is syntactic sugar for UniConstraintStream.join(Class, BiJoiner). It automatically adds a lessThan joiner on the PlanningId of A.
  This method has overloaded methods with multiple BiJoiner parameters.
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
  
  Returns:
  
  a stream that matches every unique combination of A and another A for which the BiJoiner is true
- fromUniquePair
  
  @Deprecated(forRemoval=true) default <A> @NonNull BiConstraintStream<A,A> fromUniquePair(@NonNull Class<A> fromClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Prefer forEachUniquePair(Class, BiJoiner, BiJoiner), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.
  
  This method is deprecated. Migrate uses of this method to forEachUniquePair(Class, BiJoiner, BiJoiner), but first understand that the same precautions apply as with the use of from(Class).
  The original Javadoc of this method follows:
  As defined by fromUniquePair(Class, BiJoiner).
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
  
  Returns:
  
  a stream that matches every unique combination of A and another A for which all the joiners are true
- fromUniquePair
  
  @Deprecated(forRemoval=true) default <A> @NonNull BiConstraintStream<A,A> fromUniquePair(@NonNull Class<A> fromClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Prefer forEachUniquePair(Class, BiJoiner, BiJoiner, BiJoiner), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.
  
  This method is deprecated. Migrate uses of this method to forEachUniquePair(Class, BiJoiner, BiJoiner, BiJoiner), but first understand that the same precautions apply as with the use of from(Class).
  The original Javadoc of this method follows:
  As defined by fromUniquePair(Class, BiJoiner).
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
  
  Returns:
  
  a stream that matches every unique combination of A and another A for which all the joiners are true
- fromUniquePair
  
  @Deprecated(forRemoval=true) default <A> @NonNull BiConstraintStream<A,A> fromUniquePair(@NonNull Class<A> fromClass, @NonNull BiJoiner<A,A> joiner1, @NonNull BiJoiner<A,A> joiner2, @NonNull BiJoiner<A,A> joiner3, @NonNull BiJoiner<A,A> joiner4)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Prefer forEachUniquePair(Class, BiJoiner, BiJoiner, BiJoiner, BiJoiner), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.
  
  This method is deprecated. Migrate uses of this method to forEachUniquePair(Class, BiJoiner, BiJoiner, BiJoiner, BiJoiner), but first understand that the same precautions apply as with the use of from(Class).
  The original Javadoc of this method follows:
  As defined by fromUniquePair(Class, BiJoiner).
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
  
  Returns:
  
  a stream that matches every unique combination of A and another A for which all the joiners are true
- fromUniquePair
  
  @Deprecated(forRemoval=true) <A> @NonNull BiConstraintStream<A,A> fromUniquePair(@NonNull Class<A> fromClass, @NonNull BiJoiner<A,A>... joiners)
  
  Deprecated, for removal: This API element is subject to removal in a future version.
  Prefer forEachUniquePair(Class, BiJoiner...), which exhibits the same behavior for planning variables which both allow and don't allow unassigned values.
  
  This method is deprecated. Migrate uses of this method to forEachUniquePair(Class, BiJoiner...), but first understand that the same precautions apply as with the use of from(Class).
  The original Javadoc of this method follows:
  As defined by fromUniquePair(Class, BiJoiner).
  This method causes Unchecked generics array creation for varargs parameter warnings, but we can't fix it with a SafeVarargs annotation because it's an interface method. Therefore, there are overloaded methods with up to 4 BiJoiner parameters.
  
  Type Parameters:
  
  A - the type of the matched problem fact or planning entity
  
  Returns:
  
  a stream that matches every unique combination of A and another A for which all the joiners are true

Interface ConstraintFactory

Method Summary

Method Details

getDefaultConstraintPackage

forEach

forEachIncludingNullVars

forEachIncludingUnassigned

forEachUniquePair

forEachUniquePair

forEachUniquePair

forEachUniquePair

forEachUniquePair

forEachUniquePair

from

fromUnfiltered

fromUniquePair

fromUniquePair

fromUniquePair

fromUniquePair

fromUniquePair

fromUniquePair