org.hkijena.jipipe

Class JIPipeDefaultJavaPlugin

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.service.AbstractService

org.hkijena.jipipe.JIPipeDefaultJavaPlugin

All Implemented Interfaces:

Comparable<org.scijava.Prioritized>, JIPipeValidatable, JIPipeDependency, JIPipeJavaPlugin, JIPipePlugin, org.scijava.Contextual, org.scijava.Disposable, org.scijava.Identifiable, org.scijava.Initializable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.plugin.HasPluginInfo, org.scijava.plugin.RichPlugin, org.scijava.plugin.SciJavaPlugin, org.scijava.Prioritized, org.scijava.service.Service, org.scijava.Versioned

Direct Known Subclasses:

JIPipePrepackagedDefaultJavaPlugin

public abstract class JIPipeDefaultJavaPlugin
extends org.scijava.service.AbstractService
implements JIPipeJavaPlugin

Default implementation of JIPipeJavaPlugin

Constructor Summary

Constructors

Constructor and Description
JIPipeDefaultJavaPlugin() Creates a new instance

Method Summary

Modifier and Type	Method and Description
void	configureDefaultImageJAdapters(Class<? extends JIPipeData> dataClass, ImageJDataImporter defaultImporter, ImageJDataExporter defaultExporter) Sets the default ImageJ adapters
void	configureDefaultImageJAdapters(Class<? extends JIPipeData> dataClass, String defaultImporterId, String defaultExporterId) Sets the default ImageJ adapters
JIPipeAuthorMetadata.List	getAcknowledgements() Returns additionally cited authors
abstract List<JIPipeAuthorMetadata>	getAuthors()
PluginCategoriesEnumParameter.List	getCategories() The categories of this extension (see PluginCategoriesEnumParameter for predefined values)
abstract String	getCitation()
Set<JIPipeDependency>	getDependencies() List of JIPipe dependencies.
abstract StringList	getDependencyCitations() Returns all dependent work
Path	getDependencyLocation() Gets the location of the JAR/JSON that defined the dependency
String	getDependencyVersion()
abstract HTMLText	getDescription()
abstract String	getLicense()
JIPipeStandardMetadata	getMetadata()
abstract String	getName()
JIPipe	getRegistry() Returns the registry
HTMLText	getSummary() A short summary
abstract String	getWebsite()
<T extends JIPipeAnnotationGraphNode> void	registerAnnotationNodeType(String id, Class<T> nodeClass, Class<? extends JIPipeAnnotationGraphNodeTool<T>> graphToolClass, URL icon) Registers a new annotation node type and associated JIPipeGraphEditorTool
void	registerApplicationSettingsSheet(JIPipeApplicationSettingsSheet sheet) Registers a new application settings sheet
void	registerContextMenuAction(NodeUIContextAction action) Registers a custom context menu action
void	registerDatatype(String id, Class<? extends JIPipeData> dataClass, URL icon, Class<? extends JIPipeDesktopResultDataSlotRowUI> rowUI, Class<? extends JIPipeDesktopResultDataSlotPreview> cellUI, JIPipeLegacyDataOperation... operations) Registers a new data type
void	registerDatatype(String id, Class<? extends JIPipeData> dataClass, URL icon, JIPipeLegacyDataOperation... operations) Registers a new data type
void	registerDatatypeConversion(JIPipeDataConverter converter) Registers a non-trivial conversion between data types.
void	registerDatatypeDisplayOperation(String dataTypeId, JIPipeDesktopDataDisplayOperation operation) Registers an additional non-default display operation for the data type.
void	registerDatatypeImportOperation(String dataTypeId, JIPipeLegacyDataImportOperation operation) Registers an import operation for the data type.
void	registerDatatypeOperation(String dataTypeId, JIPipeLegacyDataOperation... operations) Shortcut for registering import and display operations.
void	registerDefaultDataTypeViewer(Class<? extends JIPipeData> dataClass, Class<? extends JIPipeDesktopDataViewer> dataViewerClass) Registers a default data viewer for the provided data class Overrides any existing data viewer
void	registerEnumParameterType(String id, Class<? extends Enum<?>> parameterClass, String name, String description) Registers an Enum as parameter
<T extends JIPipeEnvironment,U extends ListParameter<T>> void	registerEnvironment(Class<T> environmentClass, Class<U> listClass, JIPipeExternalEnvironmentSettings settings, String id, String name, String description, Icon icon) Registers a new environment type.
void	registerEnvironmentInstaller(Class<? extends JIPipeEnvironment> environmentClass, Class<? extends JIPipeExternalEnvironmentInstaller> installerClass, Icon icon) Registers an installer for a given environment
void	registerExpressionFunction(ExpressionFunction function) Registers a function that can be used within expressions.
void	registerExpressionFunction(ExpressionFunction function, String name, String description) Registers a function that can be used within expressions.
void	registerFileChooserKnownDirectoryType(String name, Icon icon, String extension, String... otherExtensions) Registers directory type metadata for the file chooser.
void	registerFileChooserKnownDirectoryType(String name, String icon16Name, String extension, String... otherExtensions) Registers directory type metadata for the file chooser.
void	registerFileChooserKnownFileType(String name, Icon icon, String extension, String... otherExtensions) Registers file type metadata for the file chooser.
void	registerFileChooserKnownFileType(String name, String icon16Name, String extension, String... otherExtensions) Registers file type metadata for the file chooser.
void	registerGraphEditorTool(Class<? extends JIPipeGraphEditorTool> klass)
void	registerGraphEditorToolBarButtonExtension(Class<? extends JIPipeDesktopGraphEditorToolBarButtonExtension> klass) Registers a custom button for the graph editor toolbar
void	registerImageJDataExporter(String id, ImageJDataExporter dataExporter, Class<? extends ImageJDataExporterUI> uiClass) Registers an importer for data from ImageJ
void	registerImageJDataImporter(String id, ImageJDataImporter dataImporter, Class<? extends ImageJDataImporterUI> importerUIClass) Registers an importer for data from ImageJ
void	registerMenuExtension(Class<? extends JIPipeDesktopMenuExtension> klass) Registers a custom menu entry.
void	registerMetadataObjectType(Class<? extends JIPipeMetadataObject> objectClass, String id, String... alternativeIds) Registers a new metadata object type, which are JSON-serializable objects with a defined type identifier string
<T extends JIPipeGraphNode> void	registerNodeExample(Class<T> nodeClass, String name, Consumer<T> configurator) Registers a node as node example based on a node instance The configurator function is run prior to the registration Must be run within postprocess()
void	registerNodeExample(JIPipeGraphNode node) Registers a node example based on the node instance The name of the example is taken from the node custom name Must be run within postprocess()
void	registerNodeExample(JIPipeNodeTemplate template) Registers a node template as example for a node.
void	registerNodeExamplesFromResources(Class<?> resourceClass, String directory) Registers node examples from plugin resources.
void	registerNodeExamplesFromResources(JIPipeResourceManager resourceManager, String subDirectory) Registers node examples from plugin resources via a JIPipeResourceManager.
void	registerNodeTemplate(JIPipeNodeTemplate template) Registers a node template
void	registerNodeTemplatesFromResources(Class<?> resourceClass, String directory) Registers node examples from plugin resources.
void	registerNodeTemplatesFromResources(JIPipeResourceManager resourceManager, String subDirectory) Registers node templates from plugin resources via a JIPipeResourceManager.
void	registerNodeType(JIPipeNodeInfo info) Registers a new node type.
void	registerNodeType(JIPipeNodeInfo info, URL icon) Registers a new node type.
void	registerNodeType(JIPipeNodeRegistrationTask task) Registers a new node type with additional dependencies.
void	registerNodeType(String id, Class<? extends JIPipeGraphNode> nodeClass) Registers a new node type.
void	registerNodeType(String id, Class<? extends JIPipeGraphNode> nodeClass, URL icon) Registers a new node type.
void	registerNodeTypeCategory(JIPipeNodeTypeCategory category) Registers a node type category
void	registerParameterEditor(Class<?> parameterClass, Class<? extends JIPipeDesktopParameterEditorUI> uiClass) Registers an editor for any parameter type that inherits from the provided parameter class.
void	registerParameterGenerator(Class<?> parameterClass, JIPipeParameterGenerator generator) Registers a UI that can generate parameters
void	registerParameterType(JIPipeParameterTypeInfo info, Class<?> listClass, Class<? extends JIPipeDesktopParameterEditorUI> uiClass) Registers a new parameter type and respective editor
void	registerParameterType(JIPipeParameterTypeInfo info, Class<? extends JIPipeDesktopParameterEditorUI> uiClass) Registers a new parameter type and respective editor
void	registerParameterType(String id, Class<?> parameterClass, String name, String description) Registers a new parameter type that already has an existing editor.
void	registerParameterType(String id, Class<?> parameterClass, String name, String description, Class<? extends JIPipeDesktopParameterEditorUI> uiClass) Registers a new parameter type.
void	registerParameterType(String id, Class<?> parameterClass, Supplier<Object> newInstanceGenerator, Function<Object,Object> duplicateFunction, String name, String description, Class<? extends JIPipeDesktopParameterEditorUI> uiClass) Registers a new parameter type and respective editors
<T> void	registerParameterType(String id, Class<T> parameterClass, Class<? extends ListParameter<T>> listClass, Supplier<Object> newInstanceGenerator, Function<Object,Object> duplicateFunction, String name, String description, Class<? extends JIPipeDesktopParameterEditorUI> uiClass) Registers a new parameter type and respective editors
void	registerProjectSettingsSheet(Class<? extends JIPipeProjectSettingsSheet> settingsSheetClass) Registers a new project settings sheet
void	registerProjectTemplatesFromResources(Class<?> resourceClass, String directory) Registers project templates from plugin resources Will detect *.jip files and attempt to load them (fails silently)
void	registerProjectTemplatesFromResources(JIPipeResourceManager resourceManager, String subDirectory) Registers project templates from plugin resources via a JIPipeResourceManager.
void	registerTableColumnOperation(String id, ColumnOperation operation, String name, String shortName, String description) Registers a table column operation.
void	registerTableColumnOperationAndExpressionFunction(String id, ColumnOperation operation, String name, String shortName, String description) Registers a table column operation.
void	registerUtility(Class<?> categoryClass, Class<?> utilityClass) Registers an arbitrary utility associated to a category class.
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	setRegistry(JIPipe registry) Sets the registry

