org.hkijena.jipipe.api.grouping

Class JsonNodeInfo

java.lang.Object

org.hkijena.jipipe.api.grouping.JsonNodeInfo

All Implemented Interfaces:

JIPipeValidatable, JIPipeNodeInfo, JIPipeParameterCollection

public class JsonNodeInfo
extends Object
implements JIPipeNodeInfo, JIPipeValidatable, JIPipeParameterCollection

Info of a GraphWrapperAlgorithm

Nested Class Summary

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Constructor Summary

Constructors

Constructor and Description
JsonNodeInfo() Creates a new info
JsonNodeInfo(NodeGroup group) Creates a new JsonNodeInfo from a NodeGroup

Method Summary

Modifier and Type	Method and Description
JIPipeGraphNode	duplicate(JIPipeGraphNode algorithm) Copies an existing algorithm instance
Map<String,JIPipeParameterAccess>	getAvailableParameters() Gets the available parameters in the graph
JIPipeNodeTypeCategory	getCategory() Returns the algorithm category
DynamicCategoryEnumParameter	getCategoryParameter()
IconRef	getCustomIcon()
Set<JIPipeDependency>	getDependencies() Returns all dependencies
HTMLText	getDescription() Returns the algorithm description
EventBus	getEventBus() Gets the event bus that posts events about the parameters
GraphNodeParameterReferenceGroupCollection	getExportedParameters()
Map<JIPipeDataSlot,String>	getExportedSlotNames()
JIPipeGraph	getGraph()
GraphWrapperAlgorithmInput	getGroupInput() Gets the graphs's input node
GraphWrapperAlgorithmOutput	getGroupOutput() Gets the graphs's output node
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
StringList	getMenuPathList()
String	getName() Returns the algorithm name
List<JIPipeOutputSlot>	getOutputSlots() Returns general output data.
String	getProjectType()
boolean	isHidden() Returns true if this algorithm should not appear in the list of available algorithms.
JIPipeGraphNode	newInstance() Creates a new node type instance
void	onGraphChanged(JIPipeGraph.GraphChangedEvent event) Triggered when the wrapped graph changed
void	onGraphParameterStructureChanged(JIPipeParameterCollection.ParameterStructureChangedEvent event) Triggered when the parameter structure of an algorithm is changed Updates the list of available parameters
void	reportValidity(JIPipeIssueReport report) Generates a validity report
void	setCategoryParameter(DynamicCategoryEnumParameter parameter)
void	setCustomIcon(IconRef customIcon)
void	setDescription(HTMLText description)
void	setExportedParameters(GraphNodeParameterReferenceGroupCollection exportedParameters)
void	setGraph(JIPipeGraph graph)
void	setHidden(boolean hidden)
void	setId(String id)
void	setMenuPath(String value)
void	setMenuPathList(StringList value)
void	setName(String name)

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

getAdditionalCitations, getAliases, getIcon, getIconURL, getPrimaryMenuLocation, getSortedList, groupByMenuPaths, hasInputSlot, hasOutputSlot, isRunnable

Methods inherited from interface org.hkijena.jipipe.api.JIPipeValidatable

generateValidityReport

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, isParameterUIVisible, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Constructor Detail

JsonNodeInfo

public JsonNodeInfo()

Creates a new info

JsonNodeInfo

public JsonNodeInfo(NodeGroup group)

Creates a new JsonNodeInfo from a NodeGroup

Parameters:

group - the node group. The graph will NOT be copied.

Method Detail

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)

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

newInstance

public JIPipeGraphNode newInstance()

Description copied from interface: JIPipeNodeInfo

Creates a new node type instance

Specified by:

newInstance in interface JIPipeNodeInfo

Returns:

Algorithm instance

duplicate

public JIPipeGraphNode duplicate(JIPipeGraphNode algorithm)

Description copied from interface: JIPipeNodeInfo

Copies an existing algorithm instance

Specified by:

duplicate in interface JIPipeNodeInfo

Parameters:

algorithm - Original algorithm instance

Returns:

Copied algorithm instance

getExportedSlotNames

public Map<JIPipeDataSlot,String> getExportedSlotNames()

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)

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)

getCategory

public JIPipeNodeTypeCategory getCategory()

Description copied from interface: JIPipeNodeInfo

Returns the algorithm category

Specified by:

getCategory in interface JIPipeNodeInfo

Returns:

The category

getCategoryParameter

public DynamicCategoryEnumParameter getCategoryParameter()

setCategoryParameter

public void setCategoryParameter(DynamicCategoryEnumParameter parameter)

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

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

getDependencies

public Set<JIPipeDependency> getDependencies()

Description copied from interface: JIPipeNodeInfo

Returns all dependencies

Specified by:

getDependencies in interface JIPipeNodeInfo

Returns:

List of dependencies

getGraph

public JIPipeGraph getGraph()

setGraph

public void setGraph(JIPipeGraph graph)

getExportedParameters

public GraphNodeParameterReferenceGroupCollection getExportedParameters()

setExportedParameters

public void setExportedParameters(GraphNodeParameterReferenceGroupCollection exportedParameters)

onGraphChanged

public void onGraphChanged(JIPipeGraph.GraphChangedEvent event)

Triggered when the wrapped graph changed

Parameters:

event - generated event

onGraphParameterStructureChanged

public void onGraphParameterStructureChanged(JIPipeParameterCollection.ParameterStructureChangedEvent event)

Triggered when the parameter structure of an algorithm is changed Updates the list of available parameters

Parameters:

event - generated event

getGroupInput

public GraphWrapperAlgorithmInput getGroupInput()

Gets the graphs's input node

Returns:

the graph's input node

getGroupOutput

public GraphWrapperAlgorithmOutput getGroupOutput()

Gets the graphs's output node

Returns:

the graph's output node

getAvailableParameters

public Map<String,JIPipeParameterAccess> getAvailableParameters()

Gets the available parameters in the graph

Returns:

the parameters

getProjectType

public String getProjectType()

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

getEventBus

public EventBus getEventBus()

Description copied from interface: JIPipeParameterCollection

Gets the event bus that posts events about the parameters

Specified by:

getEventBus in interface JIPipeParameterCollection

Returns:

The event bus triggering JIPipeParameterCollection.ParameterChangedEvent and JIPipeParameterCollection.ParameterStructureChangedEvent

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 value)

getMenuPathList

public StringList getMenuPathList()

setMenuPathList

public void setMenuPathList(StringList value)

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)

getCustomIcon

public IconRef getCustomIcon()

setCustomIcon

public void setCustomIcon(IconRef customIcon)