org.hkijena.jipipe.api.registries

Class JIPipeNodeRegistry

java.lang.Object

org.hkijena.jipipe.api.registries.JIPipeNodeRegistry

All Implemented Interfaces:

JIPipeValidatable

public class JIPipeNodeRegistry
extends Object
implements JIPipeValidatable

Manages known algorithms and their annotations

Constructor Summary

Constructors

Constructor and Description
JIPipeNodeRegistry(JIPipe jiPipe) Creates a new registry

Method Summary

Modifier and Type	Method and Description
void	executeScheduledRegisterExamples()
JIPipeNodeTypeCategory	getCategory(String id)
<T extends JIPipeData> Set<JIPipeNodeInfo>	getDataSourcesFor(Class<? extends T> dataClass) Returns data source algorithms that can generate the specified data type
Set<JIPipeNodeInfo>	getDeclaredBy(JIPipeDependency dependency) Gets all algorithms declared by the dependency
EventBus	getEventBus() Returns the event bus that posts registration events
ImageIcon	getIconFor(JIPipeNodeInfo info) Returns the icon for a node
URL	getIconURLFor(JIPipeNodeInfo info) Returns the icon resource path URL for a node
JIPipeNodeInfo	getInfoById(String id) Gets a matching info by Id
JIPipe	getJIPipe()
Collection<JIPipeNodeExample>	getNodeExamples(String nodeTypeId)
Set<JIPipeNodeInfo>	getNodeInfosFromClass(Class<? extends JIPipeGraphNode> klass) Returns all node infos that create a node of the specified class
Set<JIPipeNodeInfo>	getNodesOfCategory(JIPipeNodeTypeCategory category, boolean includingAlternative) Gets all algorithms of specified category
ImmutableBiMap<String,JIPipeNodeTypeCategory>	getRegisteredCategories()
Multimap<Class<? extends JIPipeGraphNode>,JIPipeNodeInfo>	getRegisteredNodeClasses()
Map<String,JIPipeNodeInfo>	getRegisteredNodeInfos() Gets the set of all known algorithms
Set<JIPipeNodeRegistrationTask>	getScheduledRegistrationTasks()
JIPipeDependency	getSourceOf(String algorithmId) Returns the source of a registered algorithm
boolean	hasNodeInfoWithId(String id) Returns true if the algorithm ID already exists
void	installEvents() Install registration events.
void	onDatatypeRegistered(JIPipe.DatatypeRegisteredEvent event) Triggered when a datatype was registered.
void	register(JIPipeNodeInfo info, JIPipeDependency source) Registers an algorithm info
void	registerCategory(JIPipeNodeTypeCategory category) Registers a category
void	registerExample(JIPipeNodeTemplate nodeTemplate) Registers a node template as example Will reject
void	registerIcon(JIPipeNodeInfo info, URL resourcePath) Registers a custom icon for a node
void	reportValidity(JIPipeIssueReport report) Generates a validity report
void	runRegistrationTasks() Attempts to run registration tasks that have registered dependencies
void	scheduleRegister(JIPipeNodeRegistrationTask task) Schedules registration after all dependencies of the registration task are satisfied
void	scheduleRegisterExample(JIPipeNodeTemplate template)
void	unregister(String id) Removes a node from the registry

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

generateValidityReport

Constructor Detail

JIPipeNodeRegistry

public JIPipeNodeRegistry(JIPipe jiPipe)

Creates a new registry

Parameters:

jiPipe - the JIPipe instance

Method Detail

scheduleRegister

public void scheduleRegister(JIPipeNodeRegistrationTask task)

Schedules registration after all dependencies of the registration task are satisfied

Parameters:

task - A registration task

runRegistrationTasks

public void runRegistrationTasks()

Attempts to run registration tasks that have registered dependencies

getScheduledRegistrationTasks

public Set<JIPipeNodeRegistrationTask> getScheduledRegistrationTasks()

Returns:

The list of current registration tasks

register

public void register(JIPipeNodeInfo info,
                     JIPipeDependency source)