Methods inherited from class org.scijava.service.AbstractService

getContext, setContext, toString

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual

context

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hkijena.jipipe.JIPipeJavaPlugin

getLogo, getSplashIcons, postprocess, register

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, getDependencyId, getDependencyProvides, getImageJUpdateSiteDependencies, getImageJUpdateSites, simplifyAndMinimize, toHtmlElement

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

generateValidityReport

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.Disposable

dispose

Constructor Detail

JIPipeDefaultJavaPlugin

public JIPipeDefaultJavaPlugin()

Creates a new instance

Method Detail

getCategories

public PluginCategoriesEnumParameter.List getCategories()

The categories of this extension (see PluginCategoriesEnumParameter for predefined values)

Returns:

the categories

getAcknowledgements

public JIPipeAuthorMetadata.List getAcknowledgements()

Returns additionally cited authors

Returns:

the authors

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 set of JIPipe dependencies

getDependencyCitations

public abstract StringList getDependencyCitations()

Returns all dependent work

Returns:

dependent work

getCitation

public abstract String getCitation()

Returns:

The citation

getMetadata

public JIPipeStandardMetadata getMetadata()

Specified by:

getMetadata in interface JIPipeDependency

Returns:

The dependency metadata

getName

public abstract String getName()

Returns:

The extension name

