Package org.optaplanner.core.impl.score.stream.common

Class AbstractConstraint<Solution_,Constraint_ extends AbstractConstraint<Solution_,Constraint_,ConstraintFactory_>,ConstraintFactory_ extends InnerConstraintFactory<Solution_,Constraint_>>

java.lang.Object

org.optaplanner.core.impl.score.stream.common.AbstractConstraint<Solution_,Constraint_,ConstraintFactory_>

All Implemented Interfaces:

Constraint

Direct Known Subclasses:

BavetConstraint, DroolsConstraint

public abstract class AbstractConstraint<Solution_,Constraint_ extends AbstractConstraint<Solution_,Constraint_,ConstraintFactory_>,ConstraintFactory_ extends InnerConstraintFactory<Solution_,Constraint_>>
extends Object
implements Constraint

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConstraint(ConstraintFactory_ constraintFactory, String constraintPackage, String constraintName, Function<Solution_,Score<?>> constraintWeightExtractor, ScoreImpactType scoreImpactType, boolean isConstraintWeightConfigurable)

Method Summary

Modifier and Type	Method	Description
void	assertCorrectImpact(int impact)
void	assertCorrectImpact(long impact)
void	assertCorrectImpact(BigDecimal impact)
<Score_ extends Score<Score_>> Score_	extractConstraintWeight(Solution_ workingSolution)
ConstraintFactory_	getConstraintFactory()	The ConstraintFactory that build this.
String	getConstraintId()	The constraint id is the constraint package concatenated with "/" and the constraint name.
String	getConstraintName()	The constraint name.
String	getConstraintPackage()	The constraint package is the namespace of the constraint.
ScoreImpactType	getScoreImpactType()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractConstraint

protected AbstractConstraint(ConstraintFactory_ constraintFactory,
                             String constraintPackage,
                             String constraintName,
                             Function<Solution_,Score<?>> constraintWeightExtractor,
                             ScoreImpactType scoreImpactType,
                             boolean isConstraintWeightConfigurable)

Method Detail

extractConstraintWeight

public final <Score_ extends Score<Score_>> Score_ extractConstraintWeight(Solution_ workingSolution)

assertCorrectImpact

public final void assertCorrectImpact(int impact)

assertCorrectImpact

public final void assertCorrectImpact(long impact)

assertCorrectImpact

public final void assertCorrectImpact(BigDecimal impact)

getConstraintFactory

public final ConstraintFactory_ getConstraintFactory()

Description copied from interface: Constraint

The ConstraintFactory that build this.

Specified by:

getConstraintFactory in interface Constraint

Returns:

never null

getConstraintPackage

public final String getConstraintPackage()

Description copied from interface: Constraint

The constraint package is the namespace of the constraint.

When using a ConstraintConfiguration, it is equal to the ConstraintWeight.constraintPackage().

Specified by:

getConstraintPackage in interface Constraint

Returns:

never null

getConstraintName

public final String getConstraintName()

Description copied from interface: Constraint

The constraint name. It might not be unique, but Constraint.getConstraintId() is unique.

When using a ConstraintConfiguration, it is equal to the ConstraintWeight.value().

Specified by:

getConstraintName in interface Constraint

Returns:

never null

getConstraintId

public final String getConstraintId()

Description copied from interface: Constraint

The constraint id is the constraint package concatenated with "/" and the constraint name. It is unique.

Specified by:

getConstraintId in interface Constraint

Returns:

never null

getScoreImpactType

public final ScoreImpactType getScoreImpactType()