Class SimpleScoreHolder
- java.lang.Object
-
- org.optaplanner.core.api.score.holder.AbstractScoreHolder<SimpleScore>
-
- org.optaplanner.core.api.score.buildin.simple.SimpleScoreHolder
-
- All Implemented Interfaces:
Serializable
,ScoreHolder<SimpleScore>
public class SimpleScoreHolder extends AbstractScoreHolder<SimpleScore>
- See Also:
SimpleScore
, 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 Description protected Map<org.kie.api.definition.rule.Rule,BiConsumer<org.kie.api.runtime.rule.RuleContext,Integer>>
matchExecutorByNumberMap
protected int
score
-
Fields inherited from class org.optaplanner.core.api.score.holder.AbstractScoreHolder
constraintMatchEnabled, constraintMatchTotalMap, indictmentMap, zeroScore
-
-
Constructor Summary
Constructors Constructor Description SimpleScoreHolder(boolean constraintMatchEnabled)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext, int weight)
void
configureConstraintWeight(org.kie.api.definition.rule.Rule rule, SimpleScore constraintWeight)
Sets up aConstraintWeight
from theConstraintConfiguration
during initialization.SimpleScore
extractScore(int initScore)
int
getScore()
void
impactScore(org.kie.api.runtime.rule.RuleContext kcontext)
For internal use only, use penalize() or reward() instead.void
impactScore(org.kie.api.runtime.rule.RuleContext kcontext, int weightMultiplier)
For internal use only, use penalize() or reward() instead.void
penalize(org.kie.api.runtime.rule.RuleContext kcontext)
Penalize a match by theConstraintWeight
negated.void
penalize(org.kie.api.runtime.rule.RuleContext kcontext, int weightMultiplier)
Penalize a match by theConstraintWeight
negated and multiplied with the weightMultiplier for all score levels.void
reward(org.kie.api.runtime.rule.RuleContext kcontext)
Reward a match by theConstraintWeight
.void
reward(org.kie.api.runtime.rule.RuleContext kcontext, int weightMultiplier)
Reward a match by theConstraintWeight
multiplied with the weightMultiplier for all score levels.-
Methods inherited from class org.optaplanner.core.api.score.holder.AbstractScoreHolder
extractJustificationList, getConstraintMatchTotalMap, getConstraintMatchTotals, getIndictmentMap, impactScore, impactScore, isConstraintMatchEnabled, registerConstraintMatch, setJustificationListConverter
-
-
-
-
Field Detail
-
matchExecutorByNumberMap
protected final Map<org.kie.api.definition.rule.Rule,BiConsumer<org.kie.api.runtime.rule.RuleContext,Integer>> matchExecutorByNumberMap
-
score
protected int score
-
-
Method Detail
-
getScore
public int getScore()
-
configureConstraintWeight
public void configureConstraintWeight(org.kie.api.definition.rule.Rule rule, SimpleScore constraintWeight)
Description copied from interface:ScoreHolder
Sets up aConstraintWeight
from theConstraintConfiguration
during initialization.- Specified by:
configureConstraintWeight
in interfaceScoreHolder<SimpleScore>
- Overrides:
configureConstraintWeight
in classAbstractScoreHolder<SimpleScore>
- Parameters:
rule
- never nullconstraintWeight
- never null, withScore.getInitScore()
equal to 0.
-
penalize
public void penalize(org.kie.api.runtime.rule.RuleContext kcontext)
Penalize a match by theConstraintWeight
negated.- Parameters:
kcontext
- never null, the magic variable in DRL
-
penalize
public void penalize(org.kie.api.runtime.rule.RuleContext kcontext, int weightMultiplier)
Penalize a match by theConstraintWeight
negated and multiplied with the weightMultiplier for all score levels.- Parameters:
kcontext
- never null, the magic variable in DRLweightMultiplier
- at least 0
-
reward
public void reward(org.kie.api.runtime.rule.RuleContext kcontext)
Reward a match by theConstraintWeight
.- Parameters:
kcontext
- never null, the magic variable in DRL
-
reward
public void reward(org.kie.api.runtime.rule.RuleContext kcontext, int weightMultiplier)
Reward a match by theConstraintWeight
multiplied with the weightMultiplier for all score levels.- Parameters:
kcontext
- never null, the magic variable in DRLweightMultiplier
- at least 0
-
impactScore
public void impactScore(org.kie.api.runtime.rule.RuleContext kcontext)
Description copied from class:AbstractScoreHolder
For internal use only, use penalize() or reward() instead.- Overrides:
impactScore
in classAbstractScoreHolder<SimpleScore>
- Parameters:
kcontext
- never null
-
impactScore
public void impactScore(org.kie.api.runtime.rule.RuleContext kcontext, int weightMultiplier)
Description copied from class:AbstractScoreHolder
For internal use only, use penalize() or reward() instead.- Overrides:
impactScore
in classAbstractScoreHolder<SimpleScore>
- Parameters:
kcontext
- never nullweightMultiplier
- any
-
addConstraintMatch
public void addConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext, int weight)
- Parameters:
kcontext
- never null, the magic variable in DRLweight
- higher is better, negative for a penalty, positive for a reward
-
extractScore
public SimpleScore extractScore(int initScore)
Description copied from interface:ScoreHolder
Extracts theScore
, calculated by theKieSession
forDroolsScoreDirector
.Should not be called directly, use
ScoreDirector.calculateScore()
instead.- Parameters:
initScore
-<= 0
, managed by OptaPlanner, needed as a parameter in theScore
's creation method, seeScore.getInitScore()
- Returns:
- never null, the
Score
of the workingPlanningSolution
-
-