org.hkijena.jipipe.api.nodes

Interface JIPipeNodeInfo

All Known Implementing Classes:

CLIJCommandNodeInfo, CreateSpotDetectorNodeInfo, CreateSpotTrackerNodeInfo, ImageJ2OpNodeInfo, JIPipeEmptyNodeInfo, JIPipeJavaNodeInfo, JIPipeMutableNodeInfo, JsonNodeInfo, PlotTables2AlgorithmInfo

public interface JIPipeNodeInfo

Describes an JIPipeGraphNode

Method Summary

Modifier and Type	Method and Description
JIPipeGraphNode	duplicate(JIPipeGraphNode algorithm) Copies an existing algorithm instance
default List<String>	getAdditionalCitations() Returns a list of additional citations
default List<JIPipeNodeMenuLocation>	getAliases() A list of alternative menu locations
JIPipeNodeTypeCategory	getCategory() Returns the algorithm category
Set<JIPipeDependency>	getDependencies() Returns all dependencies
HTMLText	getDescription() Returns the algorithm description
default Icon	getIcon() Gets the icon for this node info
default URL	getIconURL() Gets the icon for this node info
String	getId() Generates an Id for this info
List<JIPipeInputSlot>	getInputSlots() Returns general input data.
Class<? extends JIPipeGraphNode>	getInstanceClass() The algorithm class that is generated
String	getMenuPath() Gets the menu path of this algorithm
String	getName() Returns the algorithm name
List<JIPipeOutputSlot>	getOutputSlots() Returns general output data.
default JIPipeNodeMenuLocation	getPrimaryMenuLocation() A menu location that points towards the primary menu
static List<JIPipeNodeInfo>	getSortedList(Set<JIPipeNodeInfo> entries) Gets a sorted list of algorithms
static Map<String,Set<JIPipeNodeInfo>>	groupByMenuPaths(JIPipeNodeTypeCategory category, Set<JIPipeNodeInfo> infos) Gets the registered algorithms, grouped by their menu paths
default boolean	hasInputSlot(String slotName) If the current node info contains a slot with given name
default boolean	hasOutputSlot(String slotName) If the current node info contains a slot with given name
boolean	isHidden() Returns true if this algorithm should not appear in the list of available algorithms.
default boolean	isRunnable() Indicates that the node should carry a workload.
JIPipeGraphNode	newInstance() Creates a new node type instance

Method Detail

groupByMenuPaths

static Map<String,Set<JIPipeNodeInfo>> groupByMenuPaths(JIPipeNodeTypeCategory category,
                                                        Set<JIPipeNodeInfo> infos)

Gets the registered algorithms, grouped by their menu paths

Parameters:

category - the targeted category

infos - The infos to group

Returns:

Map from menu path to algorithms with this menu path

getSortedList

static List<JIPipeNodeInfo> getSortedList(Set<JIPipeNodeInfo> entries)

Gets a sorted list of algorithms

Parameters:

entries - the algorithms to sort

Returns:

sorted list

getId

String getId()

Generates an Id for this info

Returns:

The ID

getInstanceClass

Class<? extends JIPipeGraphNode> getInstanceClass()

The algorithm class that is generated

Returns:

The algorithm class

newInstance

JIPipeGraphNode newInstance()

Creates a new node type instance

Returns:

Algorithm instance

duplicate

JIPipeGraphNode duplicate(JIPipeGraphNode algorithm)

Copies an existing algorithm instance

Parameters:

algorithm - Original algorithm instance

Returns:

Copied algorithm instance

getName

String getName()

Returns the algorithm name

Returns:

The name

getDescription

HTMLText getDescription()

Returns the algorithm description

Returns:

The description

getMenuPath

String getMenuPath()

Gets the menu path of this algorithm

Returns:

String containing menu entries separated by new-lines

getCategory

JIPipeNodeTypeCategory getCategory()

Returns the algorithm category

Returns:

The category

getInputSlots

List<JIPipeInputSlot> getInputSlots()

Returns general input data. Instances can have a configuration that is different from this configuration.

Returns:

List of input slots

getOutputSlots

List<JIPipeOutputSlot> getOutputSlots()

Returns general output data. Instances can have a configuration that is different from this configuration.

Returns:

List of output slots

hasInputSlot

default boolean hasInputSlot(String slotName)

If the current node info contains a slot with given name

Parameters:

slotName - the slot name

Returns:

if there is an input slot with the name

hasOutputSlot

default boolean hasOutputSlot(String slotName)

If the current node info contains a slot with given name

Parameters:

slotName - the slot name

Returns:

if there is an input slot with the name

getDependencies

Set<JIPipeDependency> getDependencies()

Returns all dependencies

Returns:

List of dependencies

getAdditionalCitations

default List<String> getAdditionalCitations()

Returns a list of additional citations

Returns:

additonal citations

isHidden

boolean isHidden()

Returns true if this algorithm should not appear in the list of available algorithms. This is useful if it is a structural algorithm

Returns:

if this algorithm should not appear in the list of available algorithms

isRunnable

default boolean isRunnable()

Indicates that the node should carry a workload. Defaults to true.

Returns:

if the node carries a workload

getIcon

default Icon getIcon()

Gets the icon for this node info

Returns:

the icon

getIconURL

default URL getIconURL()

Gets the icon for this node info

Returns:

the icon

getPrimaryMenuLocation

default JIPipeNodeMenuLocation getPrimaryMenuLocation()

A menu location that points towards the primary menu

Returns:

the primary menu location

getAliases

default List<JIPipeNodeMenuLocation> getAliases()

A list of alternative menu locations

Returns:

alternative menu locations. might be empty.