getDescription

public abstract HTMLText getDescription()

Returns:

The extension description

getSummary

public HTMLText getSummary()

A short summary

Returns:

a short summary

getAuthors

public abstract List<JIPipeAuthorMetadata> getAuthors()

Returns:

The extension authors

getWebsite

public abstract String getWebsite()

Returns:

The extension website

getLicense

public abstract String getLicense()

Returns:

The extension license

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

getDependencyVersion

public String getDependencyVersion()

Specified by:

getDependencyVersion in interface JIPipeDependency

Returns:

The dependency version

getRegistry

public JIPipe getRegistry()

Description copied from interface: JIPipeJavaPlugin

Returns the registry

Specified by:

getRegistry in interface JIPipeJavaPlugin

Returns:

The registry

setRegistry

public void setRegistry(JIPipe registry)

Description copied from interface: JIPipeJavaPlugin

Sets the registry

Specified by:

setRegistry in interface JIPipeJavaPlugin

Parameters:

registry - The registry

registerMenuExtension

public void registerMenuExtension(Class<? extends JIPipeDesktopMenuExtension> klass)

Registers a custom menu entry.

Parameters:

klass - The menu entry

registerGraphEditorToolBarButtonExtension

public void registerGraphEditorToolBarButtonExtension(Class<? extends JIPipeDesktopGraphEditorToolBarButtonExtension> klass)

