org.hkijena.jipipe.plugins.processes

Class ProcessEnvironment

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.environments.JIPipeEnvironment

org.hkijena.jipipe.plugins.processes.ProcessEnvironment

All Implemented Interfaces:

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

Direct Known Subclasses:

JIPipeDownloadsApplicationSettings.DownloadEnvironment

public class ProcessEnvironment
extends JIPipeEnvironment

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessEnvironment.List A list of ProcessEnvironment
static class	ProcessEnvironment.VariablesInfo

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

Method Summary

Modifier and Type	Method and Description
Path	getAbsoluteExecutablePath()
JIPipeExpressionParameter	getArguments()
StringQueryExpressionAndStringPairParameter.List	getEnvironmentVariables()
Path	getExecutablePathLinux()
Path	getExecutablePathOSX()
Path	getExecutablePathWindows()
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).
JIPipeExpressionParameter	getWorkDirectory()
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	setArguments(JIPipeExpressionParameter arguments)
void	setEnvironmentVariables(StringQueryExpressionAndStringPairParameter.List environmentVariables)
void	setExecutablePathLinux(Path executablePathLinux)
void	setExecutablePathOSX(Path executablePathOSX)
void	setExecutablePathWindows(Path executablePathWindows)
void	setWorkDirectory(JIPipeExpressionParameter workDirectory)
String	toString()

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, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Constructor Detail

ProcessEnvironment

public ProcessEnvironment()

ProcessEnvironment

public ProcessEnvironment(ProcessEnvironment other)

Method Detail

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

getArguments

public JIPipeExpressionParameter getArguments()

setArguments

public void setArguments(JIPipeExpressionParameter arguments)

getExecutablePathWindows

public Path getExecutablePathWindows()

setExecutablePathWindows

public void setExecutablePathWindows(Path executablePathWindows)

getExecutablePathLinux

public Path getExecutablePathLinux()

setExecutablePathLinux

public void setExecutablePathLinux(Path executablePathLinux)

getExecutablePathOSX

public Path getExecutablePathOSX()

setExecutablePathOSX

public void setExecutablePathOSX(Path executablePathOSX)

getWorkDirectory

public JIPipeExpressionParameter getWorkDirectory()

setWorkDirectory

public void setWorkDirectory(JIPipeExpressionParameter workDirectory)

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

toString

public String toString()

Overrides:

toString in class Object