JIPipeGraphNode (jipipe 1.76.1-SNAPSHOT API)

java.lang.Object
- org.hkijena.jipipe.api.nodes.JIPipeGraphNode

All Implemented Interfaces:

JIPipeValidatable, JIPipeParameterCollection

Direct Known Subclasses:

JIPipeAlgorithm, JIPipeCommentNode, JIPipeProjectCompartment
```
public abstract class JIPipeGraphNode
extends Object
implements JIPipeValidatable, JIPipeParameterCollection
```
A node is a set of input and output data slots, and a run() function It is part of the JIPipeGraph. The workload of this node is considered optional (this means it can have an empty workload), which is important for structural graphs like the compartment graph. Use JIPipeAlgorithm as base class to indicate a non-optional workload.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JIPipeGraphNode.BaseDirectoryChangedEvent` Triggered when the base directory of a project or algorithm was changed
`static class`	`JIPipeGraphNode.Serializer` Serializes an `JIPipeGraphNode` instance

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection
JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Constructor Summary

Constructors
Constructor and Description
`JIPipeGraphNode(JIPipeGraphNode other)` Copies the input algorithm's properties into this algorithm
`JIPipeGraphNode(JIPipeNodeInfo info)` Initializes a new node type instance
`JIPipeGraphNode(JIPipeNodeInfo info, JIPipeSlotConfiguration slotConfiguration)` Initializes this algorithm with a custom provided slot configuration

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canUserDelete()` Returns true if a user can delete this algorithm
`void`	`clearLocations()` Removes all location information added via setLocationWithin()
`void`	`clearSlotData()` Clears all data slots
`protected JIPipeSlotConfiguration`	`copySlotConfiguration(JIPipeGraphNode other)` Copies the slot configuration from the other algorithm to this algorithm Override this method for special configuration cases
`JIPipeGraphNode`	`duplicate()` Copies the algorithm.
`void`	`fromJson(com.fasterxml.jackson.databind.JsonNode node, JIPipeIssueReport issues, JIPipeNotificationInbox notifications)` Loads this algorithm from JSON Please do not override this method if absolutely necessary.
`static <T extends JIPipeGraphNode> T`	`fromJsonNode(com.fasterxml.jackson.databind.JsonNode node, JIPipeIssueReport issues, JIPipeNotificationInbox notifications)`
`String`	`getAliasIdInParentGraph()` Returns the alias ID of this node.
`Path`	`getBaseDirectory()` Returns the current work directory of this algorithm.
`JIPipeNodeTypeCategory`	`getCategory()` Gets the algorithm category
`String`	`getCompartmentDisplayName()` Returns a display name for the compartment
`String`	`getCompartmentUUIDInGraphAsString()` Returns the compartment UUID in the graph as string.
`UUID`	`getCompartmentUUIDInParentGraph()` Returns the compartment UUID within the current graph.
`HTMLText`	`getCustomDescription()` Returns the custom description that is set by the user
`List<JIPipeInputDataSlot>`	`getDataInputSlots()` Method that can be overwritten by child classes.
`Set<JIPipeDependency>`	`getDependencies()` Returns a list of all dependencies this algorithm currently has.
`String`	`getDisplayName()` Returns a name that provides human-readable information about the name and compartment
`EventBus`	`getEventBus()` Gets the event bus that posts events about the parameters
`JIPipeInputDataSlot`	`getFirstInputSlot()` Returns the first input slot according to the slot order.
`JIPipeOutputDataSlot`	`getFirstOutputSlot()` Returns the first output slot according to the slot order.
`JIPipeNodeInfo`	`getInfo()` Returns the `JIPipeNodeInfo` that describes this algorithm
`JIPipeInputDataSlot`	`getInputSlot(String name)` Returns the input slot with the specified name.
`Map<String,JIPipeDataSlot>`	`getInputSlotMap()` Gets all input slot instances
`List<String>`	`getInputSlotOrder()` Gets the input slot order
`List<JIPipeInputDataSlot>`	`getInputSlots()` Returns all input slots ordered by the slot order
`List<JIPipeInputDataSlot>`	`getInputSlotsWithRole(JIPipeDataSlotRole role)` Gets all input slots that have the specified role
`Path`	`getInternalStoragePath()` Returns the internal storage path relative to the output folder.
`JIPipeInputDataSlot`	`getLastInputSlot()` Returns the last input slot according to the slot order.
`JIPipeOutputDataSlot`	`getLastOutputSlot()` Returns the last output slot according to the slot order.
`Map<String,Map<String,Point>>`	`getLocations()` Gets the location map (writable) as map from compartment UUID to visual mode to location
`Point`	`getLocationWithin(String compartment, String visualMode)` Returns the location within the specified compartment or null if none is set
`String`	`getName()` Returns the algorithm name
`Path`	`getNewScratch()` Returns a new scratch directory that is unique and based on the alias ID of this node
`List<JIPipeInputDataSlot>`	`getOpenInputSlots()` Returns all input slots that do not have data set.
`JIPipeDataSlot`	`getOutputSlot(String name)` Returns the output slot with the specified name.
`Map<String,JIPipeDataSlot>`	`getOutputSlotMap()` Gets all output slot instances
`List<JIPipeOutputDataSlot>`	`getOutputSlots()` Returns all output slots ordered by the slot order
`List<JIPipeOutputDataSlot>`	`getOutputSlotsWithRole(JIPipeDataSlotRole role)` Gets all input slots that have the specified role
`JIPipeGraph`	`getParentGraph()` Returns the graph this algorithm is located in.
`JIPipeProjectCompartment`	`getProjectCompartment()` Gets the project compartment instance of this node.
`Path`	`getProjectDirectory()` Returns the current project directory.
`Path`	`getScratchBaseDirectory()` Gets the scratch directory of the current run associated to this algorithm.
`JIPipeSlotConfiguration`	`getSlotConfiguration()` Gets the slot configuration
`Path`	`getStoragePath()` The storage path is used in `JIPipeProjectRun` to indicate where output data is written This is only used internally
`UUID`	`getUUIDInParentGraph()` Returns the UUID within the current graph.
`boolean`	`hasInputSlot(String slotName)` Returns true if the algorithm contains an input slot with given name.
`boolean`	`hasOutputSlot(String slotName)` Returns true if the algorithm contains an output slot with given name.
`boolean`	`isBookmarked()`
`boolean`	`isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterAccess access)` Allows to override the visibility of parameters inside the UI
`boolean`	`isVisibleIn(UUID compartmentUUIDInGraph)`
`protected void`	`onDeserialized(com.fasterxml.jackson.databind.JsonNode node, JIPipeIssueReport issues, JIPipeNotificationInbox notifications)` Override this method to add operations to be run after deserialization from JSON
`void`	`onParameterChanged(JIPipeParameterCollection.ParameterChangedEvent event)` Triggered when a parameter is changed within the slot configuration.
`void`	`onParameterStructureChanged(JIPipeParameterCollection.ParameterStructureChangedEvent event)` Triggered when the parameter structure of this algorithm was changed
`void`	`onParameterUIChanged(JIPipeParameterCollection.ParameterUIChangedEvent event)` Triggered when the parameter UI structure of this algorithm was changed
`void`	`onSlotConfigurationChanged(JIPipeSlotConfiguration.SlotsChangedEvent event)` Should be triggered when a slot is added to the slot configuration
`void`	`onSlotConnected(JIPipeGraph.NodeConnectedEvent event)` Called by an `JIPipeGraph` when a slot was connected.
`void`	`onSlotDisconnected(JIPipeGraph.NodeDisconnectedEvent event)` Called by the `JIPipeGraph` to trigger slot inheritance updates when a slot is disconnected
`void`	`registerSubParameter(JIPipeParameterCollection subParameter)` Registers a sub-parameter instance to pass `ParameterStructureChangedEvent` via this algorithm's `EventBus`
`boolean`	`renderInputSlots()` Controls whether to render input slots.
`boolean`	`renderOutputSlots()` Controls whether to render output slots.
`abstract void`	`run(JIPipeProgressInfo progressInfo)` Runs the workload
`void`	`setAllSlotsVirtual(boolean virtual, boolean apply, JIPipeProgressInfo progressInfo)` Sets/unsets virtual mode for all output slots
`void`	`setBaseDirectory(Path baseDirectory)` Sets the current work directory of this algorithm.
`void`	`setBookmarked(boolean bookmarked)`
`void`	`setCustomDescription(HTMLText customDescription)` Sets a custom description.
`void`	`setCustomName(String customName)` Sets a custom name.
`void`	`setInfo(JIPipeNodeInfo info)` Sets the `JIPipeNodeInfo` that describes this algorithm.
`void`	`setInternalStoragePath(Path internalStoragePath)` Sets the internal storage path relative to the output folder.
`void`	`setLocations(Map<String,Map<String,Point>> locations)` Sets the location map.
`void`	`setLocationWithin(String compartment, Point location, String visualMode)` Sets the UI location of this algorithm within the specified compartment
`void`	`setLocationWithin(UUID compartment, Point location, String visualMode)` Sets the UI location of this algorithm within the specified compartment
`void`	`setParentGraph(JIPipeGraph parentGraph)` Sets the graph this algorithm is location in.
`void`	`setProjectDirectory(Path projectDirectory)` Sets the project directory.
`void`	`setScratchBaseDirectory(Path scratchBaseDirectory)` Sets the scratch base directory of the current run.
`void`	`setSlotConfiguration(JIPipeSlotConfiguration slotConfiguration)`
`void`	`setStoragePath(Path storagePath)` Sets the storage path.
`void`	`toggleSlot(JIPipeDataSlotInfo info, boolean toggle)` Toggles a slot with given info on/off.
`void`	`toJson(com.fasterxml.jackson.core.JsonGenerator jsonGenerator)` Saves this algorithm to JSON.
`void`	`triggerSlotsChangedEvent()` Triggers an event that indicates that the slots have changed
`void`	`updateGraphNodeSlots()` Synchronizes the slots with the slot definition
`void`	`updateSlotInheritance()` Updates the inheritance: Passes traits from input slots to output slots while modifying the results depending on the trait configuration.

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, reportValidity

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection
addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

