org.hkijena.jipipe.api.environments

Class JIPipeEnvironment

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.environments.JIPipeEnvironment

All Implemented Interfaces:

JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeValidatable

Direct Known Subclasses:

JIPipeArtifactEnvironment, OMEROCredentialsEnvironment, ProcessEnvironment

public abstract class JIPipeEnvironment
extends AbstractJIPipeParameterCollection
implements JIPipeValidatable

Defines an environment

Nested Class Summary

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

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Constructor Summary

Constructors

Constructor and Description
JIPipeEnvironment()
JIPipeEnvironment(JIPipeEnvironment other)

Method Summary

Modifier and Type	Method and Description
abstract Icon	getIcon() Returns the icon displayed in the UI for the current status
abstract String	getInfo() Returns more detailed information (e.g., the executed script environment path).
String	getName()
String	getSource()
String	getVersion()
void	runPostprocessing(JIPipeGraphRun run, JIPipeProgressInfo progressInfo) Executed after the end of the run (regardless if it failed or was successful)
void	runPreconfigure(JIPipeGraphRun run, JIPipeProgressInfo progressInfo) Executed at the start of the run and after artifacts are configured
void	setName(String name)
void	setSource(String source)
void	setVersion(String version)

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

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.validation.JIPipeValidatable

generateValidityReport, reportValidity

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Constructor Detail

JIPipeEnvironment

public JIPipeEnvironment()

JIPipeEnvironment

public JIPipeEnvironment(JIPipeEnvironment other)

Method Detail

getIcon

public abstract Icon getIcon()

Returns the icon displayed in the UI for the current status

Returns:

the icon

getInfo

public abstract String getInfo()

Returns more detailed information (e.g., the executed script environment path). Displayed inside a text field.

Returns:

the info string

getName

public String getName()

setName

public void setName(String name)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getSource

public String getSource()

setSource

public void setSource(String source)

runPreconfigure

public void runPreconfigure(JIPipeGraphRun run,
                            JIPipeProgressInfo progressInfo)

Executed at the start of the run and after artifacts are configured

Parameters:

run - the run that executes the step

progressInfo - the progress info

runPostprocessing

public void runPostprocessing(JIPipeGraphRun run,
                              JIPipeProgressInfo progressInfo)

Executed after the end of the run (regardless if it failed or was successful)

Parameters:

run - the run that executes the step

progressInfo - the progress info