Registers an algorithm info

Parameters:

info - The algorithm info

source - The dependency that registers the info

getCategory

public JIPipeNodeTypeCategory getCategory(String id)

registerCategory

public void registerCategory(JIPipeNodeTypeCategory category)

Registers a category

Parameters:

category - the category instance

getRegisteredNodeInfos

public Map<String,JIPipeNodeInfo> getRegisteredNodeInfos()

Gets the set of all known algorithms

Returns:

Map from algorithm ID to algorithm info

getDataSourcesFor

public <T extends JIPipeData> Set<JIPipeNodeInfo> getDataSourcesFor(Class<? extends T> dataClass)

Returns data source algorithms that can generate the specified data type

Type Parameters:

T - The data class

Parameters:

dataClass - The data class

Returns:

Available datasource algorithms that generate the data

getNodesOfCategory

public Set<JIPipeNodeInfo> getNodesOfCategory(JIPipeNodeTypeCategory category,
                                              boolean includingAlternative)

Gets all algorithms of specified category

Parameters:

category - The category

includingAlternative - if alternative categorizations should be included (from alternative menu paths)

Returns:

Algorithms within the specified category

getInfoById

public JIPipeNodeInfo getInfoById(String id)

Gets a matching info by Id

Parameters:

id - The info ID. Must exist.

Returns:

The info

hasNodeInfoWithId

public boolean hasNodeInfoWithId(String id)

Returns true if the algorithm ID already exists

Parameters:

id - The info ID

Returns:

If true, the ID exists

getEventBus

public EventBus getEventBus()

Returns the event bus that posts registration events

Returns:

Event bus instance

installEvents

public void installEvents()

Install registration events. This method is only used internally.

onDatatypeRegistered

public void onDatatypeRegistered(JIPipe.DatatypeRegisteredEvent event)

Triggered when a datatype was registered. Attempts to register more algorithms.

Parameters:

event - Generated event

getSourceOf

public JIPipeDependency getSourceOf(String algorithmId)

Returns the source of a registered algorithm

Parameters:

algorithmId - The algorithm info ID

Returns:

The dependency that registered the algorithm

getDeclaredBy

public Set<JIPipeNodeInfo> getDeclaredBy(JIPipeDependency dependency)

Gets all algorithms declared by the dependency

Parameters:

dependency - The dependency

Returns:

All algorithms that were registered by this dependency

reportValidity

public 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

getRegisteredCategories

public ImmutableBiMap<String,JIPipeNodeTypeCategory> getRegisteredCategories()

registerIcon

public void registerIcon(JIPipeNodeInfo info,
                         URL resourcePath)

Registers a custom icon for a node

Parameters:

info - the node type

resourcePath - icon url

registerExample

public void registerExample(JIPipeNodeTemplate nodeTemplate)

Registers a node template as example Will reject

Parameters:

nodeTemplate - the node template that contains the node example

getIconURLFor

public URL getIconURLFor(JIPipeNodeInfo info)

Returns the icon resource path URL for a node

Parameters:

info - node type

Returns:

icon url

getIconFor

public ImageIcon getIconFor(JIPipeNodeInfo info)

Returns the icon for a node

Parameters:

info - node type

Returns:

icon instance

getNodeExamples

public Collection<JIPipeNodeExample> getNodeExamples(String nodeTypeId)

getNodeInfosFromClass

public Set<JIPipeNodeInfo> getNodeInfosFromClass(Class<? extends JIPipeGraphNode> klass)

Returns all node infos that create a node of the specified class

Parameters:

klass - the class

Returns:

node infos

getRegisteredNodeClasses

public Multimap<Class<? extends JIPipeGraphNode>,JIPipeNodeInfo> getRegisteredNodeClasses()

unregister

public void unregister(String id)

Removes a node from the registry

Parameters:

id - the node id

getJIPipe

public JIPipe getJIPipe()

scheduleRegisterExample

public void scheduleRegisterExample(JIPipeNodeTemplate template)

executeScheduledRegisterExamples

public void executeScheduledRegisterExamples()