- Constructor Detail
  - JIPipeGraphNode
```
public JIPipeGraphNode(JIPipeNodeInfo info,
                       JIPipeSlotConfiguration slotConfiguration)
```
    Initializes this algorithm with a custom provided slot configuration
    
    Parameters:
    
    info - Contains algorithm metadata
    
    slotConfiguration - if null, generate the slot configuration automatically. Prefers the creation of slots via annotations. Alternatively, slots can also be created via the node info
  - JIPipeGraphNode
```
public JIPipeGraphNode(JIPipeNodeInfo info)
```
    Initializes a new node type instance
    
    Parameters:
    
    info - The algorithm info
  - JIPipeGraphNode
```
public JIPipeGraphNode(JIPipeGraphNode other)
```
    Copies the input algorithm's properties into this algorithm
    
    Parameters:
    
    other - Copied algorithm
- Method Detail
  - fromJsonNode
```
public static <T extends JIPipeGraphNode> T fromJsonNode(com.fasterxml.jackson.databind.JsonNode node,
                                                         JIPipeIssueReport issues,
                                                         JIPipeNotificationInbox notifications)
```
  - updateGraphNodeSlots
```
public void updateGraphNodeSlots()
```
    Synchronizes the slots with the slot definition
  - copySlotConfiguration
