org.optaplanner.core.api.score.buildin.simplebigdecimal

Class SimpleBigDecimalScoreHolder

java.lang.Object

org.optaplanner.core.api.score.holder.AbstractScoreHolder<SimpleBigDecimalScore>

org.optaplanner.core.api.score.buildin.simplebigdecimal.SimpleBigDecimalScoreHolder

All Implemented Interfaces:

Serializable, ScoreHolder<SimpleBigDecimalScore>

public class SimpleBigDecimalScoreHolder
extends AbstractScoreHolder<SimpleBigDecimalScore>

See Also:

SimpleBigDecimalScore, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.optaplanner.core.api.score.holder.AbstractScoreHolder

AbstractScoreHolder.ConstraintActivationUnMatchListener

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<org.kie.api.definition.rule.Rule,BiConsumer<org.kie.api.runtime.rule.RuleContext,BigDecimal>>	matchExecutorByNumberMap
protected BigDecimal	score

Fields inherited from class org.optaplanner.core.api.score.holder.AbstractScoreHolder

constraintMatchEnabled, constraintMatchTotalMap, indictmentMap, zeroScore

Constructor Summary

Constructors

Constructor and Description
SimpleBigDecimalScoreHolder(boolean constraintMatchEnabled)

Method Summary

Modifier and Type	Method and Description
void	addConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext, BigDecimal weight)
void	configureConstraintWeight(org.kie.api.definition.rule.Rule rule, SimpleBigDecimalScore constraintWeight) Sets up a ConstraintWeight from the ConstraintConfiguration during initialization.
SimpleBigDecimalScore	extractScore(int initScore) Extracts the Score, calculated by the KieSession for DroolsScoreDirector.
BigDecimal	getScore()
void	penalize(org.kie.api.runtime.rule.RuleContext kcontext) Penalize a match by the ConstraintWeight negated.
void	penalize(org.kie.api.runtime.rule.RuleContext kcontext, BigDecimal weightMultiplier) Penalize a match by the ConstraintWeight negated and multiplied with the weightMultiplier for all score levels.
void	reward(org.kie.api.runtime.rule.RuleContext kcontext) Reward a match by the ConstraintWeight.
void	reward(org.kie.api.runtime.rule.RuleContext kcontext, BigDecimal weightMultiplier) Reward a match by the ConstraintWeight multiplied with the weightMultiplier for all score levels.

Methods inherited from class org.optaplanner.core.api.score.holder.AbstractScoreHolder

extractJustificationList, getConstraintMatchTotals, getIndictmentMap, isConstraintMatchEnabled, registerConstraintMatch

Methods inherited from class java.lang.Object

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

Field Detail

matchExecutorByNumberMap

protected final Map<org.kie.api.definition.rule.Rule,BiConsumer<org.kie.api.runtime.rule.RuleContext,BigDecimal>> matchExecutorByNumberMap

score

protected BigDecimal score

Constructor Detail

SimpleBigDecimalScoreHolder

public SimpleBigDecimalScoreHolder(boolean constraintMatchEnabled)

Method Detail

getScore

public BigDecimal getScore()

configureConstraintWeight

public void configureConstraintWeight(org.kie.api.definition.rule.Rule rule,
                                      SimpleBigDecimalScore constraintWeight)

Description copied from interface: ScoreHolder

Sets up a ConstraintWeight from the ConstraintConfiguration during initialization.

Specified by:

configureConstraintWeight in interface ScoreHolder<SimpleBigDecimalScore>

Overrides:

configureConstraintWeight in class AbstractScoreHolder<SimpleBigDecimalScore>

Parameters:

rule - never null

constraintWeight - never null, with Score.getInitScore() equal to 0.

penalize

public void penalize(org.kie.api.runtime.rule.RuleContext kcontext)

Penalize a match by the ConstraintWeight negated.

Parameters:

kcontext - never null, the magic variable in DRL

penalize

public void penalize(org.kie.api.runtime.rule.RuleContext kcontext,
                     BigDecimal weightMultiplier)

Penalize a match by the ConstraintWeight negated and multiplied with the weightMultiplier for all score levels.

Parameters:

kcontext - never null, the magic variable in DRL

weightMultiplier - at least 0

reward

public void reward(org.kie.api.runtime.rule.RuleContext kcontext)

Reward a match by the ConstraintWeight.

Parameters:

kcontext - never null, the magic variable in DRL

reward

public void reward(org.kie.api.runtime.rule.RuleContext kcontext,
                   BigDecimal weightMultiplier)

Reward a match by the ConstraintWeight multiplied with the weightMultiplier for all score levels.

Parameters:

kcontext - never null, the magic variable in DRL

weightMultiplier - at least 0

addConstraintMatch

public void addConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext,
                               BigDecimal weight)

Parameters:

kcontext - never null, the magic variable in DRL

weight - never null, higher is better, negative for a penalty, positive for a reward

extractScore

public SimpleBigDecimalScore extractScore(int initScore)

Description copied from interface: ScoreHolder

Extracts the Score, calculated by the KieSession for DroolsScoreDirector.

Should not be called directly, use ScoreDirector.calculateScore() instead.

Parameters:

initScore - <= 0, managed by OptaPlanner, needed as a parameter in the Score's creation method, see Score.getInitScore()

Returns:

never null, the Score of the working PlanningSolution