org.hkijena.jipipe.extensions.jsonextensionloader

Class JsonExtensionLoaderExtension

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.service.AbstractService

org.hkijena.jipipe.JIPipeDefaultJavaExtension

org.hkijena.jipipe.extensions.JIPipePrepackagedDefaultJavaExtension

org.hkijena.jipipe.extensions.jsonextensionloader.JsonExtensionLoaderExtension

All Implemented Interfaces:

Comparable<Prioritized>, JIPipeValidatable, JIPipeDependency, JIPipeExtension, JIPipeJavaExtension, Contextual, Disposable, Identifiable, Initializable, Locatable, Logged, HasPluginInfo, RichPlugin, SciJavaPlugin, Prioritized, Service, Versioned

public class JsonExtensionLoaderExtension
extends JIPipePrepackagedDefaultJavaExtension

Extension that loads JIPipeJsonExtension

Constructor Summary

Constructors

Constructor and Description
JsonExtensionLoaderExtension()

Method Summary

Modifier and Type	Method and Description
StringList	getDependencyCitations() Returns all dependent work
String	getDependencyId()
HTMLText	getDescription()
String	getName()
static Path	getPluginDirectory()
boolean	isCoreExtension() Returns whether this extension is a core extension and thus cannot be disabled by users.
void	onExtensionRegistered(JIPipe.ExtensionRegisteredEvent event) Triggered when an extension is registered.
void	register(JIPipe jiPipe, 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(JIPipeIssueReport 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.extensions.JIPipePrepackagedDefaultJavaExtension

getAuthors, getCitation, getLicense, getLogo, getWebsite

Methods inherited from class org.hkijena.jipipe.JIPipeDefaultJavaExtension

configureDefaultImageJAdapters, configureDefaultImageJAdapters, getAcknowledgements, getCategories, getDependencies, getDependencyLocation, getDependencyVersion, getMetadata, getRegistry, getSummary, getThumbnail, registerContextMenuAction, registerDatatype, registerDatatype, registerDatatypeConversion, registerDatatypeDisplayOperation, registerDatatypeImportOperation, registerDatatypeOperation, registerEnumParameterType, registerEnvironment, registerEnvironmentInstaller, registerExpressionFunction, registerExpressionFunction, registerGraphEditorToolBarButtonExtension, registerImageJDataExporter, registerImageJDataImporter, registerMenuExtension, registerNodeExample, registerNodeExamplesFromResources, registerNodeExamplesFromResources, registerNodeType, registerNodeType, registerNodeType, registerNodeType, registerNodeType, registerNodeTypeCategory, registerParameterEditor, registerParameterGenerator, registerParameterType, registerParameterType, registerParameterType, registerParameterType, registerParameterType, registerParameterType, registerProjectTemplatesFromResources, registerProjectTemplatesFromResources, registerSettingsSheet, registerSettingsSheet, 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.JIPipeJavaExtension

getSplashIcons, postprocess

Methods inherited from interface org.hkijena.jipipe.JIPipeExtension

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

JsonExtensionLoaderExtension

public JsonExtensionLoaderExtension()

Method Detail

getPluginDirectory

public static Path getPluginDirectory()

getDependencyCitations

public StringList getDependencyCitations()

Description copied from class: JIPipeDefaultJavaExtension

Returns all dependent work

Specified by:

getDependencyCitations in class JIPipeDefaultJavaExtension

Returns:

dependent work

getName

public String getName()

Specified by:

getName in class JIPipeDefaultJavaExtension

Returns:

The extension name

getDescription

public HTMLText getDescription()

Specified by:

getDescription in class JIPipeDefaultJavaExtension

Returns:

The extension description

register

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

Description copied from interface: JIPipeJavaExtension

Registers custom modules into JIPipe

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: JIPipeJavaExtension

Sets the registry

Specified by:

setRegistry in interface JIPipeJavaExtension

Overrides:

setRegistry in class JIPipeDefaultJavaExtension

Parameters:

registry - The registry

getDependencyId

public String getDependencyId()

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(JIPipeIssueReport 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 JIPipeDefaultJavaExtension

Parameters:

report - the report to be added to

onExtensionRegistered

public void onExtensionRegistered(JIPipe.ExtensionRegisteredEvent event)

Triggered when an extension is registered.

Parameters:

event - Generated event

isCoreExtension

public boolean isCoreExtension()

Description copied from interface: JIPipeExtension

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.

Returns:

if the extension cannot be disabled