JIPipeParameterTree (jipipe 1.76.1-SNAPSHOT API)

java.lang.Object
- org.hkijena.jipipe.api.parameters.JIPipeParameterTree

All Implemented Interfaces:

JIPipeCustomParameterCollection, JIPipeParameterCollection
```
public class JIPipeParameterTree
extends Object
implements JIPipeParameterCollection, JIPipeCustomParameterCollection
```
An JIPipeParameterCollection that contains all the parameters of one or multiple JIPipeParameterCollection instances in a traversed form.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JIPipeParameterTree.Node
A node
- Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection
  JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Nested Classes
Modifier and Type	Class and Description
`static class`	`JIPipeParameterTree.Node` A node

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FORCE_REFLECTION` Whether to force reflection
`static int`	`IGNORE_CUSTOM` Whether to ignore all custom parameters
`static int`	`IGNORE_REFLECTION` Whether to ignore all reflection parameters
`static int`	`NONE` No flags

Constructor Summary

Constructors
Constructor and Description
`JIPipeParameterTree()`
`JIPipeParameterTree(JIPipeParameterCollection rootParameter)` Creates a new instance with a predefined root parameter
`JIPipeParameterTree(JIPipeParameterCollection rootParameter, int flags)` Creates a new instance with a predefined root parameter

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JIPipeParameterTree.Node`	`add(JIPipeParameterCollection child, String key, JIPipeParameterTree.Node parent)` Adds a new `JIPipeParameterCollection` into this collection.
`List<JIPipeParameterAccess>`	`getAllChildParameters(Object entry)` Returns all child parameters of the entry If the entry is an `JIPipeParameterAccess`, it is returned.
`EventBus`	`getEventBus()` Gets the event bus that posts events about the parameters
`Map<JIPipeParameterCollection,List<JIPipeParameterAccess>>`	`getGroupedBySource()` Gets the parameters grouped by the source
`Map<String,JIPipeParameterAccess>`	`getParameters()` Returns all parameters Please note that those parameters must be sourced in this collection.
`static Map<String,JIPipeParameterAccess>`	`getParameters(JIPipeParameterCollection collection)` Accesses the parameters of a collection
`PriorityQueue<JIPipeParameterAccess>`	`getParametersByPriority()`
`Set<JIPipeParameterCollection>`	`getRegisteredSources()`
`JIPipeParameterTree.Node`	`getRoot()`
`boolean`	`getSourceCollapsed(JIPipeParameterCollection source)` Gets information about if the source is collapsed
`JIPipeDocumentation`	`getSourceDocumentation(JIPipeParameterCollection source)` Gets source documentation
`String`	`getSourceDocumentationName(JIPipeParameterCollection source)` Gets source name
`String`	`getSourceKey(JIPipeParameterCollection collection)` Gets unique source key
`JIPipeParameterTree.Node`	`getSourceNode(JIPipeParameterCollection collection)` Returns the node of a collection
`int`	`getSourceUIOrder(JIPipeParameterCollection source)` Gets source UI order
`int`	`getUISourceOrder(JIPipeParameterCollection source)` Gets source UI order
`String`	`getUniqueKey(JIPipeParameterAccess parameterAccess)` Gets the unique key of an parameter access
`boolean`	`isForceReflection()`
`boolean`	`isIgnoreCustomParameters()`
`boolean`	`isIgnoreReflectionParameters()`
`boolean`	`isSourceHidden(JIPipeParameterCollection source)` Gets source visibility
`void`	`merge(JIPipeParameterCollection source, JIPipeParameterTree.Node target)` Merges parameters into a given node
`void`	`onParameterChangedEvent(JIPipeParameterCollection.ParameterChangedEvent event)` Triggered when a parameter value was changed.
`void`	`onParameterStructureChanged(JIPipeParameterCollection.ParameterStructureChangedEvent event)` Triggered when a source informs that the parameter structure was changed.
`void`	`onParameterUIChanged(JIPipeParameterCollection.ParameterUIChangedEvent event)` Triggered when a source informs that the parameter UI should be updated Passes the event to listeners.
`void`	`removeParameterByKey(String key)` Removes a parameter by key
`void`	`setForceReflection(boolean forceReflection)`
`void`	`setIgnoreCustomParameters(boolean ignoreCustomParameters)`
`void`	`setIgnoreReflectionParameters(boolean ignoreReflectionParameters)`
`void`	`setSourceDocumentation(JIPipeParameterCollection source, JIPipeDefaultDocumentation documentation)` Sets source documentation

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.parameters.JIPipeCustomParameterCollection
getChildParameterCollections, getIncludeReflectionParameters

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

