org.hkijena.jipipe.plugins.python

Class PythonPackageLibraryEnvironment

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.environments.JIPipeEnvironment

org.hkijena.jipipe.api.environments.JIPipeArtifactEnvironment

org.hkijena.jipipe.plugins.python.PythonPackageLibraryEnvironment

All Implemented Interfaces:

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

Direct Known Subclasses:

JIPipePythonAdapterLibraryEnvironment

public abstract class PythonPackageLibraryEnvironment
extends JIPipeArtifactEnvironment

An environment-like type that points to a package

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

Method Summary

Modifier and Type	Method and Description
void	generateCode(StringBuilder code, JIPipeProgressInfo progressInfo) Installs the library if needed
Path	getAbsoluteLibraryDirectory()
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).
Path	getLibraryDirectory()
boolean	isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterAccess access) Allows to override the visibility of parameters inside the UI
boolean	isProvidedByEnvironment()
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	setLibraryDirectory(Path libraryDirectory)
void	setProvidedByEnvironment(boolean providedByEnvironment)

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

PythonPackageLibraryEnvironment

public PythonPackageLibraryEnvironment()

PythonPackageLibraryEnvironment

public PythonPackageLibraryEnvironment(PythonPackageLibraryEnvironment other)

Method Detail

getLibraryDirectory

public Path getLibraryDirectory()

setLibraryDirectory

public void setLibraryDirectory(Path libraryDirectory)

isProvidedByEnvironment

public boolean isProvidedByEnvironment()

setProvidedByEnvironment

public void setProvidedByEnvironment(boolean providedByEnvironment)

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

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

getAbsoluteLibraryDirectory

public Path getAbsoluteLibraryDirectory()

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

generateCode

public void generateCode(StringBuilder code,
                         JIPipeProgressInfo progressInfo)

Installs the library if needed

Parameters:

code - the current Python code