Package org.optaplanner.constraint.drl

Class DrlScoreDirector<Solution_,Score_ extends Score<Score_>>

java.lang.Object

org.optaplanner.core.impl.score.director.AbstractScoreDirector<Solution_,Score_,DrlScoreDirectorFactory<Solution_,Score_>>

org.optaplanner.constraint.drl.DrlScoreDirector<Solution_,Score_>

Type Parameters:

Solution_ - the solution type, the class with the PlanningSolution annotation

Score_ - the score type to go with the solution

All Implemented Interfaces:

AutoCloseable, Cloneable, ScoreDirector<Solution_>, InnerScoreDirector<Solution_,Score_>

public class DrlScoreDirector<Solution_,Score_ extends Score<Score_>>
extends AbstractScoreDirector<Solution_,Score_,DrlScoreDirectorFactory<Solution_,Score_>>

Drools implementation of ScoreDirector, which directs the Rule Engine to calculate the Score of the working solution.

See Also:

• ScoreDirector

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GLOBAL_SCORE_HOLDER_KEY
protected org.kie.api.runtime.KieSession	kieSession
protected AbstractScoreHolder<Score_>	scoreHolder

Fields inherited from class org.optaplanner.core.impl.score.director.AbstractScoreDirector

allChangesWillBeUndoneBeforeStepEnds, calculationCount, constraintMatchEnabledPreference, logger, lookUpEnabled, lookUpManager, scoreDirectorFactory, variableListenerSupport, workingEntityListRevision, workingInitScore, workingSolution

Constructor Summary

Constructors

Constructor	Description
DrlScoreDirector(DrlScoreDirectorFactory<Solution_,Score_> scoreDirectorFactory, boolean lookUpEnabled, boolean constraintMatchEnabledPreference)

Method Summary

Modifier and Type	Method	Description
void	afterEntityAdded(EntityDescriptor<Solution_> entityDescriptor, Object entity)
void	afterEntityRemoved(EntityDescriptor<Solution_> entityDescriptor, Object entity)
void	afterListVariableChanged(ListVariableDescriptor<Solution_> variableDescriptor, Object entity, int fromIndex, int toIndex)	Notify the score director after a list variable changes.
void	afterProblemFactAdded(Object problemFact)
void	afterProblemFactRemoved(Object problemFact)
void	afterProblemPropertyChanged(Object problemFactOrEntity)
void	afterVariableChanged(VariableDescriptor<Solution_> variableDescriptor, Object entity)
Score_	calculateScore()	Calculates the Score and updates the working solution accordingly.
void	close()	Needs to be called after use because some implementations need to clean up their resources.
Map<String,ConstraintMatchTotal<Score_>>	getConstraintMatchTotalMap()	Explains the Score of InnerScoreDirector.calculateScore() by splitting it up per Constraint.
Map<Object,Indictment<Score_>>	getIndictmentMap()	Explains the impact of each planning entity or problem fact on the Score.
org.kie.api.runtime.KieSession	getKieSession()
boolean	isConstraintMatchEnabled()
boolean	requiresFlushing()	Some score directors (such as the Drools-based) keep a set of changes that they only apply when InnerScoreDirector.calculateScore() is called.
void	setWorkingSolution(Solution_ workingSolution)	Note: resetting the working solution does NOT substitute the calls to before/after methods of the ProblemChangeDirector during problem changes, as these calls are propagated to variable listeners, which update shadow variables in the working solution to keep it consistent.

Methods inherited from class org.optaplanner.core.impl.score.director.AbstractScoreDirector

