org.optaplanner.core.impl.score.buildin.hardsoft
Class HardSoftScoreDefinition

java.lang.Object
  org.optaplanner.core.impl.score.definition.AbstractScoreDefinition<S>
      org.optaplanner.core.impl.score.definition.AbstractFeasibilityScoreDefinition<HardSoftScore>
          org.optaplanner.core.impl.score.buildin.hardsoft.HardSoftScoreDefinition

All Implemented Interfaces:

Serializable, FeasibilityScoreDefinition<HardSoftScore>, ScoreDefinition<HardSoftScore>

public class HardSoftScoreDefinition
extends AbstractFeasibilityScoreDefinition<HardSoftScore>

See Also:

Serialized Form

Constructor Summary

HardSoftScoreDefinition()

Method Summary

HardSoftScore	buildOptimisticBound(InitializingScoreTrend initializingScoreTrend, HardSoftScore score) Builds a Score which is equal or better than any other Score with more variables initialized (while the already variables don't change).
HardSoftScore	buildPessimisticBound(InitializingScoreTrend initializingScoreTrend, HardSoftScore score) Builds a Score which is equal or worse than any other Score with more variables initialized (while the already variables don't change).
HardSoftScoreHolder	buildScoreHolder(boolean constraintMatchEnabled) Used by DroolsScoreDirector.
int	getFeasibleLevelsSize() Returns the number of levels of Score.toLevelNumbers().
int	getLevelsSize() Returns the length of Score.toLevelNumbers() for every Score of this definition.
Class<HardSoftScore>	getScoreClass() Returns the Class of the actual Score implementation
HardSoftScore	parseScore(String scoreString) Parses the String and returns a Score.

Methods inherited from class org.optaplanner.core.impl.score.definition.AbstractScoreDefinition

formatScore, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.optaplanner.core.impl.score.definition.ScoreDefinition

formatScore

Constructor Detail

HardSoftScoreDefinition

public HardSoftScoreDefinition()

Method Detail

getLevelsSize

public int getLevelsSize()

Description copied from interface: ScoreDefinition

Returns the length of Score.toLevelNumbers() for every Score of this definition.

Returns:

at least 1

getFeasibleLevelsSize

public int getFeasibleLevelsSize()

Description copied from interface: FeasibilityScoreDefinition

Returns the number of levels of Score.toLevelNumbers(). that are used to determine FeasibilityScore.isFeasible().

Returns:

at least 0, at most ScoreDefinition.getLevelsSize()

getScoreClass

public Class<HardSoftScore> getScoreClass()

Description copied from interface: ScoreDefinition

Returns the Class of the actual Score implementation

Returns:

never null

parseScore

public HardSoftScore parseScore(String scoreString)

Description copied from interface: ScoreDefinition

Parses the String and returns a Score.

Parameters:

scoreString - never null

Returns:

never null

See Also:

ScoreDefinition.formatScore(Score)

buildScoreHolder

public HardSoftScoreHolder buildScoreHolder(boolean constraintMatchEnabled)

Description copied from interface: ScoreDefinition

Used by DroolsScoreDirector.

Parameters:

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

Returns:

never null

buildOptimisticBound

public HardSoftScore buildOptimisticBound(InitializingScoreTrend initializingScoreTrend,
                                          HardSoftScore score)

Description copied from interface: ScoreDefinition

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 ScoreDefinition.getLevelsSize().

score - never null

Returns:

never null

buildPessimisticBound

public HardSoftScore buildPessimisticBound(InitializingScoreTrend initializingScoreTrend,
                                           HardSoftScore score)

Description copied from interface: ScoreDefinition

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 ScoreDefinition.getLevelsSize().

score - never null

Returns:

never null