Registers a custom button for the graph editor toolbar

Parameters:

klass - the toolbar button class

registerContextMenuAction

public void registerContextMenuAction(NodeUIContextAction action)

Registers a custom context menu action

Parameters:

action - the action

registerDatatypeConversion

public void registerDatatypeConversion(JIPipeDataConverter converter)

Registers a non-trivial conversion between data types. Please note that JIPipe will prefer trivial conversions (using Java inheritance) to custom converters.

Parameters:

converter - the converter

registerAnnotationNodeType

public <T extends JIPipeAnnotationGraphNode> void registerAnnotationNodeType(String id,
                                                                             Class<T> nodeClass,
                                                                             Class<? extends JIPipeAnnotationGraphNodeTool<T>> graphToolClass,
                                                                             URL icon)

Registers a new annotation node type and associated JIPipeGraphEditorTool

Type Parameters:

T - the node class

Parameters:

id - the ID of the node type (must be unique)

nodeClass - the node class

graphToolClass - the graph editor class

icon - the icon URL

registerDatatype

public void registerDatatype(String id,
                             Class<? extends JIPipeData> dataClass,
                             URL icon,
                             Class<? extends JIPipeDesktopResultDataSlotRowUI> rowUI,
                             Class<? extends JIPipeDesktopResultDataSlotPreview> cellUI,
                             JIPipeLegacyDataOperation... operations)

Registers a new data type

Parameters:

id - Data type id

dataClass - Data class

icon - Icon for the data type. Can be null.

rowUI - Results analyzer row UI for the data type. Can be null. If null, it will use the default row UI that manages JIPipeLegacyDataImportOperation instances.

cellUI - Results table cell UI. Can be null.

operations - list of operations to register. passed to registerDatatypeOperation.

registerDatatype

public void registerDatatype(String id,
                             Class<? extends JIPipeData> dataClass,
                             URL icon,
                             JIPipeLegacyDataOperation... operations)

Registers a new data type

Parameters:

id - Data type id

dataClass - Data class

icon - Icon for the data type. Can be null.

operations - list of operations to register. passed to registerDatatypeOperation.

registerDatatypeOperation

public void registerDatatypeOperation(String dataTypeId,
                                      JIPipeLegacyDataOperation... operations)

Shortcut for registering import and display operations. If an instance is both, it is registered for both.

Parameters:

dataTypeId - the data type id. it is not required that the data type is registered, yet. If empty, the operations are applying to all data.

operations - operations

registerDefaultDataTypeViewer

public void registerDefaultDataTypeViewer(Class<? extends JIPipeData> dataClass,
                                          Class<? extends JIPipeDesktopDataViewer> dataViewerClass)

Registers a default data viewer for the provided data class Overrides any existing data viewer

Parameters:

dataClass - the data class

dataViewerClass - the viewer class

registerDatatypeImportOperation

public void registerDatatypeImportOperation(String dataTypeId,
                                            JIPipeLegacyDataImportOperation operation)

Registers an import operation for the data type. This is not used if the data type is assigned a non-default row UI

