org.hkijena.jipipe

Interface JIPipeDependency

All Superinterfaces:

JIPipeValidatable

All Known Subinterfaces:

JIPipeExtension, JIPipeJavaExtension

All Known Implementing Classes:

AnnotationsExtension, BatchAssistantExtension, CellposeExtension, CLIJExtension, CoreExtension, ExpressionExtension, FilesystemExtension, FormsExtension, GroupingExtension, ImageJ2Extension, ImageJAlgorithmsExtension, ImageJDataTypesExtension, JIPipeCompartmentsExtension, JIPipeDefaultJavaExtension, JIPipeJsonExtension, JIPipeMutableDependency, JIPipePrepackagedDefaultJavaExtension, JsonExtensionLoaderExtension, LoopingExtension, MultiParameterAlgorithmsExtension, MultiParametersExtension, MultiTemplateMatchingExtension, NodeTemplateBoxToolExtension, OMEROExtension, OmniposeExtension, PipelineRenderExtension, PlotsExtension, ProcessesExtension, PythonExtension, RExtension, StandardParametersExtension, StandardSettingsExtension, StringsExtension, TablesExtension, ToolsExtension, TrackMateExtension, UpdateSiteExtension, UtilitiesExtension, WekaExtension

public interface JIPipeDependency
extends JIPipeValidatable

Encapsulates a dependency such as an extension or JSON extension

Method Summary

Modifier and Type	Method and Description
default Set<JIPipeDependency>	getAllDependencies() Gets a flat list of all dependencies (no nested dependencies) This method returns the dependencies to be stored into JSON JIPipeMutableDependency instances are returned instead of the original type and the thumbnail metadata is removed
default Set<JIPipeDependency>	getAllDependencies(boolean minimize) Gets a flat list of all dependencies (no nested dependencies) This method returns the dependencies to be stored into JSON JIPipeMutableDependency instances are returned instead of the original type and the thumbnail metadata is removed
default Set<JIPipeImageJUpdateSiteDependency>	getAllImageJUpdateSiteDependencies() Gets a flat list of all ImageJ update site dependencies (including transitive dependencies) This method returns the dependencies to be stored into JSON
default Set<JIPipeDependency>	getDependencies() List of JIPipe dependencies.
String	getDependencyId()
Path	getDependencyLocation() Gets the location of the JAR/JSON that defined the dependency
String	getDependencyVersion()
default List<JIPipeImageJUpdateSiteDependency>	getImageJUpdateSiteDependencies() List of ImageJ update sites that are dependencies
default List<JIPipeImageJUpdateSiteDependency>	getImageJUpdateSites() List of ImageJ update sites that provide the dependency
JIPipeMetadata	getMetadata()
void	reportValidity(JIPipeIssueReport report) Generates a validity report
static Set<JIPipeDependency>	simplifyAndMinimize(Set<JIPipeDependency> dependencies, boolean minimize) Flattens the hierarchy of dependencies into a list and removes large metadata (e.g. thumbnails)
static String	toHtmlElement(JIPipeDependency dependency) Exports the dependency to an HTML element (without the root tag)

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

generateValidityReport

Method Detail

toHtmlElement

static String toHtmlElement(JIPipeDependency dependency)

Exports the dependency to an HTML element (without the root tag)

Parameters:

dependency - Dependency instance

Returns:

HTML element without HTML root tags

simplifyAndMinimize

static Set<JIPipeDependency> simplifyAndMinimize(Set<JIPipeDependency> dependencies,
                                                 boolean minimize)

Flattens the hierarchy of dependencies into a list and removes large metadata (e.g. thumbnails)

Parameters:

dependencies - the dependencies

minimize - whether heavy data (e.g. thumbnails should be removed)

Returns:

simplified dependencies

getMetadata

JIPipeMetadata getMetadata()

Returns:

The dependency metadata

getDependencyId

String getDependencyId()

Returns:

The unique dependency ID

getDependencyVersion

String getDependencyVersion()

Returns:

The dependency version

getDependencyLocation

Path getDependencyLocation()

Gets the location of the JAR/JSON that defined the dependency

Returns:

location of the JAR/JSON that defined the dependency

getImageJUpdateSiteDependencies

default List<JIPipeImageJUpdateSiteDependency> getImageJUpdateSiteDependencies()

List of ImageJ update sites that are dependencies

Returns:

the list of update sites

getAllDependencies

default Set<JIPipeDependency> getAllDependencies()

Gets a flat list of all dependencies (no nested dependencies) This method returns the dependencies to be stored into JSON JIPipeMutableDependency instances are returned instead of the original type and the thumbnail metadata is removed

Returns:

flat list of dependencies

getAllDependencies

default Set<JIPipeDependency> getAllDependencies(boolean minimize)

Gets a flat list of all dependencies (no nested dependencies) This method returns the dependencies to be stored into JSON JIPipeMutableDependency instances are returned instead of the original type and the thumbnail metadata is removed

Parameters:

minimize - whether heavy data (e.g. thumbnails should be removed)

Returns:

flat list of dependencies

getAllImageJUpdateSiteDependencies

default Set<JIPipeImageJUpdateSiteDependency> getAllImageJUpdateSiteDependencies()

Gets a flat list of all ImageJ update site dependencies (including transitive dependencies) This method returns the dependencies to be stored into JSON

Returns:

flat list of all current and transitive dependencies

getDependencies

default Set<JIPipeDependency> getDependencies()

List of JIPipe dependencies. This can contain nested or even cyclic dependencies. The storage of dependencies into JSON format is handled by getTraversedDependencies()

Returns:

the list of JIPipe dependencies

getImageJUpdateSites

default List<JIPipeImageJUpdateSiteDependency> getImageJUpdateSites()

List of ImageJ update sites that provide the dependency

Returns:

the list of update sites

reportValidity

void reportValidity(JIPipeIssueReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Parameters:

report - the report to be added to