org.optaplanner.core.api.score.stream

Interface ConstraintStream

All Known Subinterfaces:

BiConstraintStream<A,B>, InnerBiConstraintStream<A,B>, InnerTriConstraintStream<A,B,C>, InnerUniConstraintStream<A>, TriConstraintStream<A,B,C>, UniConstraintStream<A>

All Known Implementing Classes:

AbstractConstraintStream, BavetAbstractBiConstraintStream, BavetAbstractConstraintStream, BavetAbstractTriConstraintStream, BavetAbstractUniConstraintStream, BavetFilterBiConstraintStream, BavetFilterTriConstraintStream, BavetFilterUniConstraintStream, BavetFromUniConstraintStream, BavetGroupBiConstraintStream, BavetGroupBridgeUniConstraintStream, BavetJoinBiConstraintStream, BavetJoinBridgeBiConstraintStream, BavetJoinBridgeUniConstraintStream, BavetJoinTriConstraintStream, BavetScoringBiConstraintStream, BavetScoringTriConstraintStream, BavetScoringUniConstraintStream, DroolsAbstractBiConstraintStream, DroolsAbstractConstraintStream, DroolsAbstractUniConstraintStream, DroolsFilterBiConstraintStream, DroolsFilterUniConstraintStream, DroolsFromUniConstraintStream, DroolsJoinBiConstraintStream, DroolsScoringBiConstraintStream, DroolsScoringUniConstraintStream

public interface ConstraintStream

A constraint stream is a declaration on how to match one, two or more objects. Constraint steams are similar to a declaration of a JDK Stream or an SQL query, but they support incremental score calculation and ScoreDirector.getConstraintMatchTotalMap() score justification}.

An object that passes through constraint streams is called a fact. It's either a problem fact or a planning entity.

A constraint stream is typically created with ConstraintFactory.from(Class) or UniConstraintStream.join(UniConstraintStream, BiJoiner) by joining another constraint stream}. Constraint streams form a directed, non-cyclic graph, with multiple start nodes (which listen to fact changes) and one end node per Constraint (which affect the Score).

Method Summary

Modifier and Type	Method and Description
ConstraintFactory	getConstraintFactory() The ConstraintFactory that build this.
default Constraint	penalize(String constraintName, Score<?> constraintWeight) Negatively impact the Score: subtract the constraintWeight for each match.
Constraint	penalize(String constraintPackage, String constraintName, Score<?> constraintWeight) As defined by penalize(String, Score).
default Constraint	penalizeConfigurable(String constraintName) Negatively impact the Score: subtract the ConstraintWeight for each match.
Constraint	penalizeConfigurable(String constraintPackage, String constraintName) As defined by penalizeConfigurable(String).
default Constraint	reward(String constraintName, Score<?> constraintWeight) Positively impact the Score: add the constraintWeight for each match.
Constraint	reward(String constraintPackage, String constraintName, Score<?> constraintWeight) As defined by reward(String, Score).
default Constraint	rewardConfigurable(String constraintName) Positively impact the Score: add the ConstraintWeight for each match.
Constraint	rewardConfigurable(String constraintPackage, String constraintName) As defined by rewardConfigurable(String).

Method Detail

getConstraintFactory

ConstraintFactory getConstraintFactory()

The ConstraintFactory that build this.

Returns:

never null

penalize

default Constraint penalize(String constraintName,
                            Score<?> constraintWeight)

Negatively impact the Score: subtract the constraintWeight for each match.

To avoid hard-coding the constraintWeight, to allow end-users to weak it, use penalizeConfigurable(String) and a ConstraintConfiguration instead.

The Constraint.getConstraintPackage() defaults to the package of the PlanningSolution class.

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

Returns:

never null

penalize

Constraint penalize(String constraintPackage,
                    String constraintName,
                    Score<?> constraintWeight)

As defined by penalize(String, Score).

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

Returns:

never null

penalizeConfigurable

default Constraint penalizeConfigurable(String constraintName)

Negatively impact the Score: subtract the ConstraintWeight for each match.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint is deactivated if the ConstraintWeight is zero. If there is no ConstraintConfiguration, use penalize(String, Score) instead.

The Constraint.getConstraintPackage() defaults to ConstraintConfiguration.constraintPackage().

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

Returns:

never null

penalizeConfigurable

Constraint penalizeConfigurable(String constraintPackage,
                                String constraintName)

As defined by penalizeConfigurable(String).

Parameters:

constraintPackage - never null

constraintName - never null

Returns:

never null

reward

default Constraint reward(String constraintName,
                          Score<?> constraintWeight)

Positively impact the Score: add the constraintWeight for each match.

To avoid hard-coding the constraintWeight, to allow end-users to weak it, use penalizeConfigurable(String) and a ConstraintConfiguration instead.

The Constraint.getConstraintPackage() defaults to the package of the PlanningSolution class.

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintWeight - never null

Returns:

never null

reward

Constraint reward(String constraintPackage,
                  String constraintName,
                  Score<?> constraintWeight)

As defined by reward(String, Score).

Parameters:

constraintPackage - never null

constraintName - never null

constraintWeight - never null

Returns:

never null

rewardConfigurable

default Constraint rewardConfigurable(String constraintName)

Positively impact the Score: add the ConstraintWeight for each match.

The constraintWeight comes from an ConstraintWeight annotated member on the ConstraintConfiguration, so end users can change the constraint weights dynamically. This constraint is deactivated if the ConstraintWeight is zero. If there is no ConstraintConfiguration, use reward(String, Score) instead.

The Constraint.getConstraintPackage() defaults to ConstraintConfiguration.constraintPackage().

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

Returns:

never null

rewardConfigurable

Constraint rewardConfigurable(String constraintPackage,
                              String constraintName)

As defined by rewardConfigurable(String).

Parameters:

constraintPackage - never null

constraintName - never null

Returns:

never null