Parameters:

dataTypeId - the data type id. it is not required that the data type is registered, yet. If empty, the operations are applying to all data.

operation - the operation

registerDatatypeDisplayOperation

public void registerDatatypeDisplayOperation(String dataTypeId,
                                             JIPipeDesktopDataDisplayOperation operation)

Registers an additional non-default display operation for the data type. Used in the cache browser.

Parameters:

dataTypeId - the data type id. it is not required that the data type is registered, yet. If empty, the operations are applying to all data.

operation - the operation

registerNodeTypeCategory

public void registerNodeTypeCategory(JIPipeNodeTypeCategory category)

Registers a node type category

Parameters:

category - the category

registerNodeType

public void registerNodeType(String id,
                             Class<? extends JIPipeGraphNode> nodeClass)

Registers a new node type. The JIPipeNodeInfo is generated as JIPipeJavaNodeInfo.

Parameters:

id - Algorithm ID

nodeClass - Algorithm class

registerNodeType

public void registerNodeType(String id,
                             Class<? extends JIPipeGraphNode> nodeClass,
                             URL icon)

Registers a new node type. The JIPipeNodeInfo is generated as JIPipeJavaNodeInfo.

Parameters:

id - Algorithm ID

nodeClass - Algorithm class

icon - custom icon

registerNodeType

public void registerNodeType(JIPipeNodeInfo info)

Registers a new node type. It is assumed that all dependencies are met. If the dependency situation is unclear, register an JIPipeNodeRegistrationTask instead

Parameters:

info - Algorithm info

registerNodeType

public void registerNodeType(JIPipeNodeInfo info,
                             URL icon)

Registers a new node type. It is assumed that all dependencies are met. If the dependency situation is unclear, register an JIPipeNodeRegistrationTask instead

Parameters:

info - Algorithm info

icon - custom algorithm icon

registerNodeType

public void registerNodeType(JIPipeNodeRegistrationTask task)

Registers a new node type with additional dependencies. Actual registration happens when all dependencies are met.-

Parameters:

task - Algorithm registration task

registerEnumParameterType

public void registerEnumParameterType(String id,
                                      Class<? extends Enum<?>> parameterClass,
                                      String name,
                                      String description)

Registers an Enum as parameter

Parameters:

id - Unique ID of this parameter type

parameterClass - Parameter class

name - Parameter class name

description - Description for the parameter type

registerParameterType

public void registerParameterType(String id,
                                  Class<?> parameterClass,
                                  Supplier<Object> newInstanceGenerator,
                                  Function<Object,Object> duplicateFunction,
                                  String name,
                                  String description,
                                  Class<? extends JIPipeDesktopParameterEditorUI> uiClass)

Registers a new parameter type and respective editors

Parameters:

id - Unique ID of this parameter type

parameterClass - Parameter class

newInstanceGenerator - Function that creates a new instance

duplicateFunction - Function that copies an existing instance

name - Parameter class name

description - Description for the parameter type

uiClass - Parameter editor UI. Can be null if the editor is already provided.

registerParameterType

public void registerParameterType(String id,
                                  Class<?> parameterClass,
                                  String name,
                                  String description)

Registers a new parameter type that already has an existing editor. Must have a default constructor and a deep copy constructor

Parameters:

id - Unique ID of this parameter type

parameterClass - Parameter class

name - Parameter class name

description - Description for the parameter type

registerParameterType

public void registerParameterType(String id,
                                  Class<?> parameterClass,
                                  String name,
                                  String description,
                                  Class<? extends JIPipeDesktopParameterEditorUI> uiClass)

Registers a new parameter type. Must have a default constructor and a deep copy constructor

Parameters:

id - Unique ID of this parameter type

parameterClass - Parameter class

name - Parameter class name

description - Description for the parameter type

uiClass - Parameter editor UI. Can be null if the editor is already provided.

registerParameterType

public <T> void registerParameterType(String id,
                                      Class<T> parameterClass,
                                      Class<? extends ListParameter<T>> listClass,
                                      Supplier<Object> newInstanceGenerator,
                                      Function<Object,Object> duplicateFunction,
                                      String name,
                                      String description,
                                      Class<? extends JIPipeDesktopParameterEditorUI> uiClass)

