Package org.optaplanner.core.impl.score.holder

Class AbstractScoreHolder<Score_ extends Score<Score_>>

java.lang.Object

org.optaplanner.core.impl.score.holder.AbstractScoreHolder<Score_>

Type Parameters:

Score_ - the Score type

All Implemented Interfaces:

ScoreHolder<Score_>

Direct Known Subclasses:

BendableBigDecimalScoreHolderImpl, BendableLongScoreHolderImpl, BendableScoreHolderImpl, HardMediumSoftBigDecimalScoreHolderImpl, HardMediumSoftLongScoreHolderImpl, HardMediumSoftScoreHolderImpl, HardSoftBigDecimalScoreHolderImpl, HardSoftLongScoreHolderImpl, HardSoftScoreHolderImpl, SimpleBigDecimalScoreHolderImpl, SimpleLongScoreHolderImpl, SimpleScoreHolderImpl

public abstract class AbstractScoreHolder<Score_ extends Score<Score_>>
extends Object
implements ScoreHolder<Score_>

Abstract superclass for ScoreHolder. Instances of this class are used only in DRL.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractScoreHolder.BigDecimalMatchExecutor
class	AbstractScoreHolder.ConstraintActivationUnMatchListener
protected static interface	AbstractScoreHolder.IntMatchExecutor
protected static interface	AbstractScoreHolder.LongMatchExecutor
protected static interface	AbstractScoreHolder.ScoreMatchExecutor<Score_ extends AbstractScore<Score_>>	Unlike AbstractScoreHolder.IntMatchExecutor and its counterparts, this is not being used on CS-D code paths.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	constraintMatchEnabled
protected Map<String,ConstraintMatchTotal<Score_>>	constraintMatchTotalMap
protected Map<Object,Indictment<Score_>>	indictmentMap
protected Score_	zeroScore

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractScoreHolder(boolean constraintMatchEnabled, Score_ zeroScore)

Method Summary

Modifier and Type	Method	Description
void	configureConstraintWeight(org.kie.api.definition.rule.Rule rule, Score_ constraintWeight)
protected List<Object>	extractJustificationList(org.kie.api.runtime.rule.RuleContext kcontext)
abstract Score_	extractScore(int initScore)
Map<String,ConstraintMatchTotal<Score_>>	getConstraintMatchTotalMap()
Map<Object,Indictment<Score_>>	getIndictmentMap()
void	impactScore(org.kie.api.runtime.rule.RuleContext kcontext)	For internal use only, use penalize() or reward() instead.
abstract void	impactScore(org.kie.api.runtime.rule.RuleContext kcontext, int weightMultiplier)	For internal use only, use penalize() or reward() instead.
abstract void	impactScore(org.kie.api.runtime.rule.RuleContext kcontext, long weightMultiplier)	For internal use only, use penalize() or reward() instead.
abstract void	impactScore(org.kie.api.runtime.rule.RuleContext kcontext, BigDecimal weightMultiplier)	For internal use only, use penalize() or reward() instead.
boolean	isConstraintMatchEnabled()
protected void	registerConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext, Runnable constraintUndoListener, Supplier<Score_> scoreSupplier)	Requires a custom rule event listener to be added as event listener on KieSession, otherwise the score changes caused by the constraint matches would not be undone.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.optaplanner.core.api.score.holder.ScoreHolder

penalize, reward

Field Detail

constraintMatchEnabled

protected final boolean constraintMatchEnabled

constraintMatchTotalMap

protected final Map<String,ConstraintMatchTotal<Score_ extends Score<Score_>>> constraintMatchTotalMap

indictmentMap

protected final Map<Object,Indictment<Score_ extends Score<Score_>>> indictmentMap

zeroScore

protected final Score_ extends Score<Score_> zeroScore

Constructor Detail

AbstractScoreHolder

protected AbstractScoreHolder(boolean constraintMatchEnabled,
                              Score_ zeroScore)

Method Detail

isConstraintMatchEnabled

public boolean isConstraintMatchEnabled()

getConstraintMatchTotalMap

public Map<String,ConstraintMatchTotal<Score_>> getConstraintMatchTotalMap()

getIndictmentMap

public Map<Object,Indictment<Score_>> getIndictmentMap()

configureConstraintWeight

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

registerConstraintMatch

protected void registerConstraintMatch(org.kie.api.runtime.rule.RuleContext kcontext,
                                       Runnable constraintUndoListener,
                                       Supplier<Score_> scoreSupplier)

Requires a custom rule event listener to be added as event listener on KieSession, otherwise the score changes caused by the constraint matches would not be undone. See DroolsScoreDirector.setWorkingSolution(Object) for an example.

Parameters:

kcontext - The rule for which to register the match.

constraintUndoListener - The operation to run to undo the match.

scoreSupplier - The score change to be undone when constraint justification enabled.

impactScore

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

For internal use only, use penalize() or reward() instead.

Parameters:

kcontext - never null

impactScore

public abstract void impactScore(org.kie.api.runtime.rule.RuleContext kcontext,
                                 int weightMultiplier)

For internal use only, use penalize() or reward() instead.

Parameters:

kcontext - never null

weightMultiplier - any

impactScore

public abstract void impactScore(org.kie.api.runtime.rule.RuleContext kcontext,
                                 long weightMultiplier)

For internal use only, use penalize() or reward() instead.

Parameters:

kcontext - never null

weightMultiplier - any

impactScore

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

For internal use only, use penalize() or reward() instead.

Parameters:

kcontext - never null

weightMultiplier - any

extractScore

public abstract Score_ extractScore(int initScore)

extractJustificationList

protected List<Object> extractJustificationList(org.kie.api.runtime.rule.RuleContext kcontext)