org.hkijena.jipipe.api.grouping.parameters

Class GraphNodeParameterReference

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.grouping.parameters.GraphNodeParameterReference

All Implemented Interfaces:

JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener

public class GraphNodeParameterReference
extends AbstractJIPipeParameterCollection

References a parameter in a graph

Nested Class Summary

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

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Constructor Summary

Constructors

Constructor and Description
GraphNodeParameterReference() Creates a new empty instance
GraphNodeParameterReference(GraphNodeParameterReference other) Creates a copy
GraphNodeParameterReference(JIPipeParameterAccess access, JIPipeParameterTree tree) Instantiates with an existing access within a tree

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
HTMLText	getCustomDescription()
String	getCustomName()
String	getDescription(JIPipeParameterTree tree) Gets the name or custom name.
String	getName(JIPipeParameterTree tree) Gets the name or custom name
String	getOriginalName(JIPipeParameterTree tree) Gets the name in the original graph Returns null if resolve() is unsuccessful
String	getPath()
int	hashCode()
JIPipeParameterAccess	resolve(JIPipeParameterTree tree) Tries to resolve the path
void	setCustomDescription(HTMLText customDescription)
void	setCustomName(String customName)
void	setPath(String path)

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Constructor Detail

GraphNodeParameterReference

public GraphNodeParameterReference()

Creates a new empty instance

GraphNodeParameterReference

public GraphNodeParameterReference(GraphNodeParameterReference other)

Creates a copy

Parameters:

other - the original

GraphNodeParameterReference

public GraphNodeParameterReference(JIPipeParameterAccess access,
                                   JIPipeParameterTree tree)

Instantiates with an existing access within a tree

Parameters:

access - the access

tree - the tree

Method Detail

getOriginalName

public String getOriginalName(JIPipeParameterTree tree)

Gets the name in the original graph Returns null if resolve() is unsuccessful

Parameters:

tree - the tree

Returns:

name

getName

public String getName(JIPipeParameterTree tree)

Gets the name or custom name

Parameters:

tree - the tree

Returns:

name or custom name

getDescription

public String getDescription(JIPipeParameterTree tree)

Gets the name or custom name. Returns null if resolve() is unsuccessful and no custom description is set

Parameters:

tree - the tree

Returns:

name or custom name

resolve

public JIPipeParameterAccess resolve(JIPipeParameterTree tree)

Tries to resolve the path

Parameters:

tree - the tree

Returns:

the parameter access or null if it does not exist

getCustomName

public String getCustomName()

setCustomName

public void setCustomName(String customName)

getCustomDescription

public HTMLText getCustomDescription()

setCustomDescription

public void setCustomDescription(HTMLText customDescription)

getPath

public String getPath()

setPath

public void setPath(String path)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object