afterEntityAdded, afterEntityRemoved, afterListVariableChanged, afterListVariableElementAssigned, afterListVariableElementAssigned, afterListVariableElementUnassigned, afterListVariableElementUnassigned, afterVariableChanged, assertExpectedUndoMoveScore, assertExpectedWorkingScore, assertNonNullPlanningIds, assertPredictedScoreFromScratch, assertShadowVariablesAreNotStale, assertWorkingScoreFromScratch, beforeEntityAdded, beforeEntityAdded, beforeEntityRemoved, beforeEntityRemoved, beforeListVariableChanged, beforeListVariableChanged, beforeListVariableElementAssigned, beforeListVariableElementAssigned, beforeListVariableElementUnassigned, beforeListVariableElementUnassigned, beforeProblemFactAdded, beforeProblemFactRemoved, beforeProblemPropertyChanged, beforeVariableChanged, beforeVariableChanged, buildScoreCorruptionAnalysis, buildShadowVariableAnalysis, changeVariableFacade, clone, cloneSolution, cloneWorkingSolution, createChildThreadScoreDirector, doAndProcessMove, doAndProcessMove, forceTriggerVariableListeners, getCalculationCount, getScoreDefinition, getScoreDirectorFactory, getSolutionDescriptor, getSupplyManager, getWorkingEntityListRevision, getWorkingSolution, incrementCalculationCount, isConstraintConfiguration, isWorkingEntityListDirty, lookUpWorkingObject, lookUpWorkingObjectOrReturnNull, overwriteConstraintMatchEnabledPreference, resetCalculationCount, setAllChangesWillBeUndoneBeforeStepEnds, setCalculatedScore, setWorkingEntityListDirty, toString, triggerVariableListeners

Methods inherited from class java.lang.Object

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

Field Details

GLOBAL_SCORE_HOLDER_KEY

public static final String GLOBAL_SCORE_HOLDER_KEY

See Also:

• Constant Field Values

kieSession

protected org.kie.api.runtime.KieSession kieSession

scoreHolder

protected AbstractScoreHolder<Score_ extends Score<Score_>> scoreHolder

Constructor Details

DrlScoreDirector

public DrlScoreDirector(DrlScoreDirectorFactory<Solution_,Score_> scoreDirectorFactory,
 boolean lookUpEnabled,
 boolean constraintMatchEnabledPreference)

Method Details

getKieSession

public org.kie.api.runtime.KieSession getKieSession()

setWorkingSolution

public void setWorkingSolution(Solution_ workingSolution)

Description copied from class: AbstractScoreDirector

Note: resetting the working solution does NOT substitute the calls to before/after methods of the ProblemChangeDirector during problem changes, as these calls are propagated to variable listeners, which update shadow variables in the working solution to keep it consistent.

Specified by:

setWorkingSolution in interface InnerScoreDirector<Solution_,Score_ extends Score<Score_>>

Overrides:

setWorkingSolution in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,DrlScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

Parameters:

workingSolution - never null

calculateScore

public Score_ calculateScore()

Description copied from interface: InnerScoreDirector

Calculates the Score and updates the working solution accordingly.

Returns:

never null, the Score of the working solution

isConstraintMatchEnabled

public boolean isConstraintMatchEnabled()

Returns:

true if InnerScoreDirector.getConstraintMatchTotalMap() and InnerScoreDirector.getIndictmentMap() can be called

getConstraintMatchTotalMap

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

Description copied from interface: InnerScoreDirector

Explains the Score of InnerScoreDirector.calculateScore() by splitting it up per Constraint.

The sum of ConstraintMatchTotal.getScore() equals InnerScoreDirector.calculateScore().

Call InnerScoreDirector.calculateScore() before calling this method, unless that method has already been called since the last PlanningVariable changes.

Returns:

never null, the key is the constraintId (to create one, use ConstraintMatchTotal.composeConstraintId(String, String)).

See Also:

• InnerScoreDirector.getIndictmentMap()

getIndictmentMap

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

Description copied from interface: InnerScoreDirector

Explains the impact of each planning entity or problem fact on the Score. An Indictment is basically the inverse of a ConstraintMatchTotal: it is a Score total for each constraint justification.

The sum of ConstraintMatchTotal.getScore() differs from InnerScoreDirector.calculateScore() because each ConstraintMatch.getScore() is counted for each constraint justification.