```
protected JIPipeSlotConfiguration copySlotConfiguration(JIPipeGraphNode other)
```
    Copies the slot configuration from the other algorithm to this algorithm Override this method for special configuration cases
    
    Parameters:
    
    other - Copied slot configuration
    
    Returns:
    
    Copy
  - run
```
public abstract void run(JIPipeProgressInfo progressInfo)
```
    Runs the workload
    
    Parameters:
    
    progressInfo - progress passed from the runner
  - 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
  - getName
```
public String getName()
```
    Returns the algorithm name
    
    Returns:
    
    algorithm name
  - setCustomName
```
public void setCustomName(String customName)
```
    Sets a custom name. If set to null, the standard algorithm name is automatically used by getName()
    
    Parameters:
    
    customName - custom name
  - isParameterUIVisible
```
public boolean isParameterUIVisible(JIPipeParameterTree tree,
                                    JIPipeParameterAccess access)
```
    Description copied from interface: JIPipeParameterCollection
    
    Allows to override the visibility of parameters inside the UI
    
    Specified by:
    
    isParameterUIVisible in interface JIPipeParameterCollection
    
    Parameters:
    
    tree - the parameter tree that is used to access this parameter
    
    access - the parameter
    
    Returns:
    
    if the parameter is visible inside the UI
  - isBookmarked
