org.hkijena.jipipe.plugins.jsonextensionloader

Class JsonExtensionLoaderPlugin

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.service.AbstractService

org.hkijena.jipipe.JIPipeDefaultJavaPlugin

org.hkijena.jipipe.plugins.JIPipePrepackagedDefaultJavaPlugin

org.hkijena.jipipe.plugins.jsonextensionloader.JsonExtensionLoaderPlugin

All Implemented Interfaces:

Comparable<org.scijava.Prioritized>, JIPipeValidatable, JIPipeDependency, JIPipeJavaPlugin, JIPipePlugin, JIPipeService.PluginRegisteredEventListener, 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

public class JsonExtensionLoaderPlugin
extends JIPipePrepackagedDefaultJavaPlugin
implements JIPipeService.PluginRegisteredEventListener

Extension that loads JIPipeJsonPlugin

Constructor Summary

Constructors

Constructor and Description
JsonExtensionLoaderPlugin()

Method Summary

Modifier and Type	Method and Description
StringList	getDependencyCitations() Returns all dependent work
String	getDependencyId()
StringList	getDependencyProvides() The list of alternative IDs that are covered by this dependency
HTMLText	getDescription()
String	getName()
static Path	getPluginDirectory()
boolean	isCorePlugin() Returns whether this extension is a core extension and thus cannot be disabled by users.
void	onJIPipePluginRegistered(JIPipeService.ExtensionRegisteredEvent event)
void	register(JIPipe jiPipe, org.scijava.Context context, JIPipeProgressInfo progressInfo) Registers custom modules into JIPipe
void	registerJsonExtensionFromFile(Path filePath) Schedules a registration task for the file path
void	registerJsonExtensionFromResource(String resourcePath) Schedules a registration task for a resource path
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	runRegistrationTask(JsonExtensionRegistrationTask task) Immediately runs a registration task.
void	scheduleRegisterJsonExtension(Path filePath, com.fasterxml.jackson.databind.JsonNode jsonNode) Schedules the registration of an extension Invalid JSON data is skipped
void	setRegistry(JIPipe registry) Sets the registry
void	updateRegistrationTasks() Tries to register more extensions waiting for dependencies

Methods inherited from class org.hkijena.jipipe.plugins.JIPipePrepackagedDefaultJavaPlugin

getAuthors, getCitation, getDependencyVersion, getLicense, getLogo, getWebsite

Methods inherited from class org.hkijena.jipipe.JIPipeDefaultJavaPlugin

configureDefaultImageJAdapters, configureDefaultImageJAdapters, getAcknowledgements, getCategories, getDependencies, getDependencyLocation, getMetadata, getRegistry, getSummary, registerAnnotationNodeType, registerApplicationSettingsSheet, registerContextMenuAction, registerDatatype, registerDatatype, registerDatatypeConversion, registerDatatypeDisplayOperation, registerDatatypeImportOperation, registerDatatypeOperation, registerDefaultDataTypeViewer, registerEnumParameterType, registerEnvironment, registerEnvironmentInstaller, registerExpressionFunction, registerExpressionFunction, registerFileChooserKnownDirectoryType, registerFileChooserKnownDirectoryType, registerFileChooserKnownFileType, registerFileChooserKnownFileType, registerGraphEditorTool, registerGraphEditorToolBarButtonExtension, registerImageJDataExporter, registerImageJDataImporter, registerMenuExtension, registerMetadataObjectType, registerNodeExample, registerNodeExample, registerNodeExample, registerNodeExamplesFromResources, registerNodeExamplesFromResources, registerNodeTemplate, registerNodeTemplatesFromResources, registerNodeTemplatesFromResources, registerNodeType, registerNodeType, registerNodeType, registerNodeType, registerNodeType, registerNodeTypeCategory, registerParameterEditor, registerParameterGenerator, registerParameterType, registerParameterType, registerParameterType, registerParameterType, registerParameterType, registerParameterType, registerProjectSettingsSheet, registerProjectTemplatesFromResources, registerProjectTemplatesFromResources, registerTableColumnOperation, registerTableColumnOperationAndExpressionFunction, registerUtility

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

getSplashIcons, postprocess

Methods inherited from interface org.hkijena.jipipe.JIPipePlugin

canActivate, isActivated, isBeta, isScheduledForActivation, isScheduledForDeactivation

Methods inherited from interface org.hkijena.jipipe.JIPipeDependency

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

JsonExtensionLoaderPlugin

public JsonExtensionLoaderPlugin()

Method Detail

getPluginDirectory

public static Path getPluginDirectory()

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

getDependencyCitations

public StringList getDependencyCitations()

Description copied from class: JIPipeDefaultJavaPlugin

Returns all dependent work

Specified by:

getDependencyCitations in class JIPipeDefaultJavaPlugin

Returns:

dependent work

getName

public String getName()

Specified by:

getName in class JIPipeDefaultJavaPlugin

Returns:

The extension name

getDescription

public HTMLText getDescription()

Specified by:

getDescription in class JIPipeDefaultJavaPlugin

Returns:

The extension description

register

public void register(JIPipe jiPipe,
                     org.scijava.Context context,
                     JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeJavaPlugin

Registers custom modules into JIPipe

Specified by:

register in interface JIPipeJavaPlugin

Parameters:

jiPipe - the JIPipe instance that calls this function

context - the SciJava Context

progressInfo - the progress info

setRegistry

public void setRegistry(JIPipe registry)

Description copied from interface: JIPipeJavaPlugin

Sets the registry

Specified by:

setRegistry in interface JIPipeJavaPlugin

Overrides:

setRegistry in class JIPipeDefaultJavaPlugin

Parameters:

registry - The registry

getDependencyId

public String getDependencyId()

Specified by:

getDependencyId in interface JIPipeDependency

Returns:

The unique dependency ID

updateRegistrationTasks

public void updateRegistrationTasks()

Tries to register more extensions waiting for dependencies

runRegistrationTask

public void runRegistrationTask(JsonExtensionRegistrationTask task)

Immediately runs a registration task. Dependencies are not checked.

Parameters:

task - the task

registerJsonExtensionFromFile

public void registerJsonExtensionFromFile(Path filePath)

Schedules a registration task for the file path

Parameters:

filePath - extension file

registerJsonExtensionFromResource

public void registerJsonExtensionFromResource(String resourcePath)

Schedules a registration task for a resource path

Parameters:

resourcePath - the resource

scheduleRegisterJsonExtension

public void scheduleRegisterJsonExtension(Path filePath,
                                          com.fasterxml.jackson.databind.JsonNode jsonNode)

Schedules the registration of an extension Invalid JSON data is skipped

Parameters:

filePath - the file path where the JSON was loaded. This is only used for information. Can be null.

jsonNode - JSON data that contains the serialized extension

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

Overrides:

reportValidity in class JIPipeDefaultJavaPlugin

Parameters:

reportContext - the report context

report - the report to be added to

isCorePlugin

public boolean isCorePlugin()

Description copied from interface: JIPipePlugin

Returns whether this extension is a core extension and thus cannot be disabled by users. Defaults to false. Please be sure if you really want to mark an extension as core extension.

Specified by:

isCorePlugin in interface JIPipePlugin

Returns:

if the extension cannot be disabled

onJIPipePluginRegistered

public void onJIPipePluginRegistered(JIPipeService.ExtensionRegisteredEvent event)

Specified by:

onJIPipePluginRegistered in interface JIPipeService.PluginRegisteredEventListener