public interface IterationStrategyNode extends MutableTreeNode, WorkflowItem
Modifier and Type | Method and Description |
---|---|
Enumeration<IterationStrategyNode> |
children()
Specialised return type of
TreeNode#children() |
void |
clear()
Remove all children nodes and set the parent to
null . |
IterationStrategyNode |
getChildAt(int childIndex)
Specialised return type of
TreeNode#getChildAt(int) |
List<IterationStrategyNode> |
getChildren()
Return a copy of the list of children nodes, or an empty list if
TreeNode.getAllowsChildren() is false . |
int |
getIterationDepth(Map<String,Integer> inputDepths)
In the context of an enclosing iteration strategy each node should be
able to return the iteration depth, i.e.
|
IterationStrategyNode |
getParent()
Specialised return type of
TreeNode#getParent() |
void |
insert(MutableTreeNode child)
Insert a new child node.
|
void |
receiveCompletion(int inputIndex,
Completion completion)
Nodes can also receive completion events, the simplest being one
declaring that no further input is expected on the given input, or
partial completion events which are interpreted as 'no event with an
index array prefixed by the specified completion index array will be
received on the specified index'
|
void |
receiveJob(int inputIndex,
Job newJob)
The nodes within the iteration strategy, a tree structure, are event
based.
|
insert, remove, remove, removeFromParent, setParent, setUserObject
getAllowsChildren, getChildCount, getIndex, isLeaf
Enumeration<IterationStrategyNode> children()
TreeNode#children()
void clear()
null
.IterationStrategyNode getChildAt(int childIndex)
TreeNode#getChildAt(int)
getChildAt
in interface TreeNode
List<IterationStrategyNode> getChildren()
TreeNode.getAllowsChildren()
is false
.int getIterationDepth(Map<String,Integer> inputDepths) throws IterationTypeMismatchException
Nodes can choose to throw the IterationTypeMismatchException if their inputs aren't compatible with the operational semantics of the node such as in the case of a dot product node with inputs with different depths.
inputDepths
- IterationTypeMismatchException
IterationStrategyNode getParent()
TreeNode#getParent()
void insert(MutableTreeNode child)
child
- Child node to addvoid receiveCompletion(int inputIndex, Completion completion)
void receiveJob(int inputIndex, Job newJob)
inputIndex
- newJob
- Copyright © 2015–2016 The Apache Software Foundation. All rights reserved.