```
public boolean isBookmarked()
```
  - setBookmarked
```
public void setBookmarked(boolean bookmarked)
```
  - getCategory
```
public JIPipeNodeTypeCategory getCategory()
```
    Gets the algorithm category
    
    Returns:
    
    The category
  - getSlotConfiguration
```
public JIPipeSlotConfiguration getSlotConfiguration()
```
    Gets the slot configuration
    
    Returns:
    
    Slot configuration
  - setSlotConfiguration
```
public void setSlotConfiguration(JIPipeSlotConfiguration slotConfiguration)
```
  - getInputSlotMap
```
public Map<String,JIPipeDataSlot> getInputSlotMap()
```
    Gets all input slot instances
    
    Returns:
    
    Current algorithm slots
  - getOutputSlotMap
```
public Map<String,JIPipeDataSlot> getOutputSlotMap()
```
    Gets all output slot instances
    
    Returns:
    
    Current algorithm slots
  - getInputSlotOrder
```
public List<String> getInputSlotOrder()
```
    Gets the input slot order
    
    Returns:
    
    List of slot names
  - getInputSlots
```
public List<JIPipeInputDataSlot> getInputSlots()
```
    Returns all input slots ordered by the slot order
    
    Returns:
    
    List of slots
  - getDataInputSlots
```
public List<JIPipeInputDataSlot> getDataInputSlots()
```
    Method that can be overwritten by child classes. Should return slots that are actually used as data input.
    
    Returns:
    
    Input slots
  - getOutputSlots
```
public List<JIPipeOutputDataSlot> getOutputSlots()
```
    Returns all output slots ordered by the slot order
    
    Returns:
    
    List of slots
  - onParameterChanged
```
public void onParameterChanged(JIPipeParameterCollection.ParameterChangedEvent event)
```
    Triggered when a parameter is changed within the slot configuration. Triggers a JIPipeGraph.NodeSlotsChangedEvent
    
    Parameters:
    
    event - generated event
  - onSlotConfigurationChanged
```
public void onSlotConfigurationChanged(JIPipeSlotConfiguration.SlotsChangedEvent event)
```
    Should be triggered when a slot is added to the slot configuration
    
    Parameters:
    
    event - The event
  - getLocations
```
public Map<String,Map<String,Point>> getLocations()
```
    Gets the location map (writable) as map from compartment UUID to visual mode to location
    
    Returns:
    
    map from compartment UUID to visual mode to location
  - setLocations
```
public void setLocations(Map<String,Map<String,Point>> locations)
```
    Sets the location map.
    
    Parameters:
    
    locations - map from compartment UUID to visual mode to location
  - getLocationWithin
```
public Point getLocationWithin(String compartment,
                               String visualMode)
```
    Returns the location within the specified compartment or null if none is set
    
    Parameters:
    
    compartment - The compartment ID. Set to empty string for no compartment.
    
    visualMode - Used to differentiate between different visual modes
    
    Returns:
    
    The UI location or null if unset
  - setLocationWithin
