org.optaplanner.core.impl.domain.solution

Class AbstractSolution<S extends Score>

java.lang.Object

org.optaplanner.core.impl.domain.solution.AbstractSolution<S>

Type Parameters:

S - the Score type used by this use case

All Implemented Interfaces:

Serializable, Solution<S>

public abstract class AbstractSolution<S extends Score>
extends Object
implements Solution<S>, Serializable

Currently only used by OptaPlanner Workbench. TODO Should we promote using this class in the examples and docs too? We can never enforce it, as the user might want to use a different superclass.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected S	score

Constructor Summary

Constructors

Constructor and Description
AbstractSolution()

Method Summary

Methods

Modifier and Type	Method and Description
Collection<?>	getProblemFacts() Called by the DroolsScoreDirector when the Solution needs to be inserted into an empty KieSession.
S	getScore() Returns the Score of this Solution.
void	setScore(S score) Called by the Solver when the Score of this Solution has been calculated.

Methods inherited from class java.lang.Object

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

Field Detail

score

protected S extends Score score

Constructor Detail

AbstractSolution

public AbstractSolution()

Method Detail

getScore

public S getScore()

Description copied from interface: Solution

Returns the Score of this Solution.

Specified by:

getScore in interface Solution<S extends Score>

Returns:

null if the Solution is uninitialized or the last calculated Score is dirty the new Score has not yet been recalculated

setScore

public void setScore(S score)

Description copied from interface: Solution

Called by the Solver when the Score of this Solution has been calculated.

Specified by:

setScore in interface Solution<S extends Score>

Parameters:

score - null if the Solution has changed and the new Score has not yet been recalculated

getProblemFacts

public Collection<?> getProblemFacts()

Description copied from interface: Solution

Called by the DroolsScoreDirector when the Solution needs to be inserted into an empty KieSession. These facts can be used by the score rules. They don't change during planning (except through ProblemFactChange events).

Do not include the planning entities as problem facts: they are automatically inserted into the KieSession if and only if they are initialized. When they are initialized later, they are also automatically inserted.

Specified by:

getProblemFacts in interface Solution<S extends Score>

Returns:

never null (although an empty collection is allowed), all the facts of this solution except for the planning entities