org.hkijena.jipipe.api.environments

Class JIPipeProcessArtifactEnvironment

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.environments.JIPipeEnvironment

org.hkijena.jipipe.api.environments.JIPipeArtifactEnvironment

org.hkijena.jipipe.api.environments.JIPipeProcessArtifactEnvironment

All Implemented Interfaces:

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

Direct Known Subclasses:

IlastikEnvironment, TesseractOCREnvironment, TSOAXEnvironment

public abstract class JIPipeProcessArtifactEnvironment
extends JIPipeArtifactEnvironment

An artifact environment that points at an executable

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
JIPipeProcessArtifactEnvironment()
JIPipeProcessArtifactEnvironment(JIPipeProcessArtifactEnvironment other)

Method Summary

Modifier and Type	Method and Description
Path	getAbsoluteExecutablePath()
JIPipeExpressionParameter	getArguments()
StringQueryExpressionAndStringPairParameter.List	getEnvironmentVariables()
Path	getExecutablePath()
Icon	getIcon() Returns the icon displayed in the UI for the current status
String	getInfo() Returns more detailed information (e.g., the executed script environment path).
abstract Icon	getNonArtifactIcon()
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterAccess access) Allows to override the visibility of parameters inside the UI
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	runExecutable(List<String> args, Map<String,String> additionalEnvironmentVariables, boolean detached, JIPipeProgressInfo progressInfo) Runs the environment as process
void	setArguments(JIPipeExpressionParameter arguments)
void	setEnvironmentVariables(StringQueryExpressionAndStringPairParameter.List environmentVariables)
void	setExecutablePath(Path executablePath)
String	toString()

Methods inherited from class org.hkijena.jipipe.api.environments.JIPipeArtifactEnvironment

applyConfigurationFromArtifact, applyConfigurationFromArtifactAndSetLastArtifact, getArtifactQuery, getLastConfiguredArtifact, isLoadFromArtifact, setArtifactQuery, setLastConfiguredArtifact, setLoadFromArtifact

Methods inherited from class org.hkijena.jipipe.api.environments.JIPipeEnvironment

getName, getSource, getVersion, setName, setSource, setVersion

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, wait, wait, wait

Methods inherited from interface org.hkijena.jipipe.api.validation.JIPipeValidatable

generateValidityReport

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

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

Constructor Detail

JIPipeProcessArtifactEnvironment

public JIPipeProcessArtifactEnvironment()

JIPipeProcessArtifactEnvironment

public JIPipeProcessArtifactEnvironment(JIPipeProcessArtifactEnvironment other)

Method Detail

getArguments

public JIPipeExpressionParameter getArguments()

setArguments

public void setArguments(JIPipeExpressionParameter arguments)

getExecutablePath

public Path getExecutablePath()

setExecutablePath

public void setExecutablePath(Path executablePath)

getAbsoluteExecutablePath

public Path getAbsoluteExecutablePath()

getEnvironmentVariables

public StringQueryExpressionAndStringPairParameter.List getEnvironmentVariables()

setEnvironmentVariables

public void setEnvironmentVariables(StringQueryExpressionAndStringPairParameter.List environmentVariables)

reportValidity

public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Parameters:

reportContext - the report context

report - the report to be added to

isParameterUIVisible

public boolean isParameterUIVisible(JIPipeParameterTree tree,
                                    JIPipeParameterAccess access)

Description copied from interface: JIPipeParameterCollection

Allows to override the visibility of parameters inside the UI

Specified by:

isParameterUIVisible in interface JIPipeParameterCollection

Overrides:

isParameterUIVisible in class JIPipeArtifactEnvironment

Parameters:

tree - the parameter tree that is used to access this parameter

access - the parameter

Returns:

if the parameter is visible inside the UI

getNonArtifactIcon

public abstract Icon getNonArtifactIcon()

getIcon

public Icon getIcon()

Description copied from class: JIPipeEnvironment

Returns the icon displayed in the UI for the current status

Specified by:

getIcon in class JIPipeEnvironment

Returns:

the icon

getInfo

public String getInfo()

Description copied from class: JIPipeEnvironment

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

Specified by:

getInfo in class JIPipeEnvironment

Returns:

the info string

toString

public String toString()

Overrides:

toString in class Object

runExecutable

public void runExecutable(List<String> args,
                          Map<String,String> additionalEnvironmentVariables,
                          boolean detached,
                          JIPipeProgressInfo progressInfo)

Runs the environment as process

Parameters:

args - the arguments/cli parameters

additionalEnvironmentVariables - additional environment variables

detached - run process detached

progressInfo - the progress info