```
public void setLocationWithin(String compartment,
                              Point location,
                              String visualMode)
```
    Sets the UI location of this algorithm within the specified compartment
    
    Parameters:
    
    compartment - The compartment ID. Set to empty string for no compartment.
    
    location - The UI location. Can be null to reset the location
    
    visualMode - Used to differentiate between different visual modes
  - setLocationWithin
```
public void setLocationWithin(UUID compartment,
                              Point location,
                              String visualMode)
```
    Sets the UI location of this algorithm within the specified compartment
    
    Parameters:
    
    compartment - The compartment ID
    
    location - The UI location. Can be null to reset the location
    
    visualMode - Used to differentiate between different visual modes
  - toJson
```
public void toJson(com.fasterxml.jackson.core.JsonGenerator jsonGenerator)
            throws IOException,
                   com.fasterxml.jackson.core.JsonProcessingException
```
    Saves this algorithm to JSON. Override this method to apply your own modifications
    
    Parameters:
    
    jsonGenerator - the JSON generator
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - thrown by JSON methods
    
    IOException
  - fromJson
```
public void fromJson(com.fasterxml.jackson.databind.JsonNode node,
                     JIPipeIssueReport issues,
                     JIPipeNotificationInbox notifications)
```
    Loads this algorithm from JSON Please do not override this method if absolutely necessary. Use onDeserialized() to add methods after deserialization
    
    Parameters:
    
    node - The JSON data to load from
    
    issues - issues during deserializing. these should be severe issues (missing parameters etc.). if you want to notify the user about potential issues that can be acted upon, use the notification inbox
    
    notifications - additional notifications for the user. these can be acted upon
  - onDeserialized
```
protected void onDeserialized(com.fasterxml.jackson.databind.JsonNode node,
                              JIPipeIssueReport issues,
                              JIPipeNotificationInbox notifications)
```
    Override this method to add operations to be run after deserialization from JSON
    
    Parameters:
    
    node - the JSON node where the data was loaded
    
    issues - issues during deserialization. if you want to notify the user about potential issues that can be acted upon, use the notification inbox
    
    notifications - additional notifications for the user. these can be acted upon
  - getStoragePath
```
public Path getStoragePath()
```
    The storage path is used in JIPipeProjectRun to indicate where output data is written This is only used internally
    
    Returns:
    
    Storage path
  - setStoragePath
```
public void setStoragePath(Path storagePath)
```
    Sets the storage path. Used by JIPipeProjectRun
    
    Parameters:
    
    storagePath - Storage path
  - getInternalStoragePath
```
public Path getInternalStoragePath()
```
    Returns the internal storage path relative to the output folder. Used internally by JIPipeProjectRun
    
    Returns:
    
    Storage path relative to the output folder
  - setInternalStoragePath
```
public void setInternalStoragePath(Path internalStoragePath)
```
    Sets the internal storage path relative to the output folder. Used internally by JIPipeProjectRun
    
    Parameters:
    
    internalStoragePath - Path relative to the output folder
  - getInfo
```
public JIPipeNodeInfo getInfo()
```
    Returns the JIPipeNodeInfo that describes this algorithm
    
    Returns:
    
    The info
  - setInfo
