Package org.optaplanner.core.api.score.stream

Interface ConstraintFactory

All Known Implementing Classes:

BavetConstraintFactory, DroolsConstraintFactory, 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> UniConstraintStream<A>	forEach(Class<A> sourceClass)	Start a ConstraintStream of all instances of the sourceClass that are known as problem facts or planning entities.
<A> UniConstraintStream<A>	forEachIncludingNullVars(Class<A> sourceClass)	As defined by forEach(Class), but without any filtering of null planning entity variables.
default <A> BiConstraintStream<A,A>	forEachUniquePair(Class<A> sourceClass)	Create a new BiConstraintStream for every unique combination of A and another A with a higher PlanningId.
<A> BiConstraintStream<A,A>	forEachUniquePair(Class<A> sourceClass, 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).
default <A> BiConstraintStream<A,A>	forEachUniquePair(Class<A> sourceClass, BiJoiner<A,A>... joiners)	As defined by forEachUniquePair(Class, BiJoiner).
default <A> BiConstraintStream<A,A>	forEachUniquePair(Class<A> sourceClass, BiJoiner<A,A> joiner1, BiJoiner<A,A> joiner2)	As defined by fromUniquePair(Class, BiJoiner).
default <A> BiConstraintStream<A,A>	forEachUniquePair(Class<A> sourceClass, BiJoiner<A,A> joiner1, BiJoiner<A,A> joiner2, BiJoiner<A,A> joiner3)	As defined by fromUniquePair(Class, BiJoiner).
default <A> BiConstraintStream<A,A>	forEachUniquePair(Class<A> sourceClass, BiJoiner<A,A> joiner1, BiJoiner<A,A> joiner2, BiJoiner<A,A> joiner3, BiJoiner<A,A> joiner4)	As defined by fromUniquePair(Class, BiJoiner).
<A> UniConstraintStream<A>	from(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 both nullable and non-nullable planning variables.
<A> UniConstraintStream<A>	fromUnfiltered(Class<A> fromClass)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of forEachIncludingNullVars(Class).
default <A> BiConstraintStream<A,A>	fromUniquePair(Class<A> fromClass)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of forEachUniquePair(Class), which exhibits the same behavior for both nullable and non-nullable planning variables.
<A> BiConstraintStream<A,A>	fromUniquePair(Class<A> fromClass, BiJoiner<A,A> joiner)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of forEachUniquePair(Class, BiJoiner), which exhibits the same behavior for both nullable and non-nullable planning variables.
default <A> BiConstraintStream<A,A>	fromUniquePair(Class<A> fromClass, BiJoiner<A,A>... joiners)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of forEachUniquePair(Class, BiJoiner...), which exhibits the same behavior for both nullable and non-nullable planning variables.
default <A> BiConstraintStream<A,A>	fromUniquePair(Class<A> fromClass, BiJoiner<A,A> joiner1, BiJoiner<A,A> joiner2)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of forEachUniquePair(Class, BiJoiner, BiJoiner), which exhibits the same behavior for both nullable and non-nullable planning variables.
default <A> BiConstraintStream<A,A>	fromUniquePair(Class<A> fromClass, BiJoiner<A,A> joiner1, BiJoiner<A,A> joiner2, BiJoiner<A,A> joiner3)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of forEachUniquePair(Class, BiJoiner, BiJoiner, BiJoiner), which exhibits the same behavior for both nullable and non-nullable planning variables.
default <A> BiConstraintStream<A,A>	fromUniquePair(Class<A> fromClass, BiJoiner<A,A> joiner1, BiJoiner<A,A> joiner2, BiJoiner<A,A> joiner3, BiJoiner<A,A> joiner4)	Deprecated, for removal: This API element is subject to removal in a future version. in favor of forEachUniquePair(Class, BiJoiner, BiJoiner, BiJoiner, BiJoiner), which exhibits the same behavior for both nullable and non-nullable planning variables.
String	getDefaultConstraintPackage()	This is ConstraintConfiguration.constraintPackage() if available, otherwise the package of the PlanningSolution class.

Method Detail

getDefaultConstraintPackage

String getDefaultConstraintPackage()

This is ConstraintConfiguration.constraintPackage() if available, otherwise the package of the PlanningSolution class.

Returns:

never null

forEach

<A> UniConstraintStream<A> forEach(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.

Type Parameters:

A - the type of the matched problem fact or planning entity

Parameters:

sourceClass - never null

Returns:

never null

forEachIncludingNullVars

<A> UniConstraintStream<A> forEachIncludingNullVars(Class<A> sourceClass)

As defined by forEach(Class), but without any filtering of null planning entity variables.

Type Parameters:

A - the type of the matched problem fact or planning entity

Parameters:

sourceClass - never null

Returns:

never null

forEachUniquePair

default <A> BiConstraintStream<A,A> forEachUniquePair(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

Parameters:

sourceClass - never null

Returns:

a stream that matches every unique combination of A and another A

forEachUniquePair

<A> BiConstraintStream<A,A> forEachUniquePair(Class<A> sourceClass,
                                                    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

Parameters:

sourceClass - never null

joiner - never null

Returns:

a stream that matches every unique combination of A and another A for which the BiJoiner is true

forEachUniquePair

default <A> BiConstraintStream<A,A> forEachUniquePair(Class<A> sourceClass,
                                                            BiJoiner<A,A> joiner1,
                                                            BiJoiner<A,A> joiner2)

As defined by fromUniquePair(Class, BiJoiner).

Type Parameters:

A - the type of the matched problem fact or planning entity

Parameters:

sourceClass - never null

joiner1 - never null

joiner2 - never null

Returns:

a stream that matches every unique combination of A and another A for which all the joiners are true

forEachUniquePair

default <A> BiConstraintStream<A,A> forEachUniquePair(Class<A> sourceClass,
                                                            BiJoiner<A,A> joiner1,
                                                            BiJoiner<A,A> joiner2,
                                                            BiJoiner<A,A> joiner3)

As defined by fromUniquePair(Class, BiJoiner).

Type Parameters:

A - the type of the matched problem fact or planning entity

Parameters:

sourceClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

Returns:

a stream that matches every unique combination of A and another A for which all the joiners are true

forEachUniquePair

default <A> BiConstraintStream<A,A> forEachUniquePair(Class<A> sourceClass,
                                                            BiJoiner<A,A> joiner1,
                                                            BiJoiner<A,A> joiner2,
                                                            BiJoiner<A,A> joiner3,
                                                            BiJoiner<A,A> joiner4)

As defined by fromUniquePair(Class, BiJoiner).

Type Parameters:

A - the type of the matched problem fact or planning entity

Parameters:

sourceClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

joiner4 - never null

Returns:

a stream that matches every unique combination of A and another A for which all the joiners are true

forEachUniquePair

default <A> BiConstraintStream<A,A> forEachUniquePair(Class<A> sourceClass,
                                                            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

Parameters:

sourceClass - never null

joiners - never null

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> UniConstraintStream<A> from(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 both nullable and non-nullable planning variables.

This method is deprecated. Migrate uses of this method to forEach(Class), but first understand this:

• If none of your planning variables are explicitly set to nullable=true, then the replacement by forEach(Class) has little to no impact. Subsequent conditional propagation calls (UniConstraintStream.ifExists(java.lang.Class<B>, org.optaplanner.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 are nullable=true, 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 forEachIncludingNullVars(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

Parameters:

fromClass - never null

Returns:

never null

fromUnfiltered

@Deprecated(forRemoval=true)
<A> UniConstraintStream<A> fromUnfiltered(Class<A> fromClass)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of forEachIncludingNullVars(Class).

This method is deprecated. Migrate uses of this method to forEachIncludingNullVars(Class), but first understand that subsequent joins and conditional propagation calls (UniConstraintStream.ifExists(java.lang.Class<B>, org.optaplanner.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

Parameters:

fromClass - never null

Returns:

never null

fromUniquePair

@Deprecated(forRemoval=true)
default <A> BiConstraintStream<A,A> fromUniquePair(Class<A> fromClass)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of forEachUniquePair(Class), which exhibits the same behavior for both nullable and non-nullable planning variables.

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

Parameters:

fromClass - never null

Returns:

a stream that matches every unique combination of A and another A

fromUniquePair

@Deprecated(forRemoval=true)
<A> BiConstraintStream<A,A> fromUniquePair(Class<A> fromClass,
                                                 BiJoiner<A,A> joiner)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of forEachUniquePair(Class, BiJoiner), which exhibits the same behavior for both nullable and non-nullable planning variables.

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

Parameters:

fromClass - never null

joiner - never null

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> BiConstraintStream<A,A> fromUniquePair(Class<A> fromClass,
                                                         BiJoiner<A,A> joiner1,
                                                         BiJoiner<A,A> joiner2)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of forEachUniquePair(Class, BiJoiner, BiJoiner), which exhibits the same behavior for both nullable and non-nullable planning variables.

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

Parameters:

fromClass - never null

joiner1 - never null

joiner2 - never null

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> BiConstraintStream<A,A> fromUniquePair(Class<A> fromClass,
                                                         BiJoiner<A,A> joiner1,
                                                         BiJoiner<A,A> joiner2,
                                                         BiJoiner<A,A> joiner3)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of forEachUniquePair(Class, BiJoiner, BiJoiner, BiJoiner), which exhibits the same behavior for both nullable and non-nullable planning variables.

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

Parameters:

fromClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

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> BiConstraintStream<A,A> fromUniquePair(Class<A> fromClass,
                                                         BiJoiner<A,A> joiner1,
                                                         BiJoiner<A,A> joiner2,
                                                         BiJoiner<A,A> joiner3,
                                                         BiJoiner<A,A> joiner4)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of forEachUniquePair(Class, BiJoiner, BiJoiner, BiJoiner, BiJoiner), which exhibits the same behavior for both nullable and non-nullable planning variables.

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

Parameters:

fromClass - never null

joiner1 - never null

joiner2 - never null

joiner3 - never null

joiner4 - never null

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> BiConstraintStream<A,A> fromUniquePair(Class<A> fromClass,
                                                         BiJoiner<A,A>... joiners)

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of forEachUniquePair(Class, BiJoiner...), which exhibits the same behavior for both nullable and non-nullable planning variables.

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

Parameters:

fromClass - never null

joiners - never null

Returns:

a stream that matches every unique combination of A and another A for which all the joiners are true