java.lang.Object
- de.xima.fc.workflow.processor.model.WorkflowElementIndex

```
public final class WorkflowElementIndex
extends Object
```
Given a WorkflowTask or WorkflowProcess, contains various maps of WorkflowNodes for quickly accessing the nodes by a certain index.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Collection<IWorkflowElementWithDeserializedModel<?,WorkflowNode>>`	`getAllNodes()`
`Collection<IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>>`	`getAllTriggers()`
`IWorkflowElementWithDeserializedModel<?,WorkflowNode>`	`getNodeByUuid(ElementKey key)`
`IWorkflowElementWithDeserializedModel<?,WorkflowNode>`	`getNodeByUuid(NodeKey key)`
`Map<String,List<IWorkflowElementWithDeserializedModel<?,WorkflowNode>>>`	`getNodesByKind()`
`Map<String,Map<UUID,List<IWorkflowElementWithDeserializedModel<?,WorkflowNode>>>>`	`getNodesByKindAndTask()`
`Map<UUID,List<IWorkflowElementWithDeserializedModel<?,WorkflowNode>>>`	`getNodesByTask()`
`Map<NodeKey,IWorkflowElementWithDeserializedModel<?,WorkflowNode>>`	`getNodesByUuid()`
`WorkflowNode`	`getParent(ElementKey key)`
`WorkflowNode`	`getParent(NodeKey key)`
`Iterable<WorkflowNode>`	`getParents(ElementKey start, boolean includeStartNode)`
`Iterable<WorkflowNode>`	`getParents(NodeKey start, boolean includeStartNode)`
`Iterable<NodeKey>`	`getParentUuids(ElementKey start, boolean includeStartNode)`
`Iterable<NodeKey>`	`getParentUuids(NodeKey start, boolean includeStartNode)`
`WorkflowTask`	`getTaskByNode(NodeKey nodeKey)`	Gets a task that the given node belongs to.
`WorkflowTrigger`	`getTaskByTrigger(TriggerKey triggerKey)`	Gets a task that the given trigger belongs to.
`WorkflowTask`	`getTaskByUuid(UUID taskUuid)`	Gets a task by its UUID.
`List<WorkflowTask>`	`getTasks()`
`Map<UUID,WorkflowTask>`	`getTasksByUuid()`	Gets a map of tasks by their UUID.
`IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>`	`getTriggerByUuid(ElementKey key)`
`IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>`	`getTriggerByUuid(TriggerKey key)`
`Map<String,List<IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>>>`	`getTriggersByKind()`
`Map<String,Map<UUID,List<IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>>>>`	`getTriggersByKindAndTask()`
`Map<TriggerKey,IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>>`	`getTriggersByUuid()`
`boolean`	`isParent(NodeKey parent, NodeKey child)`	Checks if a node is a parent of another node.
`static WorkflowElementIndex`	`of(WorkflowProcess process, Mandant client)`	Creates a new index with all workflow element from the given process.
`static WorkflowElementIndex`	`of(WorkflowTask task, Mandant client)`	Creates a new index with all workflow element from the given task.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getAllNodes
```
public Collection<IWorkflowElementWithDeserializedModel<?,WorkflowNode>> getAllNodes()
```
    Returns:
    
    A list of all known nodes in this element index.
  - getAllTriggers
```
public Collection<IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>> getAllTriggers()
```
    Returns:
    
    A list of all known triggers in this element index.
  - getNodeByUuid
```
public IWorkflowElementWithDeserializedModel<?,WorkflowNode> getNodeByUuid(ElementKey key)
```
    Parameters:
    
    key - Element key of a workflow node to find.
    
    Returns:
    
    The workflow node with the given key, or null when no such node exists.
  - getNodeByUuid
```
public IWorkflowElementWithDeserializedModel<?,WorkflowNode> getNodeByUuid(NodeKey key)
```
    Parameters:
    
    key - Element key of a workflow node to find.
    
    Returns:
    
    The workflow node with the given key, or null when no such node exists.
  - getNodesByKind
```
public Map<String,List<IWorkflowElementWithDeserializedModel<?,WorkflowNode>>> getNodesByKind()
```
    Returns:
    
    All nodes, grouped by their AWorkflowElement.getType().
  - getNodesByKindAndTask
```
public Map<String,Map<UUID,List<IWorkflowElementWithDeserializedModel<?,WorkflowNode>>>> getNodesByKindAndTask()
```
    Returns:
    
    An index of all nodes, indexed first by their type and then by the task they belong to.
  - getNodesByTask
```
public Map<UUID,List<IWorkflowElementWithDeserializedModel<?,WorkflowNode>>> getNodesByTask()
```
    Returns:
    
    All nodes, grouped by the UUID of the task they belong to.
  - getNodesByUuid
```
public Map<NodeKey,IWorkflowElementWithDeserializedModel<?,WorkflowNode>> getNodesByUuid()
```
    Returns:
    
    All nodes , indexed by their ElementKey.
  - getParent
```
public WorkflowNode getParent(ElementKey key)
```
    Parameters:
    
    key - A node to check.
    
    Returns:
    
    The parent of the node, or null when it is a root node.
  - getParent
```
public WorkflowNode getParent(NodeKey key)
```
    Parameters:
    
    key - A node to check.
    
    Returns:
    
    The parent of the node, or null when it is a root node.
  - getParentUuids
```
public Iterable<NodeKey> getParentUuids(ElementKey start,
                                        boolean includeStartNode)