```
public void setInfo(JIPipeNodeInfo info)
```
    Sets the JIPipeNodeInfo that describes this algorithm. Please note that this function can be very dangerous and break everything. This will affect how JIPipe (and especially the UI) handles this algorithm. A use case is to convert algorithms from internal representations to their public variants (e.g. JIPipeCompartmentOutput to IOInterfaceAlgorithm
    
    Parameters:
    
    info - the info
  - getOutputSlot
```
public JIPipeDataSlot getOutputSlot(String name)
```
    Returns the output slot with the specified name. Throws NullPointerException if the slot does not exist and IllegalArgumentException if the slot is not an output
    
    Parameters:
    
    name - Slot name
    
    Returns:
    
    Slot instance
  - getInputSlot
```
public JIPipeInputDataSlot getInputSlot(String name)
```
    Returns the input slot with the specified name. Throws NullPointerException if the slot does not exist and IllegalArgumentException if the slot is not an input
    
    Parameters:
    
    name - Slot name
    
    Returns:
    
    Slot instance
  - getOpenInputSlots
```
public List<JIPipeInputDataSlot> getOpenInputSlots()
```
    Returns all input slots that do not have data set.
    
    Returns:
    
    List of slots
  - getInputSlotsWithRole
```
public List<JIPipeInputDataSlot> getInputSlotsWithRole(JIPipeDataSlotRole role)
```
    Gets all input slots that have the specified role
    
    Parameters:
    
    role - the role
    
    Returns:
    
    the list of input slots with the role. order is according to getInputSlots()
  - getOutputSlotsWithRole
```
public List<JIPipeOutputDataSlot> getOutputSlotsWithRole(JIPipeDataSlotRole role)
```
    Gets all input slots that have the specified role
    
    Parameters:
    
    role - the role
    
    Returns:
    
    the list of input slots with the role. order is according to getOutputSlots()
  - getFirstOutputSlot
```
public JIPipeOutputDataSlot getFirstOutputSlot()
```
    Returns the first output slot according to the slot order. Throws IndexOutOfBoundsException if there is no output slot.
    
    Returns:
    
    Slot instance
  - getFirstInputSlot
```
public JIPipeInputDataSlot getFirstInputSlot()
```
    Returns the first input slot according to the slot order. Throws IndexOutOfBoundsException if there is no input slot.
    
    Returns:
    
    Slot instance
  - getLastOutputSlot
```
public JIPipeOutputDataSlot getLastOutputSlot()
```
    Returns the last output slot according to the slot order. Throws IndexOutOfBoundsException if there is no output slot.
    
    Returns:
    
    Slot instance
  - getLastInputSlot
```
public JIPipeInputDataSlot getLastInputSlot()
```
    Returns the last input slot according to the slot order. Throws IndexOutOfBoundsException if there is no input slot.
    
    Returns:
    
    Slot instance
  - getParentGraph
```
public JIPipeGraph getParentGraph()
```
    Returns the graph this algorithm is located in. Can be null.
    
    Returns:
    
    Graph instance or null
  - setParentGraph
```
public void setParentGraph(JIPipeGraph parentGraph)
```
    Sets the graph this algorithm is location in. This has no side effects and is only for reference usage.
    
    Parameters:
    
    parentGraph - Graph instance or null
  - getUUIDInParentGraph
```
public UUID getUUIDInParentGraph()
```
    Returns the UUID within the current graph. Requires that getGraph() is not null.
    
    Returns:
    
    The UUID within getGraph()
  - getCompartmentUUIDInParentGraph
```
public UUID getCompartmentUUIDInParentGraph()
```
    Returns the compartment UUID within the current graph. Requires that getGraph() is not null.
    
    Returns:
    
    The UUID within getGraph()
  - clearLocations
```
public void clearLocations()
```
    Removes all location information added via setLocationWithin()
  - getCustomDescription
```
public HTMLText getCustomDescription()
```
    Returns the custom description that is set by the user
    
    Returns:
    
    Description or null
  - setCustomDescription
```
public void setCustomDescription(HTMLText customDescription)
```
    Sets a custom description. Can be null.
    
    Parameters:
    
    customDescription - Description string
  - getProjectDirectory
```
public Path getProjectDirectory()
```
    Returns the current project directory.
    
    Returns:
    
    the project directory. Null if none was set.
  - setProjectDirectory
```
public void setProjectDirectory(Path projectDirectory)
```
    Sets the project directory. Can be null.
    
    Parameters:
    
    projectDirectory - the project directory. can be null.
  - getBaseDirectory
```
public Path getBaseDirectory()
```
    Returns the current work directory of this algorithm. This is used internally to allow relative data paths.
    
    Returns:
    
    The current work directory or null.
  - setBaseDirectory
```
public void setBaseDirectory(Path baseDirectory)
```
    Sets the current work directory of this algorithm. This is used internally to allow loading data from relative paths. This triggers a JIPipeGraphNode.BaseDirectoryChangedEvent that can be received by JIPipeDataSlot instances to adapt to the work directory.
    
    Parameters:
    
    baseDirectory - The work directory. Can be null
  - getScratchBaseDirectory
```
public Path getScratchBaseDirectory()
```
    Gets the scratch directory of the current run associated to this algorithm.
    
    Returns:
    
    the scratch base directory
  - setScratchBaseDirectory
```
public void setScratchBaseDirectory(Path scratchBaseDirectory)
```
    Sets the scratch base directory of the current run. Please note that this directory will be propagated to sub-graphs
    
    Parameters:
    
    scratchBaseDirectory - the scratch base directory
  - getNewScratch
```
public Path getNewScratch()
```
    Returns a new scratch directory that is unique and based on the alias ID of this node
    
    Returns:
    
    the scratch directory
  - onSlotConnected
```
public void onSlotConnected(JIPipeGraph.NodeConnectedEvent event)
```
    Called by an JIPipeGraph when a slot was connected. Triggers update of slot inheritance.
    
    Parameters:
    
    event - The event generated by the graph
  - updateSlotInheritance
```
public void updateSlotInheritance()
```
    Updates the inheritance: Passes traits from input slots to output slots while modifying the results depending on the trait configuration.
  - triggerSlotsChangedEvent
```
public void triggerSlotsChangedEvent()
```
    Triggers an event that indicates that the slots have changed
  - onSlotDisconnected
```
public void onSlotDisconnected(JIPipeGraph.NodeDisconnectedEvent event)
```
    Called by the JIPipeGraph to trigger slot inheritance updates when a slot is disconnected
    
    Parameters:
    
    event - The generated event
  - getDependencies
```
public Set<JIPipeDependency> getDependencies()
```
    Returns a list of all dependencies this algorithm currently has.
    
    Returns:
    
    List of dependencies
  - registerSubParameter
```
public void registerSubParameter(JIPipeParameterCollection subParameter)
```
    Registers a sub-parameter instance to pass ParameterStructureChangedEvent via this algorithm's EventBus
    
    Parameters:
    
    subParameter - the sub-parameter
  - onParameterStructureChanged
```
public void onParameterStructureChanged(JIPipeParameterCollection.ParameterStructureChangedEvent event)
```
    Triggered when the parameter structure of this algorithm was changed
    
    Parameters:
    
    event - generated event
  - onParameterUIChanged
```
public void onParameterUIChanged(JIPipeParameterCollection.ParameterUIChangedEvent event)
```
    Triggered when the parameter UI structure of this algorithm was changed
    
    Parameters:
    
    event - generated event
  - clearSlotData
```
public void clearSlotData()
```
    Clears all data slots
  - duplicate
```
public JIPipeGraphNode duplicate()
```
    Copies the algorithm. Produces a deep copy
    
    Returns:
    
    the copy
  - canUserDelete
```
public boolean canUserDelete()
```
    Returns true if a user can delete this algorithm
    
    Returns:
    
    if a user can delete this algorithm
  - hasInputSlot
```
public boolean hasInputSlot(String slotName)
```
    Returns true if the algorithm contains an input slot with given name. Returns false if there is an output slot with given name
    
    Parameters:
    
    slotName - the slot name
    
    Returns:
    
    if the algorithm contains an input slot with given name.
  - hasOutputSlot
```
public boolean hasOutputSlot(String slotName)
```
    Returns true if the algorithm contains an output slot with given name. Returns false if there is an input slot with given name
    
    Parameters:
    
    slotName - the slot name
    
    Returns:
    
    if the algorithm contains an output slot with given name.
  - renderInputSlots
```
public boolean renderInputSlots()
```
    Controls whether to render input slots. If disabled, this achieves the same effect as a compartment output within a foreign compartment.
    
    Returns:
    
    render input slots
  - renderOutputSlots
```
public boolean renderOutputSlots()
```
    Controls whether to render output slots. If disabled, this achieves the same effect as a compartment output within the same compartment.
    
    Returns:
    
    render output slots
  - setAllSlotsVirtual
```
public void setAllSlotsVirtual(boolean virtual,
                               boolean apply,
                               JIPipeProgressInfo progressInfo)
```
    Sets/unsets virtual mode for all output slots
    
    Parameters:
    
    virtual - virtual mode
    
    apply - apply the setting
    
    progressInfo - progress for applying. Can be null if apply is false.
  - isVisibleIn
```
public boolean isVisibleIn(UUID compartmentUUIDInGraph)
```
  - getCompartmentDisplayName
```
public String getCompartmentDisplayName()
```
    Returns a display name for the compartment
    
    Returns:
    
    the display name for the compartment
  - getDisplayName
```
public String getDisplayName()
```
    Returns a name that provides human-readable information about the name and compartment
    
    Returns:
    
    the display name
  - getCompartmentUUIDInGraphAsString
```
public String getCompartmentUUIDInGraphAsString()
```
    Returns the compartment UUID in the graph as string. If the UUID is null, an empty string is returned.
    
    Returns:
    
    UUID as string or an empty string of the compartment is null;
  - getAliasIdInParentGraph
```
public String getAliasIdInParentGraph()
```
    Returns the alias ID of this node. It is unique within the same graph, but should not be used to identify it due to dependency on the node's name. Use the UUID instead.
    
    Returns:
    
    the alias ID. Null if there is no graph.
  - getProjectCompartment
```
public JIPipeProjectCompartment getProjectCompartment()
```
    Gets the project compartment instance of this node. Returns null if there is no project.
    
    Returns:
    
    the compartment
  - toggleSlot
```
public void toggleSlot(JIPipeDataSlotInfo info,
                       boolean toggle)
```
    Toggles a slot with given info on/off. Requires that the slot configuration is a JIPipeMutableSlotConfiguration
    
    Parameters:
    
    info - the slot info
    
    toggle - if the slot should be present

Class JIPipeGraphNode

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Constructor Detail

JIPipeGraphNode

JIPipeGraphNode

JIPipeGraphNode

Method Detail

fromJsonNode

updateGraphNodeSlots

copySlotConfiguration

run

getEventBus

getName

setCustomName

isParameterUIVisible

isBookmarked

setBookmarked

getCategory

getSlotConfiguration

setSlotConfiguration

getInputSlotMap

getOutputSlotMap

getInputSlotOrder

getInputSlots

getDataInputSlots

getOutputSlots

onParameterChanged

onSlotConfigurationChanged

getLocations

setLocations

getLocationWithin

setLocationWithin

setLocationWithin

toJson

fromJson

onDeserialized

getStoragePath

setStoragePath

getInternalStoragePath

setInternalStoragePath

getInfo

setInfo

getOutputSlot

getInputSlot

getOpenInputSlots

getInputSlotsWithRole

getOutputSlotsWithRole

getFirstOutputSlot

getFirstInputSlot

getLastOutputSlot

getLastInputSlot

getParentGraph

setParentGraph

getUUIDInParentGraph

getCompartmentUUIDInParentGraph

clearLocations

getCustomDescription

setCustomDescription

getProjectDirectory

setProjectDirectory

getBaseDirectory

setBaseDirectory

getScratchBaseDirectory

setScratchBaseDirectory

getNewScratch

onSlotConnected

updateSlotInheritance

triggerSlotsChangedEvent

onSlotDisconnected

getDependencies

registerSubParameter

onParameterStructureChanged

onParameterUIChanged

clearSlotData