org.hkijena.jipipe.api.run

Class JIPipeRunnableQueue

java.lang.Object

org.hkijena.jipipe.api.run.JIPipeRunnableQueue

All Implemented Interfaces:

JIPipeRunnable.FinishedEventListener, JIPipeRunnable.InterruptedEventListener, JIPipeRunnable.ProgressEventListener

public class JIPipeRunnableQueue
extends Object
implements JIPipeRunnable.FinishedEventListener, JIPipeRunnable.InterruptedEventListener, JIPipeRunnable.ProgressEventListener

Local queue for JIPipeRunnable

Constructor Summary

Constructors

Constructor and Description
JIPipeRunnableQueue(String name)

Method Summary

Modifier and Type	Method and Description
void	cancel(JIPipeRunnable run) Cancels a runnable
void	cancelAll()
void	cancelIf(Predicate<JIPipeRunnable> predicate)
void	clearQueue() Removes all enqueued (but not running tasks)
JIPipeRunnableWorker	enqueue(JIPipeRunnable run) Schedules a new runnable
JIPipeRunnableWorker	findWorkerOf(JIPipeRunnable run) Finds the worker associated to the JIPipeRunnable
JIPipeRunnable	getCurrentRun()
JIPipeRunnableWorker	getCurrentRunWorker()
JIPipeRunnable.EnqueuedEventEmitter	getEnqueuedEventEmitter()
JIPipeRunnable.FinishedEventEmitter	getFinishedEventEmitter()
static JIPipeRunnableQueue	getInstance()
JIPipeRunnable.InterruptedEventEmitter	getInterruptedEventEmitter()
String	getName()
JIPipeRunnable.ProgressEventEmitter	getProgressEventEmitter()
Queue<JIPipeRunnableWorker>	getQueue()
JIPipeRunnable.StartedEventEmitter	getStartedEventEmitter()
boolean	isEmpty()
boolean	isRunningOrEnqueued(JIPipeRunnable runnable) Determines if a runnable is enqueued or running
boolean	isSilent()
void	onRunnableFinished(JIPipeRunnable.FinishedEvent event) Triggered when a worker is finished
void	onRunnableInterrupted(JIPipeRunnable.InterruptedEvent event) Triggered when a worker is interrupted
void	onRunnableProgress(JIPipeRunnable.ProgressEvent event) Triggered when a worker reports progress
void	runInDialog(JIPipeDesktopWorkbench workbench, Component parent, JIPipeRunnable runnable) Runs the runnable in a dialog
void	setSilent(boolean silent)
int	size() The size of the queue (includes the currently running JIPipeGraphRun
void	tryDequeue() Attempts to run a scheduled run

Methods inherited from class java.lang.Object

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

Constructor Detail

JIPipeRunnableQueue

public JIPipeRunnableQueue(String name)

Method Detail

getInstance

public static JIPipeRunnableQueue getInstance()

Returns:

Singleton instance

getName

public String getName()

isRunningOrEnqueued

public boolean isRunningOrEnqueued(JIPipeRunnable runnable)

Determines if a runnable is enqueued or running

Parameters:

runnable - the runnable

Returns:

if a runnable is enqueued or running

getEnqueuedEventEmitter

public JIPipeRunnable.EnqueuedEventEmitter getEnqueuedEventEmitter()

getFinishedEventEmitter

public JIPipeRunnable.FinishedEventEmitter getFinishedEventEmitter()

getInterruptedEventEmitter

public JIPipeRunnable.InterruptedEventEmitter getInterruptedEventEmitter()

getProgressEventEmitter

public JIPipeRunnable.ProgressEventEmitter getProgressEventEmitter()

getStartedEventEmitter

public JIPipeRunnable.StartedEventEmitter getStartedEventEmitter()

getQueue

public Queue<JIPipeRunnableWorker> getQueue()

isSilent

public boolean isSilent()

setSilent

public void setSilent(boolean silent)

isEmpty

public boolean isEmpty()

Returns:

true if nothing is running and the queue is empty

size

public int size()

The size of the queue (includes the currently running JIPipeGraphRun

Returns:

the size

enqueue

public JIPipeRunnableWorker enqueue(JIPipeRunnable run)

Schedules a new runnable

Parameters:

run - The runnable

Returns:

The worker associated to the run

findWorkerOf

public JIPipeRunnableWorker findWorkerOf(JIPipeRunnable run)

Finds the worker associated to the JIPipeRunnable

Parameters:

run - The runnable

Returns:

The associated worker

tryDequeue

public void tryDequeue()

Attempts to run a scheduled run

cancel

public void cancel(JIPipeRunnable run)

Cancels a runnable

Parameters:

run - The runnable

onRunnableFinished

public void onRunnableFinished(JIPipeRunnable.FinishedEvent event)

Triggered when a worker is finished

Specified by:

onRunnableFinished in interface JIPipeRunnable.FinishedEventListener

Parameters:

event - Generated event

onRunnableInterrupted

public void onRunnableInterrupted(JIPipeRunnable.InterruptedEvent event)

Triggered when a worker is interrupted

Specified by:

onRunnableInterrupted in interface JIPipeRunnable.InterruptedEventListener

Parameters:

event - Generated event

onRunnableProgress

public void onRunnableProgress(JIPipeRunnable.ProgressEvent event)

Triggered when a worker reports progress

Specified by:

onRunnableProgress in interface JIPipeRunnable.ProgressEventListener

Parameters:

event - Generated event

getCurrentRunWorker

public JIPipeRunnableWorker getCurrentRunWorker()

Returns:

The current run

getCurrentRun

public JIPipeRunnable getCurrentRun()

Returns:

The current run

clearQueue

public void clearQueue()

Removes all enqueued (but not running tasks)

cancelAll

public void cancelAll()

cancelIf

public void cancelIf(Predicate<JIPipeRunnable> predicate)

runInDialog

public void runInDialog(JIPipeDesktopWorkbench workbench,
                        Component parent,
                        JIPipeRunnable runnable)

Runs the runnable in a dialog

Parameters:

runnable - the runnable