org.optaplanner.core.impl.score.definition

Interface ScoreDefinition<S extends Score>

All Known Subinterfaces:

FeasibilityScoreDefinition<S>

All Known Implementing Classes:

AbstractBendableScoreDefinition, AbstractFeasibilityScoreDefinition, AbstractScoreDefinition, BendableBigDecimalScoreDefinition, BendableLongScoreDefinition, BendableScoreDefinition, HardMediumSoftLongScoreDefinition, HardMediumSoftScoreDefinition, HardSoftBigDecimalScoreDefinition, HardSoftDoubleScoreDefinition, HardSoftLongScoreDefinition, HardSoftScoreDefinition, SimpleBigDecimalScoreDefinition, SimpleDoubleScoreDefinition, SimpleLongScoreDefinition, SimpleScoreDefinition

public interface ScoreDefinition<S extends Score>

A ScoreDefinition knows how to compare Scores and what the perfect maximum/minimum Score is.

See Also:

AbstractScoreDefinition, HardSoftScoreDefinition

Method Summary

Modifier and Type	Method and Description
S	buildOptimisticBound(InitializingScoreTrend initializingScoreTrend, S score) Builds a Score which is equal or better than any other Score with more variables initialized (while the already variables don't change).
S	buildPessimisticBound(InitializingScoreTrend initializingScoreTrend, S score) Builds a Score which is equal or worse than any other Score with more variables initialized (while the already variables don't change).
ScoreHolder	buildScoreHolder(boolean constraintMatchEnabled) Used by DroolsScoreDirector.
String	formatScore(S score) Returns a String representation of the Score.
S	fromLevelNumbers(Number[] levelNumbers) The opposite of Score.toLevelNumbers().
String[]	getLevelLabels() Returns a label for each score level.
int	getLevelsSize() Returns the length of Score.toLevelNumbers() for every Score of this definition.
Class<S>	getScoreClass() Returns the Class of the actual Score implementation.
S	parseScore(String scoreString) Parses the String and returns a Score.

Method Detail

getLevelsSize

int getLevelsSize()

Returns the length of Score.toLevelNumbers() for every Score of this definition. For example: returns 2 on HardSoftScoreDefinition.

Returns:

at least 1

getLevelLabels

String[] getLevelLabels()

Returns a label for each score level. Each label includes the suffix "score" and must start in lower case. For example: returns {"hard score", "soft score "} on HardSoftScoreDefinition.

Returns:

never null, array with length of getLevelsSize(), each element is never null

getScoreClass

Class<S> getScoreClass()

Returns the Class of the actual Score implementation. For example: returns HardSoftScore.class on HardSoftScoreDefinition.

Returns:

never null

formatScore

String formatScore(S score)

Returns a String representation of the Score.

Parameters:

score - never null

Returns:

never null

See Also:

parseScore(String)

parseScore

S parseScore(String scoreString)

Parses the String and returns a Score.

Parameters:

scoreString - never null

Returns:

never null

See Also:

formatScore(Score)

fromLevelNumbers

S fromLevelNumbers(Number[] levelNumbers)

The opposite of Score.toLevelNumbers().

Parameters:

levelNumbers - never null

Returns:

never null

buildScoreHolder

ScoreHolder buildScoreHolder(boolean constraintMatchEnabled)

Used by DroolsScoreDirector.

Parameters:

constraintMatchEnabled - true if ScoreHolder.isConstraintMatchEnabled() should be true

Returns:

never null

buildOptimisticBound

S buildOptimisticBound(InitializingScoreTrend initializingScoreTrend,
                       S score)

Builds a Score which is equal or better than any other Score with more variables initialized (while the already variables don't change).

Parameters:

initializingScoreTrend - never null, with InitializingScoreTrend.getLevelsSize() equal to getLevelsSize().

score - never null

Returns:

never null

buildPessimisticBound

S buildPessimisticBound(InitializingScoreTrend initializingScoreTrend,
                        S score)

Builds a Score which is equal or worse than any other Score with more variables initialized (while the already variables don't change).

Parameters:

initializingScoreTrend - never null, with InitializingScoreTrend.getLevelsSize() equal to getLevelsSize().

score - never null

Returns:

never null