org.hkijena.jipipe.api.environments

Class ExternalEnvironment

java.lang.Object

org.hkijena.jipipe.api.environments.ExternalEnvironment

All Implemented Interfaces:

JIPipeValidatable, JIPipeParameterCollection

Direct Known Subclasses:

ProcessEnvironment, PythonEnvironment, PythonPackageLibraryEnvironment, REnvironment

public abstract class ExternalEnvironment
extends Object
implements JIPipeParameterCollection, JIPipeValidatable

Defines an external environment

Nested Class Summary

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

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Constructor Summary

Constructors

Constructor and Description
ExternalEnvironment()
ExternalEnvironment(ExternalEnvironment other)

Method Summary

Modifier and Type	Method and Description
EventBus	getEventBus() Gets the event bus that posts events about the parameters
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()
void	setName(String name)

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

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

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

generateValidityReport, reportValidity

Constructor Detail

ExternalEnvironment

public ExternalEnvironment()

ExternalEnvironment

public ExternalEnvironment(ExternalEnvironment 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

getEventBus

public EventBus getEventBus()

Description copied from interface: JIPipeParameterCollection

Gets the event bus that posts events about the parameters

Specified by:

getEventBus in interface JIPipeParameterCollection

Returns:

The event bus triggering JIPipeParameterCollection.ParameterChangedEvent and JIPipeParameterCollection.ParameterStructureChangedEvent

getName

public String getName()

setName

public void setName(String name)