org.hkijena.jipipe.api

Interface JIPipeRunnable

All Superinterfaces:

Runnable

All Known Implementing Classes:

ActivateAndApplyUpdateSiteRun, ActivateUpdateSiteRun, AllCacheToNonVirtualRun, AllCacheToVirtualRun, ApplyRun, BasicMinicondaEnvPythonInstaller, BasicPortableEnvPythonInstaller, CacheToNonVirtualRun, CacheToVirtualRun, CellposeEasyInstaller, CleanBackupsRun, DeactivateAndApplyUpdateSiteRun, DownloadOfflineManualRun, EasyInstallExternalEnvironmentInstaller, ExternalEnvironmentInstaller, ExtractTemplateZipFileRun, ImagePlusResultImportRun, ImageViewerPanelRawImageExporterRun, ImageViewerStackExporterRun, ImageViewerVideoExporterRun, JIPipeDataDisplayWrapperImportOperation.ImportDataRun, JIPipeDataTableToFilesByMetadataExporterRun, JIPipeDataTableToOutputExporterRun, JIPipeDataTableToZIPExporterRun, JIPipeGraphRunner, JIPipeImportCachedSlotOutputRun, JIPipeProjectRun, JIPipePythonAdapterLibraryEnvironmentInstaller, JIPipeResultCopyFilesByMetadataExporterRun, LoadResultDirectoryIntoCacheRun, LoadResultZipIntoCacheRun, MinicondaCellposeEnvInstaller, MinicondaCellposeGPUEnvInstaller, MinicondaEnvPythonInstaller, NodeTemplateDownloaderRun, OMEImageResultImportRun, OmniposeEasyInstaller, PortableCellposeEnvInstaller, PortableCellposeGPUEnvInstaller, PortableEnvPythonInstaller, ProjectTemplateDownloaderRun, PythonEasyInstaller, PythonPackageLibraryEnvironmentInstaller, QuickRun, REasyInstaller, RefreshRepositoryRun, RenderPipelineRun, REnvInstaller, SaveProjectAndCacheToDirectoryRun, SaveProjectAndCacheToZipRun, SelectCondaEnvPythonInstaller, SelectSystemPythonInstaller, SelectVirtualEnvPythonInstaller

public interface JIPipeRunnable
extends Runnable

Runnable that can be scheduled, canceled, and reports progress

Method Summary

Modifier and Type	Method and Description
JIPipeProgressInfo	getProgressInfo() The info object that allows communication with the run
String	getTaskLabel() A name for the runnable
default void	onFinished(Consumer<RunWorkerFinishedEvent> function) Registers an event subscriber into JIPipeRunnerQueue that listens for when this run finishes
default void	onInterrupted(Consumer<RunWorkerInterruptedEvent> function) Registers an event subscriber into JIPipeRunnerQueue that listens for when this run is interrupted
default void	onProgress(Consumer<RunWorkerProgressEvent> function) Registers an event subscriber into JIPipeRunnerQueue that listens for when this run is progressing
default void	onStarted(Consumer<RunWorkerStartedEvent> function) Registers an event subscriber into JIPipeRunnerQueue that listens for when this run is started
void	setProgressInfo(JIPipeProgressInfo progressInfo) Sets the progress info of this runnable

Methods inherited from interface java.lang.Runnable

run

Method Detail

getProgressInfo

JIPipeProgressInfo getProgressInfo()

The info object that allows communication with the run

Returns:

the info object

setProgressInfo

void setProgressInfo(JIPipeProgressInfo progressInfo)

Sets the progress info of this runnable

Parameters:

progressInfo - the info object

getTaskLabel

String getTaskLabel()

A name for the runnable

Returns:

the name

onFinished

default void onFinished(Consumer<RunWorkerFinishedEvent> function)

Registers an event subscriber into JIPipeRunnerQueue that listens for when this run finishes

Parameters:

function - the method to execute when the run finishes (successfully or not successfully)

onInterrupted

default void onInterrupted(Consumer<RunWorkerInterruptedEvent> function)

Registers an event subscriber into JIPipeRunnerQueue that listens for when this run is interrupted

Parameters:

function - the method to execute when the run is interrupted (due to error or user cancel)

onStarted

default void onStarted(Consumer<RunWorkerStartedEvent> function)

Registers an event subscriber into JIPipeRunnerQueue that listens for when this run is started

Parameters:

function - the method to execute when the run starts

onProgress

default void onProgress(Consumer<RunWorkerProgressEvent> function)

Registers an event subscriber into JIPipeRunnerQueue that listens for when this run is progressing

Parameters:

function - the method to execute when the run progresses