```
    Parameters:
    
    start - Start node.
    
    includeStartNode - Whether to include the start node in the iterable.
    
    Returns:
    
    An iterable over all parents of the start node.
  - getParentUuids
```
public Iterable<NodeKey> getParentUuids(NodeKey start,
                                        boolean includeStartNode)
```
    Parameters:
    
    start - Start node.
    
    includeStartNode - Whether to include the start node in the iterable.
    
    Returns:
    
    An iterable over all parents of the start node.
  - getParents
```
public Iterable<WorkflowNode> getParents(ElementKey start,
                                         boolean includeStartNode)
```
    Parameters:
    
    start - Start node.
    
    includeStartNode - Whether to include the start node in the iterable.
    
    Returns:
    
    An iterable over all parents of the start node.
  - getParents
```
public Iterable<WorkflowNode> getParents(NodeKey start,
                                         boolean includeStartNode)
```
    Parameters:
    
    start - Start node.
    
    includeStartNode - Whether to include the start node in the iterable.
    
    Returns:
    
    An iterable over all parents of the start node.
  - getTaskByNode
```
public WorkflowTask getTaskByNode(NodeKey nodeKey)
```
    Gets a task that the given node belongs to.
    
    Parameters:
    
    nodeKey - Node key of a node that belongs to the task to get.
    
    Returns:
    
    The task that the given node belongs to, or null if no such task exists, or it does not belong to any task.
  - getTaskByTrigger
```
public WorkflowTrigger getTaskByTrigger(TriggerKey triggerKey)
```
    Gets a task that the given trigger belongs to.
    
    Parameters:
    
    triggerKey - Trigger key of a trigger that belongs to the task to get.
    
    Returns:
    
    The task that the given trigger belongs to, or null if no such task exists, or it does not belong to any task.
  - getTaskByUuid
```
public WorkflowTask getTaskByUuid(UUID taskUuid)
```
    Gets a task by its UUID.
    
    Parameters:
    
    taskUuid - UUID of the task to get.
    
    Returns:
    
    The task with the given UUID, or null if no such task exists.
  - getTasks
```
public List<WorkflowTask> getTasks()
```
    Returns:
    
    All tasks contained in this index.
  - getTasksByUuid
```
public Map<UUID,WorkflowTask> getTasksByUuid()
```
    Gets a map of tasks by their UUID.
    
    Returns:
    
    A map of tasks by their UUID.
  - getTriggerByUuid
```
public IWorkflowElementWithDeserializedModel<?,WorkflowTrigger> getTriggerByUuid(ElementKey key)
```
    Parameters:
    
    key - Element key of a workflow trigger to find.
    
    Returns:
    
    The workflow trigger with the given key, or null when no such trigger exists.
  - getTriggerByUuid
```
public IWorkflowElementWithDeserializedModel<?,WorkflowTrigger> getTriggerByUuid(TriggerKey key)
```
    Parameters:
    
    key - Element key of a workflow trigger to find.
    
    Returns:
    
    The workflow trigger with the given key, or null when no such trigger exists.
  - getTriggersByKind
```
public Map<String,List<IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>>> getTriggersByKind()
```
    Returns:
    
    All triggers, grouped by their AWorkflowElement.getType().
  - getTriggersByKindAndTask
```
public Map<String,Map<UUID,List<IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>>>> getTriggersByKindAndTask()
```
    Returns:
    
    An index of all triggers, indexed first by their type and then by the trigger they belong to.
  - getTriggersByUuid
```
public Map<TriggerKey,IWorkflowElementWithDeserializedModel<?,WorkflowTrigger>> getTriggersByUuid()
```
    Returns:
    
    All triggers, indexed by their ElementKey.
  - isParent
```
public boolean isParent(NodeKey parent,
                        NodeKey child)
```
    Checks if a node is a parent of another node.
    
    Parameters:
    
    parent - Potential parent.
    
    child - Potential child.
    
    Returns:
    
    true if the given parent is truly a parent of the given child, or if parent == child.
    
    Since:
    
    8.1.0
  - of
```
public static WorkflowElementIndex of(WorkflowProcess process,
                                      Mandant client)
```
    Creates a new index with all workflow element from the given process.
    
    Parameters:
    
    process - Workflow process to index.
    
    client - Current client that is used to retrieve plugin trigger and node handlers.
    
    Returns:
    
    A new index with all workflow element from the given process.
  - of
```
public static WorkflowElementIndex of(WorkflowTask task,
                                      Mandant client)
```
    Creates a new index with all workflow element from the given task.
    
    Parameters:
    
    task - Workflow task to index.
    
    client - Current client that is used to retrieve plugin trigger and node handlers.
    
    Returns:
    
    A new index with all workflow element from the given task.

Class WorkflowElementIndex

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getAllNodes

getAllTriggers

getNodeByUuid

getNodeByUuid

getNodesByKind

getNodesByKindAndTask

getNodesByTask

getNodesByUuid

getParent

getParent

getParentUuids

getParentUuids

getParents

getParents

getTaskByNode

getTaskByTrigger

getTaskByUuid

getTasks

getTasksByUuid

getTriggerByUuid

getTriggerByUuid

getTriggersByKind

getTriggersByKindAndTask

getTriggersByUuid

isParent

of

of