Package org.optaplanner.core.api.score.constraint

Interface Indictment<Score_ extends Score<Score_>>

Type Parameters:

Score_ - the actual score type

All Known Implementing Classes:

DefaultIndictment

public interface Indictment<Score_ extends Score<Score_>>

Explains the Score of a PlanningSolution, from the opposite side than ConstraintMatchTotal. Retrievable from ScoreExplanation.getIndictmentMap().

Method Summary

Modifier and Type	Method	Description
default int	getConstraintMatchCount()
Set<ConstraintMatch<Score_>>	getConstraintMatchSet()
<IndictedObject_> IndictedObject_	getIndictedObject()	The object that was involved in causing the constraints to match.
default Object	getJustification()	Deprecated, for removal: This API element is subject to removal in a future version. Prefer getIndictedObject().
List<ConstraintJustification>	getJustificationList()	Retrieve ConstraintJustification instances associated with ConstraintMatches in getConstraintMatchSet().
default <ConstraintJustification_ extends ConstraintJustification> List<ConstraintJustification_>	getJustificationList(Class<ConstraintJustification_> justificationClass)	Retrieve ConstraintJustification instances associated with ConstraintMatches in getConstraintMatchSet(), which are of (or extend) a given constraint justification implementation.
Score_	getScore()	Sum of the getConstraintMatchSet()'s ConstraintMatch.getScore().

Method Details

getJustification

@Deprecated(forRemoval=true)
default Object getJustification()

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer getIndictedObject().

As defined by getIndictedObject().

This is a poorly named legacy method, which does not in fact return a justification, but an indicted object. Each indictment may have multiple justifications, and they are accessed by getJustificationList().

Returns:

never null

getIndictedObject

<IndictedObject_> IndictedObject_ getIndictedObject()

The object that was involved in causing the constraints to match. It is part of ConstraintMatch.getIndictedObjectList() of every ConstraintMatch returned by getConstraintMatchSet().

Type Parameters:

IndictedObject_ - Shorthand so that the user does not need to cast in user code.

Returns:

never null

getConstraintMatchSet

Set<ConstraintMatch<Score_>> getConstraintMatchSet()

Returns:

never null

getConstraintMatchCount

default int getConstraintMatchCount()

Returns:

>= 0

getJustificationList

List<ConstraintJustification> getJustificationList()

Retrieve ConstraintJustification instances associated with ConstraintMatches in getConstraintMatchSet(). This is equivalent to retrieving getConstraintMatchSet() and collecting all ConstraintMatch.getJustification() objects into a list.

Returns:

never null, guaranteed to contain unique instances

getJustificationList

default <ConstraintJustification_ extends ConstraintJustification>
List<ConstraintJustification_> getJustificationList(Class<ConstraintJustification_> justificationClass)

Retrieve ConstraintJustification instances associated with ConstraintMatches in getConstraintMatchSet(), which are of (or extend) a given constraint justification implementation. This is equivalent to retrieving getConstraintMatchSet() and collecting all matching ConstraintMatch.getJustification() objects into a list.

Returns:

never null, guaranteed to contain unique instances

getScore

Score_ getScore()

Sum of the getConstraintMatchSet()'s ConstraintMatch.getScore().

Returns:

never null