Package qupath.lib.plugins

Class AbstractTaskRunner

java.lang.Object

qupath.lib.plugins.AbstractTaskRunner

All Implemented Interfaces:

TaskRunner

Direct Known Subclasses:

CommandLineTaskRunner, TaskRunnerFX

public abstract class AbstractTaskRunner
extends Object
implements TaskRunner

Abstract PluginRunner to help with the creation of plugin runners for specific circumstances, e.g. running through a GUI, or from a command line only.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTaskRunner()	Constructor for a PluginRunner that uses the default number of threads, read from ThreadTools.getParallelism().
protected	AbstractTaskRunner(int numThreads)	Constructor for a PluginRunner that optionally uses a fixed number of threads.

Method Summary

Modifier and Type	Method	Description
protected void	awaitCompletion()	Await the completion of currently-running tasks, notifying any listener if necessary.
boolean	isCancelled()	Query if the plugin can be cancelled while running.
protected abstract SimpleProgressMonitor	makeProgressMonitor()	Create a progress monitor to update the user on what is happening.
protected void	postProcess(Collection<? extends PathTask> tasks)	Perform post-processing after a task has complete.
void	runTasks(Collection<? extends Runnable> tasks)	Pass a collection of parallelizable tasks to run.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractTaskRunner

protected AbstractTaskRunner()

Constructor for a PluginRunner that uses the default number of threads, read from ThreadTools.getParallelism().

AbstractTaskRunner

protected AbstractTaskRunner(int numThreads)

Constructor for a PluginRunner that optionally uses a fixed number of threads.

Parameters:

numThreads - the number of threads to use, or -1 to use the default number of threads defined by ThreadTools.getParallelism().

Method Details

makeProgressMonitor

protected abstract SimpleProgressMonitor makeProgressMonitor()

Create a progress monitor to update the user on what is happening.

Returns:

runTasks

public void runTasks(Collection<? extends Runnable> tasks)

Description copied from interface: TaskRunner

Pass a collection of parallelizable tasks to run.

Specified by:

runTasks in interface TaskRunner

Parameters:

tasks - the tasks to run. If these are instances of PathTask then an optional postprocessing may be applied after all tasks are complete.

awaitCompletion

protected void awaitCompletion()

Await the completion of currently-running tasks, notifying any listener if necessary.

postProcess

protected void postProcess(Collection<? extends PathTask> tasks)

Perform post-processing after a task has complete. This is necessary to call the taskComplete method (if the Runnable is an instance of PathTask), and also to update any progress monitor. Note: Subclasses may choose to override this method so that it is called on a particular thread (e.g. with Platform.runLater() or SwingUtilities.invokeLater).

Parameters:

tasks -

isCancelled

public boolean isCancelled()

Description copied from interface: TaskRunner

Query if the plugin can be cancelled while running. Plugins are expected to check this flag before time-consuming operations.

Specified by:

isCancelled in interface TaskRunner

Returns: