org.hkijena.jipipe

Class JIPipeJsonPlugin

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.JIPipeJsonPlugin

All Implemented Interfaces:

JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeValidatable, JIPipeDependency, JIPipePlugin

public class JIPipeJsonPlugin
extends AbstractJIPipeParameterCollection
implements JIPipePlugin, JIPipeValidatable

A JSON-serializable extension

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeJsonPlugin.Deserializer Deserializer for the JIPipeJsonPlugin.

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
JIPipeJsonPlugin() Creates a new instance

Method Summary

Modifier and Type	Method and Description
void	addAlgorithm(JsonNodeInfo nodeInfo) Adds a new node type of specified type
Set<JIPipeDependency>	getDependencies() List of JIPipe dependencies.
String	getDependencyId()
Path	getDependencyLocation() Gets the location of the JAR/JSON that defined the dependency
StringList	getDependencyProvides() The list of alternative IDs that are covered by this dependency
String	getDependencyVersion()
JIPipeService.ExtensionContentAddedEventEmitter	getExtensionContentAddedEventEmitter()
JIPipeService.ExtensionContentRemovedEventEmitter	getExtensionContentRemovedEventEmitter()
List<JIPipeImageJUpdateSiteDependency>	getImageJUpdateSiteDependencies() List of ImageJ update sites that are dependencies
Path	getJsonFilePath()
JIPipeStandardMetadata	getMetadata()
Set<JsonNodeInfo>	getNodeInfos()
String	getProjectType()
JIPipe	getRegistry()
JIPipeImageJUpdateSiteDependency.List	getUpdateSiteDependenciesParameter()
static JIPipeJsonPlugin	loadProject(com.fasterxml.jackson.databind.JsonNode jsonData) Loads an extension from JSON
static JIPipeJsonPlugin	loadProject(Path path) Loads an extension from a file
void	register() Registers the content.
void	removeAlgorithm(JsonNodeInfo info) Removes an algorithm
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	saveProject(Path savePath) Saves the extension
void	setDependencyProvides(StringList dependencyProvides)
void	setId(String id) Sets the ID
void	setMetadata(JIPipeStandardMetadata metadata) Sets metadata
void	setRegistry(JIPipe registry) Sets the registry instance
void	setUpdateSiteDependenciesParameter(JIPipeImageJUpdateSiteDependency.List updateSiteDependenciesParameter)
void	setVersion(String version) Sets the version

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

canActivate, isActivated, isBeta, isCorePlugin, isScheduledForActivation, isScheduledForDeactivation

Methods inherited from interface org.hkijena.jipipe.JIPipeDependency

getAllDependencies, getAllDependencies, getAllImageJUpdateSiteDependencies, getImageJUpdateSites, simplifyAndMinimize, toHtmlElement

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, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Constructor Detail

JIPipeJsonPlugin

public JIPipeJsonPlugin()

Creates a new instance

Method Detail

loadProject

public static JIPipeJsonPlugin loadProject(com.fasterxml.jackson.databind.JsonNode jsonData)

Loads an extension from JSON

Parameters:

jsonData - JSON data

Returns:

Loaded instance

loadProject

public static JIPipeJsonPlugin loadProject(Path path)

Loads an extension from a file

Parameters:

path - the path to the project file

Returns:

the project

getExtensionContentAddedEventEmitter

public JIPipeService.ExtensionContentAddedEventEmitter getExtensionContentAddedEventEmitter()

getExtensionContentRemovedEventEmitter

public JIPipeService.ExtensionContentRemovedEventEmitter getExtensionContentRemovedEventEmitter()

getMetadata

public JIPipeStandardMetadata getMetadata()

Specified by:

getMetadata in interface JIPipeDependency

Returns:

The dependency metadata

setMetadata

public void setMetadata(JIPipeStandardMetadata metadata)

Sets metadata

Parameters:

metadata - Metadata

getDependencyId

public String getDependencyId()

Specified by:

getDependencyId in interface JIPipeDependency

Returns:

The unique dependency ID

getDependencyProvides

public StringList getDependencyProvides()

Description copied from interface: JIPipeDependency

The list of alternative IDs that are covered by this dependency

Specified by:

getDependencyProvides in interface JIPipeDependency

Returns:

alternative IDs

setDependencyProvides

public void setDependencyProvides(StringList dependencyProvides)

setId

public void setId(String id)

Sets the ID

Parameters:

id - ID

getDependencyVersion

public String getDependencyVersion()

Specified by:

getDependencyVersion in interface JIPipeDependency

Returns:

The dependency version

getDependencyLocation

public Path getDependencyLocation()

Description copied from interface: JIPipeDependency

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

Specified by:

getDependencyLocation in interface JIPipeDependency

Returns:

location of the JAR/JSON that defined the dependency

setVersion

public void setVersion(String version)

Sets the version

Parameters:

version - Version

getProjectType

public String getProjectType()

Returns:

The project type

getDependencies

public Set<JIPipeDependency> getDependencies()

Description copied from interface: JIPipeDependency

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

Specified by:

getDependencies in interface JIPipeDependency

Returns:

The dependencies of this extension

getImageJUpdateSiteDependencies

public List<JIPipeImageJUpdateSiteDependency> getImageJUpdateSiteDependencies()

Description copied from interface: JIPipeDependency

List of ImageJ update sites that are dependencies

Specified by:

getImageJUpdateSiteDependencies in interface JIPipeDependency

Returns:

the list of update sites

getUpdateSiteDependenciesParameter

public JIPipeImageJUpdateSiteDependency.List getUpdateSiteDependenciesParameter()

setUpdateSiteDependenciesParameter

public void setUpdateSiteDependenciesParameter(JIPipeImageJUpdateSiteDependency.List updateSiteDependenciesParameter)

getJsonFilePath

public Path getJsonFilePath()

Returns:

The JSON file path of this extension. Can return null.

getRegistry

public JIPipe getRegistry()

Returns:

The registry instance

setRegistry

public void setRegistry(JIPipe registry)

Sets the registry instance

Parameters:

registry - The registry

register

public void register()

Registers the content. We cannot be sure if there are internal dependencies, so schedule tasks

saveProject

public void saveProject(Path savePath)
                 throws IOException

Saves the extension

Parameters:

savePath - The save path

Throws:

IOException - Triggered by ObjectMapper

addAlgorithm

public void addAlgorithm(JsonNodeInfo nodeInfo)

Adds a new node type of specified type

Parameters:

nodeInfo - The algorithm type

getNodeInfos

public Set<JsonNodeInfo> getNodeInfos()

Returns:

Algorithm infos

reportValidity

public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Specified by:

reportValidity in interface JIPipeDependency

Parameters:

reportContext - the report context

report - the report to be added to

removeAlgorithm

public void removeAlgorithm(JsonNodeInfo info)

Removes an algorithm

Parameters:

info - Algorithm type