org.hkijena.jipipe.extensions.python

Class PythonPackageLibraryEnvironment

java.lang.Object

org.hkijena.jipipe.api.environments.ExternalEnvironment

org.hkijena.jipipe.extensions.python.PythonPackageLibraryEnvironment

All Implemented Interfaces:

JIPipeValidatable, JIPipeParameterCollection

Direct Known Subclasses:

JIPipePythonAdapterLibraryEnvironment

public abstract class PythonPackageLibraryEnvironment
extends ExternalEnvironment

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.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

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).
Map<String,String>	getInstalledVersions() Gets the installed versions of packages Returns an empty map if the version file could not be found or the environment is not installed Returns an empty map if the library is provided by the environment
Path	getLibraryDirectory()
abstract Map<String,String>	getPackagedVersions() Gets the packaged versions of the installed libraries
protected Map<String,String>	getPackagedVersionsFromResources(String resourcePath, Class<?> resourceLoader) Gets the packaged versions from resources
abstract void	install(JIPipeProgressInfo progressInfo) Installs the library into the target directory
protected void	installFromResources(String javaPackage, String globalFolder, Class<?> resourceLoader, JIPipeProgressInfo progressInfo) Installs the library from resources into the target directory
boolean	isNewestVersion() Returns true if the currently installed library is the newest version Only auto-installed (resource-based) installations are tested Returns true if needsInstall() returns true (as the newest lib will be installed anyways)
boolean	isProvidedByEnvironment()
boolean	needsInstall() Returns true if the library is not installed
void	reportValidity(JIPipeIssueReport report) Generates a validity report
void	setLibraryDirectory(Path libraryDirectory)
void	setProvidedByEnvironment(boolean providedByEnvironment)

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

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)

reportValidity

public void reportValidity(JIPipeIssueReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Parameters:

report - the report to be added to

getAbsoluteLibraryDirectory

public Path getAbsoluteLibraryDirectory()

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

generateCode

public void generateCode(StringBuilder code,
                         JIPipeProgressInfo progressInfo)

Installs the library if needed

Parameters:

code - the current Python code

needsInstall

public boolean needsInstall()

Returns true if the library is not installed

Returns:

if the library is not installed

isNewestVersion

public boolean isNewestVersion()

Returns true if the currently installed library is the newest version Only auto-installed (resource-based) installations are tested Returns true if needsInstall() returns true (as the newest lib will be installed anyways)

Returns:

if the newest version is installed

getInstalledVersions

public Map<String,String> getInstalledVersions()

Gets the installed versions of packages Returns an empty map if the version file could not be found or the environment is not installed Returns an empty map if the library is provided by the environment

Returns:

package to version map

getPackagedVersions

public abstract Map<String,String> getPackagedVersions()

Gets the packaged versions of the installed libraries

Returns:

package to version map

install

public abstract void install(JIPipeProgressInfo progressInfo)

Installs the library into the target directory

getPackagedVersionsFromResources

protected Map<String,String> getPackagedVersionsFromResources(String resourcePath,
                                                              Class<?> resourceLoader)

Gets the packaged versions from resources

Parameters:

resourcePath - the resource path

resourceLoader - the resource loader

Returns:

packaged versions

installFromResources

protected void installFromResources(String javaPackage,
                                    String globalFolder,
                                    Class<?> resourceLoader,
                                    JIPipeProgressInfo progressInfo)

Installs the library from resources into the target directory

Parameters:

javaPackage - the java package (for the resource search)

globalFolder - the folder that contains the library

resourceLoader - the resource loader