org.hkijena.jipipe.extensions.python

Class PythonEnvironment

java.lang.Object

org.hkijena.jipipe.api.environments.ExternalEnvironment

org.hkijena.jipipe.extensions.python.PythonEnvironment

All Implemented Interfaces:

JIPipeValidatable, JIPipeParameterCollection

public class PythonEnvironment
extends ExternalEnvironment

Parameter that describes a Python environment

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PythonEnvironment.List A list of PythonEnvironment
static class	PythonEnvironment.PythonArgumentsVariableSource

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

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENVIRONMENT_ID

Constructor Summary

Constructors

Constructor and Description
PythonEnvironment()
PythonEnvironment(PythonEnvironment other)
PythonEnvironment(PythonEnvironmentType type, DefaultExpressionParameter arguments, Path executablePath)

Method Summary

Modifier and Type	Method and Description
Path	getAbsoluteExecutablePath()
DefaultExpressionParameter	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).
PythonEnvironmentType	getType()
void	reportValidity(JIPipeIssueReport report) Generates a validity report
void	setArguments(DefaultExpressionParameter arguments)
void	setEnvironmentVariables(StringQueryExpressionAndStringPairParameter.List environmentVariables)
void	setExecutablePath(Path executablePath)
void	setType(PythonEnvironmentType type)
String	toString()

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

getEventBus, getName, setName

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.parameters.JIPipeParameterCollection

addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, isParameterUIVisible, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

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

generateValidityReport

Field Detail

ENVIRONMENT_ID

public static final String ENVIRONMENT_ID

See Also:

Constant Field Values

Constructor Detail

PythonEnvironment

public PythonEnvironment()

PythonEnvironment

public PythonEnvironment(PythonEnvironmentType type,
                         DefaultExpressionParameter arguments,
                         Path executablePath)

PythonEnvironment

public PythonEnvironment(PythonEnvironment other)

Method Detail

getType

public PythonEnvironmentType getType()

setType

public void setType(PythonEnvironmentType type)

getArguments

public DefaultExpressionParameter getArguments()

setArguments

public void setArguments(DefaultExpressionParameter 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(JIPipeIssueReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Parameters:

report - the report to be added to

getIcon

public Icon getIcon()

Description copied from class: ExternalEnvironment

Returns the icon displayed in the UI for the current status

Specified by:

getIcon in class ExternalEnvironment

Returns:

the icon

getInfo

public String getInfo()

Description copied from class: ExternalEnvironment

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

Specified by:

getInfo in class ExternalEnvironment

Returns:

the info string

toString

public String toString()

Overrides:

toString in class Object