- Field Detail
  - NONE
```
public static final int NONE
```
    No flags
    
    See Also:
    
    Constant Field Values
  - IGNORE_REFLECTION
```
public static final int IGNORE_REFLECTION
```
    Whether to ignore all reflection parameters
    
    See Also:
    
    Constant Field Values
  - FORCE_REFLECTION
```
public static final int FORCE_REFLECTION
```
    Whether to force reflection
    
    See Also:
    
    Constant Field Values
  - IGNORE_CUSTOM
```
public static final int IGNORE_CUSTOM
```
    Whether to ignore all custom parameters
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JIPipeParameterTree
```
public JIPipeParameterTree()
```
  - JIPipeParameterTree
```
public JIPipeParameterTree(JIPipeParameterCollection rootParameter)
```
    Creates a new instance with a predefined root parameter
    
    Parameters:
    
    rootParameter - the root parameter
  - JIPipeParameterTree
```
public JIPipeParameterTree(JIPipeParameterCollection rootParameter,
                           int flags)
```
    Creates a new instance with a predefined root parameter
    
    Parameters:
    
    rootParameter - the root parameter
    
    flags - additional flags
- Method Detail
  - getParameters
```
public static Map<String,JIPipeParameterAccess> getParameters(JIPipeParameterCollection collection)
```
    Accesses the parameters of a collection
    
    Parameters:
    
    collection - the collection
    
    Returns:
    
    traversed parameters
  - getGroupedBySource
```
public Map<JIPipeParameterCollection,List<JIPipeParameterAccess>> getGroupedBySource()
```
    Gets the parameters grouped by the source
    
    Returns:
    
    all parameters grouped by source
  - getUniqueKey
```
public String getUniqueKey(JIPipeParameterAccess parameterAccess)
```
    Gets the unique key of an parameter access
    
    Parameters:
    
    parameterAccess - the access
    
    Returns:
    
    unique key
  - add
```
public JIPipeParameterTree.Node add(JIPipeParameterCollection child,
                                    String key,
                                    JIPipeParameterTree.Node parent)
```
    Adds a new JIPipeParameterCollection into this collection. Ignores sources that have already been added
    
    Parameters:
    
    child - the added collection
    
    key - the unique key within the parent node
    
    parent - the parent node. Can be null (then defaults to root)
    
    Returns:
    
    the created node
  - merge
```
public void merge(JIPipeParameterCollection source,
                  JIPipeParameterTree.Node target)
```
    Merges parameters into a given node
    
    Parameters:
    
    source - the parameters
    
    target - the target node
  - getParameters
```
public Map<String,JIPipeParameterAccess> getParameters()
```
    Description copied from interface: JIPipeCustomParameterCollection
    
    Returns all parameters Please note that those parameters must be sourced in this collection. Use getChildParameterCollections() to add those
    
    Specified by:
    
    getParameters in interface JIPipeCustomParameterCollection
    
    Returns:
    
    Modifiable map of parameters
  - onParameterStructureChanged
```
public void onParameterStructureChanged(JIPipeParameterCollection.ParameterStructureChangedEvent event)
```
    Triggered when a source informs that the parameter structure was changed. Passes the event to listeners.
    
    Parameters:
    
    event - generated event
  - onParameterUIChanged
```
public void onParameterUIChanged(JIPipeParameterCollection.ParameterUIChangedEvent event)
```
    Triggered when a source informs that the parameter UI should be updated Passes the event to listeners.
    
    Parameters:
    
    event - generated event
  - onParameterChangedEvent
```
public void onParameterChangedEvent(JIPipeParameterCollection.ParameterChangedEvent event)
```
    Triggered when a parameter value was changed. Passes the event to listeners.
    
    Parameters:
    
    event - generated event
  - 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
  - isIgnoreReflectionParameters
```
public boolean isIgnoreReflectionParameters()
```
  - setIgnoreReflectionParameters
