org.hkijena.jipipe.api.environments

Class EasyInstallExternalEnvironmentInstaller<T extends ExternalEnvironment>

java.lang.Object

org.hkijena.jipipe.api.environments.ExternalEnvironmentInstaller

org.hkijena.jipipe.api.environments.EasyInstallExternalEnvironmentInstaller<T>

All Implemented Interfaces:

Runnable, JIPipeRunnable

Direct Known Subclasses:

CellposeEasyInstaller, OmniposeEasyInstaller, PythonEasyInstaller, REasyInstaller

public abstract class EasyInstallExternalEnvironmentInstaller<T extends ExternalEnvironment>
extends ExternalEnvironmentInstaller

Environment installer that extracts a premade package of the environment and generates the appropriate environment Supported are .tar.gz and .zip archives that should contain the hierarchy of files as expected in the environment installation directory. The run() method will ensure that

Constructor Summary

Constructors

Constructor and Description
EasyInstallExternalEnvironmentInstaller(JIPipeWorkbench workbench, JIPipeParameterAccess parameterAccess)

Method Summary

Modifier and Type	Method and Description
protected void	executePostprocess() Postprocessing steps (optional) that are executed after the extraction of the archive
protected abstract T	generateEnvironment() Generates the final environment.
Path	getAbsoluteInstallationPath()
List<EasyInstallExternalEnvironmentInstallerPackage>	getAvailablePackages()
abstract HTMLText	getDialogDescription() The description of the installation dialog
abstract String	getDialogHeading() The heading of the installation dialog
ExternalEnvironment	getInstalledEnvironment() Returns the final environment after installation
JIPipeProgressInfo	getProgressInfo() The info object that allows communication with the run
Path	getRelativeInstallationPath() Installation path relative to the ImageJ root
abstract List<String>	getRepositories() This method should return all repositories that are available
EasyInstallExternalEnvironmentInstallerPackage	getTargetPackage()
void	run()
void	setProgressInfo(JIPipeProgressInfo progressInfo) Sets the progress info of this runnable
protected abstract void	writeEnvironmentToParameters(T environment, JIPipeParameterAccess parameterAccess) This method should write the environment to the parameter access Will be executed on the Swing thread (via invokeLater)

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

getParameterAccess, getWorkbench

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.JIPipeRunnable

getTaskLabel, onFinished, onInterrupted, onProgress, onStarted

Constructor Detail

EasyInstallExternalEnvironmentInstaller

public EasyInstallExternalEnvironmentInstaller(JIPipeWorkbench workbench,
                                               JIPipeParameterAccess parameterAccess)

Parameters:

workbench - the workbench

parameterAccess - the parameter access that will receive the generated environment

Method Detail

getProgressInfo

public JIPipeProgressInfo getProgressInfo()

Description copied from interface: JIPipeRunnable

The info object that allows communication with the run

Returns:

the info object

setProgressInfo

public void setProgressInfo(JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeRunnable

Sets the progress info of this runnable

Parameters:

progressInfo - the info object

getTargetPackage

public EasyInstallExternalEnvironmentInstallerPackage getTargetPackage()

getRelativeInstallationPath

public Path getRelativeInstallationPath()

Installation path relative to the ImageJ root

Returns:

the installation path

getAbsoluteInstallationPath

public Path getAbsoluteInstallationPath()

getInstalledEnvironment

public ExternalEnvironment getInstalledEnvironment()

Description copied from class: ExternalEnvironmentInstaller

Returns the final environment after installation

Specified by:

getInstalledEnvironment in class ExternalEnvironmentInstaller

Returns:

the final environment or null if there was an error

run

public void run()

executePostprocess

protected void executePostprocess()

Postprocessing steps (optional) that are executed after the extraction of the archive

writeEnvironmentToParameters

protected abstract void writeEnvironmentToParameters(T environment,
                                                     JIPipeParameterAccess parameterAccess)

This method should write the environment to the parameter access Will be executed on the Swing thread (via invokeLater)

Parameters:

environment - the environment

parameterAccess - the parameter

generateEnvironment

protected abstract T generateEnvironment()

Generates the final environment. Has access to the target package (getTargetPackage()) and the installation path

Returns:

the environment or null if there is an error

getAvailablePackages

public List<EasyInstallExternalEnvironmentInstallerPackage> getAvailablePackages()

getRepositories

public abstract List<String> getRepositories()

This method should return all repositories that are available

Returns:

the repositories

getDialogHeading

public abstract String getDialogHeading()

The heading of the installation dialog

Returns:

the heading

getDialogDescription

public abstract HTMLText getDialogDescription()

The description of the installation dialog

Returns:

the description