Registers a new parameter type and respective editors

Type Parameters:

T - parameter class

Parameters:

id - Unique ID of this parameter type

parameterClass - Parameter class

listClass - Optional list class. If not null this creates a registration entry for the equivalent list entry

newInstanceGenerator - Function that creates a new instance. If null, the function calls the default constructor

duplicateFunction - Function that copies an existing instance. If null, the function calls the copy constructor

name - Parameter class name

description - Description for the parameter type

uiClass - Parameter editor UI. Can be null if the editor is already provided.

registerParameterType

public void registerParameterType(JIPipeParameterTypeInfo info,
                                  Class<? extends JIPipeDesktopParameterEditorUI> uiClass)

Registers a new parameter type and respective editor

Parameters:

info - the info

uiClass - Parameter editor UI. Can be null if the editor is already provided.

registerParameterType

public void registerParameterType(JIPipeParameterTypeInfo info,
                                  Class<?> listClass,
                                  Class<? extends JIPipeDesktopParameterEditorUI> uiClass)

Registers a new parameter type and respective editor

Parameters:

info - the info

listClass - a parameter type that is a list of the registered type

uiClass - Parameter editor UI. Can be null if the editor is already provided.

registerParameterEditor

public void registerParameterEditor(Class<?> parameterClass,
                                    Class<? extends JIPipeDesktopParameterEditorUI> uiClass)

Registers an editor for any parameter type that inherits from the provided parameter class. Please use this with caution, as unregistered parameters are rejected by components that require a unique parameter type ID (for example JIPipeDynamicParameterCollection)

Parameters:

parameterClass - the parameter class

uiClass - the editor class

registerParameterGenerator

public void registerParameterGenerator(Class<?> parameterClass,
                                       JIPipeParameterGenerator generator)

Registers a UI that can generate parameters

Parameters:

parameterClass - Parameter class

generator - The generator object

registerTableColumnOperation

public void registerTableColumnOperation(String id,
                                         ColumnOperation operation,
                                         String name,
                                         String shortName,
                                         String description)

Registers a table column operation. Those operations are used in various places that handle tabular data

Parameters:

id - operation id

operation - the operation instance

name - the name

shortName - a short name (like min, max, avg, ...)

description - a description

registerTableColumnOperationAndExpressionFunction

public void registerTableColumnOperationAndExpressionFunction(String id,
                                                              ColumnOperation operation,
                                                              String name,
                                                              String shortName,
                                                              String description)

Registers a table column operation. Those operations are used in various places that handle tabular data. Also registers an expression function that is generated via an adapter class (its ID will be the upper-case of the the short name with spaces replaced by underscores)

Parameters:

id - operation id

operation - the operation instance

name - the name

shortName - a short name (like min, max, avg, ...)

description - a description

registerExpressionFunction

public void registerExpressionFunction(ExpressionFunction function,
                                       String name,
                                       String description)

Registers a function that can be used within expressions.

Parameters:

function - the function. its internal name property must be unique

name - human-readable name

description - the description

registerExpressionFunction

public void registerExpressionFunction(ExpressionFunction function)

Registers a function that can be used within expressions. The name and description are taken from SetJIPipeDocumentation annotations.

Parameters:

function - the function. its internal name property must be unique

configureDefaultImageJAdapters

public void configureDefaultImageJAdapters(Class<? extends JIPipeData> dataClass,
                                           String defaultImporterId,
                                           String defaultExporterId)

Sets the default ImageJ adapters

Parameters:

dataClass - the data type

defaultImporterId - the ID of the importer. the importer must be registered. can be null (ignore value)

defaultExporterId - the ID of the exporter. the exporter must be registered. can be null (ignore value)

configureDefaultImageJAdapters

public void configureDefaultImageJAdapters(Class<? extends JIPipeData> dataClass,
                                           ImageJDataImporter defaultImporter,
                                           ImageJDataExporter defaultExporter)

Sets the default ImageJ adapters