```
public void setIgnoreReflectionParameters(boolean ignoreReflectionParameters)
```
  - isIgnoreCustomParameters
```
public boolean isIgnoreCustomParameters()
```
  - setIgnoreCustomParameters
```
public void setIgnoreCustomParameters(boolean ignoreCustomParameters)
```
  - getParametersByPriority
```
public PriorityQueue<JIPipeParameterAccess> getParametersByPriority()
```
  - isForceReflection
```
public boolean isForceReflection()
```
  - setForceReflection
```
public void setForceReflection(boolean forceReflection)
```
  - getAllChildParameters
```
public List<JIPipeParameterAccess> getAllChildParameters(Object entry)
```
    Returns all child parameters of the entry If the entry is an JIPipeParameterAccess, it is returned. Otherwise all children of the JIPipeParameterCollection are returned.
    
    Parameters:
    
    entry - the entry.
    
    Returns:
    
    all parameters that are children of the entry or the entry itself
  - getRoot
```
public JIPipeParameterTree.Node getRoot()
```
  - getSourceKey
```
public String getSourceKey(JIPipeParameterCollection collection)
```
    Gets unique source key
    
    Parameters:
    
    collection - source
    
    Returns:
    
    key
  - getRegisteredSources
```
public Set<JIPipeParameterCollection> getRegisteredSources()
```
  - getUISourceOrder
```
public int getUISourceOrder(JIPipeParameterCollection source)
```
    Gets source UI order
    
    Parameters:
    
    source - source
    
    Returns:
    
    ui order
  - getSourceDocumentationName
```
public String getSourceDocumentationName(JIPipeParameterCollection source)
```
    Gets source name
    
    Parameters:
    
    source - source
    
    Returns:
    
    name
  - isSourceHidden
```
public boolean isSourceHidden(JIPipeParameterCollection source)
```
    Gets source visibility
    
    Parameters:
    
    source - source
    
    Returns:
    
    visibility
  - getSourceUIOrder
```
public int getSourceUIOrder(JIPipeParameterCollection source)
```
    Gets source UI order
    
    Parameters:
    
    source - source
    
    Returns:
    
    source UI order
  - getSourceCollapsed
```
public boolean getSourceCollapsed(JIPipeParameterCollection source)
```
    Gets information about if the source is collapsed
    
    Parameters:
    
    source - source
    
    Returns:
    
    if the source is collapsed by default
  - getSourceDocumentation
```
public JIPipeDocumentation getSourceDocumentation(JIPipeParameterCollection source)
```
    Gets source documentation
    
    Parameters:
    
    source - source
    
    Returns:
    
    source documentation
  - setSourceDocumentation
```
public void setSourceDocumentation(JIPipeParameterCollection source,
                                   JIPipeDefaultDocumentation documentation)
```
    Sets source documentation
    
    Parameters:
    
    source - source
    
    documentation - documentation
  - getSourceNode
```
public JIPipeParameterTree.Node getSourceNode(JIPipeParameterCollection collection)
```
    Returns the node of a collection
    
    Parameters:
    
    collection - the collection
    
    Returns:
    
    node or null
  - removeParameterByKey
```
public void removeParameterByKey(String key)
```
    Removes a parameter by key
    
    Parameters:
    
    key - the key

Class JIPipeParameterTree

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

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

Field Detail

NONE

IGNORE_REFLECTION

FORCE_REFLECTION

IGNORE_CUSTOM

Constructor Detail

JIPipeParameterTree

JIPipeParameterTree

JIPipeParameterTree

Method Detail

getParameters

getGroupedBySource

getUniqueKey

add

merge

getParameters

onParameterStructureChanged

onParameterUIChanged

onParameterChangedEvent

getEventBus

isIgnoreReflectionParameters

setIgnoreReflectionParameters

isIgnoreCustomParameters

setIgnoreCustomParameters

getParametersByPriority

isForceReflection

setForceReflection

getAllChildParameters

getRoot

getSourceKey

getRegisteredSources

getUISourceOrder

getSourceDocumentationName

isSourceHidden

getSourceUIOrder

getSourceCollapsed

getSourceDocumentation

setSourceDocumentation

getSourceNode

removeParameterByKey