Package org.optaplanner.core.impl.solver

Class DefaultSolverJob<Solution_,ProblemId_>

java.lang.Object

org.optaplanner.core.impl.solver.DefaultSolverJob<Solution_,ProblemId_>

Type Parameters:

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

ProblemId_ - the ID type of submitted problem, such as Long or UUID.

All Implemented Interfaces:

Callable<Solution_>, SolverJob<Solution_,ProblemId_>

public final class DefaultSolverJob<Solution_,ProblemId_>
extends Object
implements SolverJob<Solution_,ProblemId_>, Callable<Solution_>

Constructor Summary

Constructors

Constructor	Description
DefaultSolverJob(DefaultSolverManager<Solution_,ProblemId_> solverManager, Solver<Solution_> solver, ProblemId_ problemId, Function<? super ProblemId_,? extends Solution_> problemFinder, Consumer<? super Solution_> bestSolutionConsumer, Consumer<? super Solution_> finalBestSolutionConsumer, BiConsumer<? super ProblemId_,? super Throwable> exceptionHandler)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	addProblemChange(ProblemChange<Solution_> problemChange)	Schedules a ProblemChange to be processed by the underlying Solver and returns immediately.
Solution_	call()
Solution_	getFinalBestSolution()	Waits if necessary for the solver to complete and then returns the final best PlanningSolution.
ProblemId_	getProblemId()
SolverStatus	getSolverStatus()	Returns whether the Solver is scheduled to solve, actively solving or not.
Duration	getSolvingDuration()	Returns the Duration spent solving since the last start.
boolean	isTerminatedEarly()
void	setFinalBestSolutionFuture(Future<Solution_> finalBestSolutionFuture)
void	terminateEarly()	Terminates the solver or cancels the solver job if it hasn't (re)started yet.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultSolverJob

public DefaultSolverJob(DefaultSolverManager<Solution_,ProblemId_> solverManager,
 Solver<Solution_> solver,
 ProblemId_ problemId,
 Function<? super ProblemId_,? extends Solution_> problemFinder,
 Consumer<? super Solution_> bestSolutionConsumer,
 Consumer<? super Solution_> finalBestSolutionConsumer,
 BiConsumer<? super ProblemId_,? super Throwable> exceptionHandler)

Method Details

setFinalBestSolutionFuture

public void setFinalBestSolutionFuture(Future<Solution_> finalBestSolutionFuture)

getProblemId

public ProblemId_ getProblemId()

Specified by:

getProblemId in interface SolverJob<Solution_,ProblemId_>

Returns:

never null, a value given to SolverManager.solve(Object, Function, Consumer) or SolverManager.solveAndListen(Object, Function, Consumer)

getSolverStatus

public SolverStatus getSolverStatus()

Description copied from interface: SolverJob

Returns whether the Solver is scheduled to solve, actively solving or not.

Returns SolverStatus.NOT_SOLVING if the solver already terminated.

Specified by:

getSolverStatus in interface SolverJob<Solution_,ProblemId_>

Returns:

never null

call

public Solution_ call()

Specified by:

call in interface Callable<Solution_>

addProblemChange

public CompletableFuture<Void> addProblemChange(ProblemChange<Solution_> problemChange)

Description copied from interface: SolverJob

Schedules a ProblemChange to be processed by the underlying Solver and returns immediately.

To learn more about problem change semantics, please refer to the ProblemChange Javadoc.

Specified by:

addProblemChange in interface SolverJob<Solution_,ProblemId_>

Parameters:

problemChange - never null

Returns:

completes after the best solution containing this change has been consumed.

terminateEarly

public void terminateEarly()

Description copied from interface: SolverJob

Terminates the solver or cancels the solver job if it hasn't (re)started yet.

Does nothing if the solver already terminated.

Waits for the termination or cancellation to complete before returning. During termination, a bestSolutionConsumer could still be called. When the solver terminates, the finalBestSolutionConsumer is executed with the latest best solution. These consumers run on a consumer thread independently of the termination and may still run even after this method returns.

Specified by:

terminateEarly in interface SolverJob<Solution_,ProblemId_>

isTerminatedEarly

public boolean isTerminatedEarly()

Specified by:

isTerminatedEarly in interface SolverJob<Solution_,ProblemId_>

Returns:

true if SolverJob.terminateEarly() has been called since the underlying Solver started solving.

getFinalBestSolution

public Solution_ getFinalBestSolution()
                               throws InterruptedException,
ExecutionException

Description copied from interface: SolverJob

Waits if necessary for the solver to complete and then returns the final best PlanningSolution.

Specified by:

getFinalBestSolution in interface SolverJob<Solution_,ProblemId_>

Returns:

never null, but it could be the original uninitialized problem

Throws:

InterruptedException - if the current thread was interrupted while waiting

ExecutionException - if the computation threw an exception

getSolvingDuration

public Duration getSolvingDuration()

Description copied from interface: SolverJob

Returns the Duration spent solving since the last start. If it hasn't started it yet, it returns Duration.ZERO. If it hasn't ended yet, it returns the time between the last start and now. If it has ended already, it returns the time between the last start and the ending.

Specified by:

getSolvingDuration in interface SolverJob<Solution_,ProblemId_>

Returns:

the Duration spent solving since the last (re)start, at least 0