Call InnerScoreDirector.calculateScore() before calling this method, unless that method has already been called since the last PlanningVariable changes.

Returns:

never null, the key is a problem fact or a planning entity

See Also:

• InnerScoreDirector.getConstraintMatchTotalMap()

requiresFlushing

public boolean requiresFlushing()

Description copied from interface: InnerScoreDirector

Some score directors (such as the Drools-based) keep a set of changes that they only apply when InnerScoreDirector.calculateScore() is called. Until that happens, this set accumulates and could possibly act as a memory leak.

Returns:

true if the score director can potentially cause a memory leak due to unflushed changes.

close

public void close()

Description copied from interface: InnerScoreDirector

Needs to be called after use because some implementations need to clean up their resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface InnerScoreDirector<Solution_,Score_ extends Score<Score_>>

Overrides:

close in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,DrlScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

afterEntityAdded

public void afterEntityAdded(EntityDescriptor<Solution_> entityDescriptor,
 Object entity)

Overrides:

afterEntityAdded in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,DrlScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

afterVariableChanged

public void afterVariableChanged(VariableDescriptor<Solution_> variableDescriptor,
 Object entity)

Specified by:

afterVariableChanged in interface InnerScoreDirector<Solution_,Score_ extends Score<Score_>>

Overrides:

afterVariableChanged in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,DrlScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

afterListVariableChanged

public void afterListVariableChanged(ListVariableDescriptor<Solution_> variableDescriptor,
 Object entity,
 int fromIndex,
 int toIndex)

Description copied from interface: InnerScoreDirector

Notify the score director after a list variable changes.

The list variable change includes:

• Changing position (index) of one or more elements.
• Removing one or more elements from the list variable.
• Adding one or more elements to the list variable.
• Any mix of the above.

For the sake of variable listeners' efficiency, the change notification requires an index range that contains elements affected by the change. The range starts at fromIndex (inclusive) and ends at toIndex (exclusive).

The range has to comply with the following contract:

1. fromIndex must be greater than or equal to 0; toIndex must be less than or equal to the list variable size.
2. toIndex must be greater than or equal to fromIndex.
3. The range must contain all elements that have changed.
4. The range is allowed to contain elements that have not changed.
5. The range may be empty (fromIndex equals toIndex) if none of the existing list variable elements have changed.

InnerScoreDirector.afterListVariableElementUnassigned(ListVariableDescriptor, Object) must be called for each element that was unassigned (removed from a list variable of one entity without being added to a list variable of another entity).

Specified by:

afterListVariableChanged in interface InnerScoreDirector<Solution_,Score_ extends Score<Score_>>

Overrides:

afterListVariableChanged in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,DrlScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

Parameters:

variableDescriptor - descriptor of the list variable being changed

entity - the entity owning the list variable being changed

fromIndex - low endpoint (inclusive) of the changed range

toIndex - high endpoint (exclusive) of the changed range

afterEntityRemoved

public void afterEntityRemoved(EntityDescriptor<Solution_> entityDescriptor,
 Object entity)

Overrides:

afterEntityRemoved in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,DrlScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

afterProblemFactAdded

public void afterProblemFactAdded(Object problemFact)

Specified by:

afterProblemFactAdded in interface ScoreDirector<Solution_>

Overrides:

afterProblemFactAdded in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,DrlScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

afterProblemPropertyChanged

public void afterProblemPropertyChanged(Object problemFactOrEntity)

Specified by:

afterProblemPropertyChanged in interface ScoreDirector<Solution_>

Overrides:

afterProblemPropertyChanged in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,DrlScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>

afterProblemFactRemoved

public void afterProblemFactRemoved(Object problemFact)

Specified by:

afterProblemFactRemoved in interface ScoreDirector<Solution_>

Overrides:

afterProblemFactRemoved in class AbstractScoreDirector<Solution_,Score_ extends Score<Score_>,DrlScoreDirectorFactory<Solution_,Score_ extends Score<Score_>>>