Parameters:

dataClass - the data type

defaultImporter - the importer. the importer must be registered. can be null (ignore value)

defaultExporter - the exporter. the exporter must be registered. can be null (ignore value)

registerImageJDataImporter

public void registerImageJDataImporter(String id,
                                       ImageJDataImporter dataImporter,
                                       Class<? extends ImageJDataImporterUI> importerUIClass)

Registers an importer for data from ImageJ

Parameters:

id - the unique ID

dataImporter - the importer instance

importerUIClass - the UI (can be null to fall back to DefaultImageJDataImporterUI)

registerImageJDataExporter

public void registerImageJDataExporter(String id,
                                       ImageJDataExporter dataExporter,
                                       Class<? extends ImageJDataExporterUI> uiClass)

Registers an importer for data from ImageJ

Parameters:

id - the unique ID

dataExporter - the exporter instance

uiClass - the UI (can be null to fall back to DefaultImageJDataExporterUI)

registerApplicationSettingsSheet

public void registerApplicationSettingsSheet(JIPipeApplicationSettingsSheet sheet)

Registers a new application settings sheet

Parameters:

sheet - the settings sheet

registerProjectSettingsSheet

public void registerProjectSettingsSheet(Class<? extends JIPipeProjectSettingsSheet> settingsSheetClass)

Registers a new project settings sheet

Parameters:

settingsSheetClass - the settings sheet class. must have a default constructor.

registerUtility

public void registerUtility(Class<?> categoryClass,
                            Class<?> utilityClass)

Registers an arbitrary utility associated to a category class. There can be multiple utilities per category The exact type of utility class depends on the utility implementation

Parameters:

categoryClass - the category class

utilityClass - the utility class

registerMetadataObjectType

public void registerMetadataObjectType(Class<? extends JIPipeMetadataObject> objectClass,
                                       String id,
                                       String... alternativeIds)

Registers a new metadata object type, which are JSON-serializable objects with a defined type identifier string

Parameters:

objectClass - the object class

id - the ID of the object class

alternativeIds - alternative Ids that are captured during the reading process

registerNodeExample

public void registerNodeExample(JIPipeNodeTemplate template)

Registers a node template as example for a node. Silently fails if the template does not contain exactly one node

Parameters:

template - the template

registerNodeExamplesFromResources

public void registerNodeExamplesFromResources(JIPipeResourceManager resourceManager,
                                              String subDirectory)

Registers node examples from plugin resources via a JIPipeResourceManager. Will detect *.json files and attempt to load them (fails silently)

Parameters:

resourceManager - the resource manager

subDirectory - the directory within the resource manager's base path

registerNodeExample

public <T extends JIPipeGraphNode> void registerNodeExample(Class<T> nodeClass,
                                                            String name,
                                                            Consumer<T> configurator)

Registers a node as node example based on a node instance The configurator function is run prior to the registration Must be run within postprocess()

Type Parameters:

T - the node type

Parameters:

nodeClass - the node class

name - the name of the example

configurator - executed on an instance of the node

registerNodeExample

public void registerNodeExample(JIPipeGraphNode node)

Registers a node example based on the node instance The name of the example is taken from the node custom name Must be run within postprocess()

Parameters:

node - the example node

registerNodeExamplesFromResources

public void registerNodeExamplesFromResources(Class<?> resourceClass,
                                              String directory)

Registers node examples from plugin resources. Will detect *.json files and attempt to load them (fails silently)

Parameters:

resourceClass - the resource class

directory - the directory within the resources

registerNodeTemplate

public void registerNodeTemplate(JIPipeNodeTemplate template)

Registers a node template

Parameters:

template - the template

registerNodeTemplatesFromResources

public void registerNodeTemplatesFromResources(JIPipeResourceManager resourceManager,
                                               String subDirectory)

Registers node templates from plugin resources via a JIPipeResourceManager. Will detect *.json files and attempt to load them (fails silently)

Parameters:

resourceManager - the resource manager

subDirectory - the directory within the resource manager's base path

registerNodeTemplatesFromResources

