org.hkijena.jipipe.api

Class JIPipeProjectRun

java.lang.Object

org.hkijena.jipipe.api.JIPipeProjectRun

All Implemented Interfaces:

Runnable, JIPipeGraphGCHelper.SlotCompletedEventListener, JIPipeRunnable

public class JIPipeProjectRun
extends Object
implements JIPipeRunnable, JIPipeGraphGCHelper.SlotCompletedEventListener

Runnable instance of an JIPipeProject

Nested Class Summary

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.JIPipeRunnable

JIPipeRunnable.EnqeuedEventListener, JIPipeRunnable.EnqueuedEvent, JIPipeRunnable.EnqueuedEventEmitter, JIPipeRunnable.FinishedEvent, JIPipeRunnable.FinishedEventEmitter, JIPipeRunnable.FinishedEventListener, JIPipeRunnable.InterruptedEvent, JIPipeRunnable.InterruptedEventEmitter, JIPipeRunnable.InterruptedEventListener, JIPipeRunnable.ProgressEvent, JIPipeRunnable.ProgressEventEmitter, JIPipeRunnable.ProgressEventListener, JIPipeRunnable.StartedEvent, JIPipeRunnable.StartedEventEmitter, JIPipeRunnable.StartedEventListener

Constructor Summary

Constructors

Constructor and Description
JIPipeProjectRun(JIPipeProject project, JIPipeRunSettings configuration)

Method Summary

Modifier and Type	Method and Description
void	assignDataStoragePaths() Iterates through output slots and assigns the data storage paths
JIPipeRunSettings	getConfiguration()
JIPipeGraph	getGraph()
JIPipeProgressInfo	getProgressInfo() The info object that allows communication with the run
JIPipeProject	getProject()
String	getTaskLabel() A name for the runnable
static JIPipeProjectRun	loadFromFolder(Path folder, JIPipeIssueReport report, JIPipeNotificationInbox notifications) Loads a JIPipeProjectRun from a folder
void	onGCSlotCompletedEvent(JIPipeGraphGCHelper.SlotCompletedEvent event)
void	run()
void	setProgressInfo(JIPipeProgressInfo progressInfo) Sets the progress info of this runnable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.JIPipeRunnable

onFinished, onInterrupted

Constructor Detail

JIPipeProjectRun

public JIPipeProjectRun(JIPipeProject project,
                        JIPipeRunSettings configuration)

Parameters:

project - The project

configuration - Run configuration

Method Detail

loadFromFolder

public static JIPipeProjectRun loadFromFolder(Path folder,
                                              JIPipeIssueReport report,
                                              JIPipeNotificationInbox notifications)
                                       throws IOException

Loads a JIPipeProjectRun from a folder

Parameters:

folder - Folder containing the run

notifications - notifications for the user

Returns:

The loaded run

Throws:

IOException - Triggered by ObjectMapper

getProject

public JIPipeProject getProject()

Returns:

The project that created this run

assignDataStoragePaths

public void assignDataStoragePaths()

Iterates through output slots and assigns the data storage paths

run

public void run()

Specified by:

run in interface Runnable

getGraph

public JIPipeGraph getGraph()

Returns:

The graph used within this run. A copy of the project graph.

getConfiguration

public JIPipeRunSettings getConfiguration()

Returns:

The run configuration

getProgressInfo

public JIPipeProgressInfo getProgressInfo()

Description copied from interface: JIPipeRunnable

The info object that allows communication with the run

Specified by:

getProgressInfo in interface JIPipeRunnable

Returns:

the info object

setProgressInfo

public void setProgressInfo(JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeRunnable

Sets the progress info of this runnable

Specified by:

setProgressInfo in interface JIPipeRunnable

Parameters:

progressInfo - the info object

getTaskLabel

public String getTaskLabel()

Description copied from interface: JIPipeRunnable

A name for the runnable

Specified by:

getTaskLabel in interface JIPipeRunnable

Returns:

the name

onGCSlotCompletedEvent

public void onGCSlotCompletedEvent(JIPipeGraphGCHelper.SlotCompletedEvent event)

Specified by:

onGCSlotCompletedEvent in interface JIPipeGraphGCHelper.SlotCompletedEventListener