org.hkijena.jipipe.api.nodes

Class JIPipeMutableNodeInfo

java.lang.Object

org.hkijena.jipipe.api.nodes.JIPipeMutableNodeInfo

All Implemented Interfaces:

JIPipeNodeInfo

Direct Known Subclasses:

JIPipeJavaNodeInfo

public abstract class JIPipeMutableNodeInfo
extends Object
implements JIPipeNodeInfo

Instantiates JIPipeGraphNode instances

Constructor Summary

Constructors

Constructor and Description
JIPipeMutableNodeInfo()

Method Summary

Modifier and Type	Method and Description
List<String>	getAdditionalCitations() Returns a list of additional citations
List<JIPipeNodeMenuLocation>	getAliases() A list of alternative menu locations
JIPipeNodeTypeCategory	getCategory() Returns the algorithm category
HTMLText	getDescription() Returns the algorithm description
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.
boolean	isHidden() Returns true if this algorithm should not appear in the list of available algorithms.
boolean	isRunnable() Indicates that the node should carry a workload.
void	setAdditionalCitations(List<String> additionalCitations)
void	setAliases(List<JIPipeNodeMenuLocation> aliases)
void	setCategory(JIPipeNodeTypeCategory category) Sets the category
void	setDescription(HTMLText description) Sets the description
void	setHidden(boolean hidden)
void	setId(String id) Sets the ID
void	setInputSlots(List<JIPipeInputSlot> inputSlots) Sets the input slots
void	setMenuPath(String menuPath) Sets the menu path.
void	setName(String name) Sets the name
void	setnodeClass(Class<? extends JIPipeGraphNode> nodeClass) Sets the algorithm class
void	setOutputSlots(List<JIPipeOutputSlot> outputSlots) Sets the output slots
void	setRunnable(boolean runnable)

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

duplicate, getDependencies, getIcon, getIconURL, getPrimaryMenuLocation, getSortedList, groupByMenuPaths, hasInputSlot, hasOutputSlot, newInstance

Constructor Detail

JIPipeMutableNodeInfo

public JIPipeMutableNodeInfo()

Method Detail

getInstanceClass

public Class<? extends JIPipeGraphNode> getInstanceClass()

Description copied from interface: JIPipeNodeInfo

The algorithm class that is generated

Specified by:

getInstanceClass in interface JIPipeNodeInfo

Returns:

The algorithm class

setnodeClass

public void setnodeClass(Class<? extends JIPipeGraphNode> nodeClass)

Sets the algorithm class

Parameters:

nodeClass - The algorithm class

getName

public String getName()

Description copied from interface: JIPipeNodeInfo

Returns the algorithm name

Specified by:

getName in interface JIPipeNodeInfo

Returns:

The name

setName

public void setName(String name)

Sets the name

Parameters:

name - The name

getDescription

public HTMLText getDescription()

Description copied from interface: JIPipeNodeInfo

Returns the algorithm description

Specified by:

getDescription in interface JIPipeNodeInfo

Returns:

The description

setDescription

public void setDescription(HTMLText description)

Sets the description

Parameters:

description - The description

getCategory

public JIPipeNodeTypeCategory getCategory()

Description copied from interface: JIPipeNodeInfo

Returns the algorithm category

Specified by:

getCategory in interface JIPipeNodeInfo

Returns:

The category

setCategory

public void setCategory(JIPipeNodeTypeCategory category)

Sets the category

Parameters:

category - The category

getInputSlots

public List<JIPipeInputSlot> getInputSlots()

Description copied from interface: JIPipeNodeInfo

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

Specified by:

getInputSlots in interface JIPipeNodeInfo

Returns:

List of input slots

setInputSlots

public void setInputSlots(List<JIPipeInputSlot> inputSlots)

Sets the input slots

Parameters:

inputSlots - Input slots

getOutputSlots

public List<JIPipeOutputSlot> getOutputSlots()

Description copied from interface: JIPipeNodeInfo

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

Specified by:

getOutputSlots in interface JIPipeNodeInfo

Returns:

List of output slots

setOutputSlots

public void setOutputSlots(List<JIPipeOutputSlot> outputSlots)

Sets the output slots

Parameters:

outputSlots - Output slots

getId

public String getId()

Description copied from interface: JIPipeNodeInfo

Generates an Id for this info

Specified by:

getId in interface JIPipeNodeInfo

Returns:

The ID

setId

public void setId(String id)

Sets the ID

Parameters:

id - A unique ID

getMenuPath

public String getMenuPath()

Description copied from interface: JIPipeNodeInfo

Gets the menu path of this algorithm

Specified by:

getMenuPath in interface JIPipeNodeInfo

Returns:

String containing menu entries separated by new-lines

setMenuPath

public void setMenuPath(String menuPath)

Sets the menu path. Menu items are separated by newlines

Parameters:

menuPath - The menu path

isHidden

public boolean isHidden()

Description copied from interface: JIPipeNodeInfo

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

Specified by:

isHidden in interface JIPipeNodeInfo

Returns:

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

setHidden

public void setHidden(boolean hidden)

isRunnable

public boolean isRunnable()

Description copied from interface: JIPipeNodeInfo

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

Specified by:

isRunnable in interface JIPipeNodeInfo

Returns:

if the node carries a workload

setRunnable

public void setRunnable(boolean runnable)

getAdditionalCitations

public List<String> getAdditionalCitations()

Description copied from interface: JIPipeNodeInfo

Returns a list of additional citations

Specified by:

getAdditionalCitations in interface JIPipeNodeInfo

Returns:

additonal citations

setAdditionalCitations

public void setAdditionalCitations(List<String> additionalCitations)

getAliases

public List<JIPipeNodeMenuLocation> getAliases()

Description copied from interface: JIPipeNodeInfo

A list of alternative menu locations

Specified by:

getAliases in interface JIPipeNodeInfo

Returns:

alternative menu locations. might be empty.

setAliases

public void setAliases(List<JIPipeNodeMenuLocation> aliases)