public void registerNodeTemplatesFromResources(Class<?> resourceClass,
                                               String directory)

Registers node examples from plugin resources. Will detect *.json files and attempt to load them (fails silently)

Parameters:

resourceClass - the resource class

directory - the directory within the resources

registerProjectTemplatesFromResources

public void registerProjectTemplatesFromResources(JIPipeResourceManager resourceManager,
                                                  String subDirectory)

Registers project templates from plugin resources via a JIPipeResourceManager. Will detect *.jip files and attempt to load them (fails silently)

Parameters:

resourceManager - the resource manager

subDirectory - the directory within the resource manager's base path

registerProjectTemplatesFromResources

public void registerProjectTemplatesFromResources(Class<?> resourceClass,
                                                  String directory)

Registers project templates from plugin resources Will detect *.jip files and attempt to load them (fails silently)

Parameters:

resourceClass - the resource class

directory - the directory within the resources

registerGraphEditorTool

public void registerGraphEditorTool(Class<? extends JIPipeGraphEditorTool> klass)

registerEnvironment

public <T extends JIPipeEnvironment,U extends ListParameter<T>> void registerEnvironment(Class<T> environmentClass,
                                                                                         Class<U> listClass,
                                                                                         JIPipeExternalEnvironmentSettings settings,
                                                                                         String id,
                                                                                         String name,
                                                                                         String description,
                                                                                         Icon icon)

Registers a new environment type. This will also register the environment class and environment list class a valid parameters. Requires that the environment class has a default constructor and a deep copy constructor. Will also register a settings page for the environment

Type Parameters:

T - environment class

U - list of environment class

Parameters:

environmentClass - the environment class. Must be JSON-serializable. Will be registered as parameter type

listClass - the list. Will be registered as parameter type with ID [id]-list

settings - Settings page that stores the user's presets

id - the ID of the environment class. Will be used as parameter type ID

name - the name of the environment

description - the description of the environment

registerEnvironmentInstaller

public void registerEnvironmentInstaller(Class<? extends JIPipeEnvironment> environmentClass,
                                         Class<? extends JIPipeExternalEnvironmentInstaller> installerClass,
                                         Icon icon)

Registers an installer for a given environment

Parameters:

environmentClass - the environment type

installerClass - the installer class

icon - icon for the installer

registerFileChooserKnownFileType

public void registerFileChooserKnownFileType(String name,
                                             Icon icon,
                                             String extension,
                                             String... otherExtensions)

Registers file type metadata for the file chooser. This is only for UX improvements with files and has no functional impact.

Parameters:

name - the name

icon - the icon. If 32x32, the icon itself is used. Otherwise, it is combined with the default file icon

extension - the extension (including dot)

otherExtensions - other extensions (including dot)

registerFileChooserKnownFileType

public void registerFileChooserKnownFileType(String name,
                                             String icon16Name,
                                             String extension,
                                             String... otherExtensions)

Registers file type metadata for the file chooser. This is only for UX improvements with files and has no functional impact.

Parameters:

name - the name

icon16Name - the icon in JIPipe's standard library. Combined with the default file icon

extension - the extension (including dot)

otherExtensions - other extensions (including dot)

registerFileChooserKnownDirectoryType

public void registerFileChooserKnownDirectoryType(String name,
                                                  Icon icon,
                                                  String extension,
                                                  String... otherExtensions)

Registers directory type metadata for the file chooser. This is only for UX improvements with files and has no functional impact.

Parameters:

name - the name

icon - the icon. If 32x32, the icon itself is used. Otherwise, it is combined with the default file icon

extension - the extension (including dot)

otherExtensions - other extensions (including dot)

registerFileChooserKnownDirectoryType

public void registerFileChooserKnownDirectoryType(String name,
                                                  String icon16Name,
                                                  String extension,
                                                  String... otherExtensions)

Registers directory type metadata for the file chooser. This is only for UX improvements with files and has no functional impact.

Parameters:

name - the name

icon16Name - the icon in JIPipe's standard library. Combined with the default file icon

extension - the extension (including dot)

otherExtensions - other extensions (including dot)

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