JIPipeMultiIterationStep (jipipe 5.1.0-SNAPSHOT API)

java.lang.Object
- org.hkijena.jipipe.api.nodes.iterationstep.JIPipeMultiIterationStep

All Implemented Interfaces:

Comparable<JIPipeMultiIterationStep>, JIPipeIterationStep
```
public class JIPipeMultiIterationStep
extends Object
implements JIPipeIterationStep, Comparable<JIPipeMultiIterationStep>
```
Wraps a set of input and output slots that belong together. This is a less restricted variant of JIPipeSingleIterationStep used by JIPipeMergingAlgorithm

Constructor Summary

Constructors
Constructor and Description

JIPipeMultiIterationStep(JIPipeGraphNode node)
Creates a new interface

JIPipeMultiIterationStep(JIPipeMultiIterationStep other)
Creates a copy

Constructors
Constructor and Description
`JIPipeMultiIterationStep(JIPipeGraphNode node)` Creates a new interface
`JIPipeMultiIterationStep(JIPipeMultiIterationStep other)` Creates a copy

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEmptySlot(JIPipeDataSlot slot)` Ensures that the specified slot is registered to the iteration step
`void`	`addInputData(JIPipeDataSlot slot, Collection<Integer> rowsToAdd)` Adds the data row of a given slot.
`void`	`addInputData(JIPipeDataSlot slot, int row)` Adds the data row of a given slot.
`void`	`addMergedDataAnnotation(JIPipeDataAnnotation annotation, JIPipeDataAnnotationMergeMode strategy)` Adds an annotation to the annotation list
`void`	`addMergedDataAnnotations(Collection<JIPipeDataAnnotation> annotations, JIPipeDataAnnotationMergeMode strategy)` Adds annotations to the annotation list
`void`	`addMergedTextAnnotation(JIPipeTextAnnotation annotation, JIPipeTextAnnotationMergeMode strategy)` Adds an annotation to the annotation list
`void`	`addMergedTextAnnotations(List<JIPipeTextAnnotation> annotations, JIPipeTextAnnotationMergeMode strategy)` Adds annotations to the merged annotation storage of this interface.
`void`	`addMergedTextAnnotations(Map<String,String> annotations, JIPipeTextAnnotationMergeMode strategy)` Adds annotations to the merged annotation storage of this interface.
`void`	`addOutputData(JIPipeOutputDataSlot slot, JIPipeDataItemStore data, JIPipeProgressInfo progressInfo)` Writes output data into the provided slot Please note that annotations that are added to all annotations should be set up till this point
`void`	`addOutputData(JIPipeOutputDataSlot slot, JIPipeDataItemStore data, List<JIPipeTextAnnotation> additionalAnnotations, JIPipeTextAnnotationMergeMode mergeStrategy, JIPipeProgressInfo progressInfo)` Writes output data into the provided slot Please note that annotations that are added to all annotations should be set up till this point
`void`	`addOutputData(JIPipeOutputDataSlot slot, JIPipeDataItemStore data, List<JIPipeTextAnnotation> additionalAnnotations, JIPipeTextAnnotationMergeMode annotationMergeStrategy, List<JIPipeDataAnnotation> additionalDataAnnotations, JIPipeDataAnnotationMergeMode dataAnnotationMergeStrategy, JIPipeProgressInfo progressInfo)`
`void`	`addOutputData(JIPipeOutputDataSlot slot, JIPipeData data, JIPipeProgressInfo progressInfo)` Writes output data into the provided slot Please note that annotations that are added to all annotations should be set up till this point
`void`	`addOutputData(JIPipeOutputDataSlot slot, JIPipeData data, List<JIPipeTextAnnotation> additionalAnnotations, JIPipeTextAnnotationMergeMode mergeStrategy, JIPipeProgressInfo progressInfo)` Writes output data into the provided slot Please note that annotations that are added to all annotations should be set up till this point
`void`	`addOutputData(JIPipeOutputDataSlot slot, JIPipeData data, List<JIPipeTextAnnotation> additionalAnnotations, JIPipeTextAnnotationMergeMode mergeStrategy, List<JIPipeDataAnnotation> additionalDataAnnotations, JIPipeDataAnnotationMergeMode dataAnnotationMergeStrategy, JIPipeProgressInfo progressInfo)` Writes output data into the provided slot Please note that annotations that are added to all annotations should be set up till this point
`void`	`addOutputData(String slotName, JIPipeDataItemStore data, JIPipeProgressInfo progressInfo)` Writes output data into the provided slot Please note that annotations should be set up till this point
`void`	`addOutputData(String slotName, JIPipeDataItemStore data, JIPipeTextAnnotationMergeMode annotationMergeStrategy, List<JIPipeTextAnnotation> additionalAnnotations, JIPipeProgressInfo progressInfo)` Writes output data into the provided slot Please note that annotations should be set up till this point
`void`	`addOutputData(String slotName, JIPipeDataItemStore data, List<JIPipeTextAnnotation> additionalAnnotations, JIPipeProgressInfo progressInfo)` Writes output data into the provided slot Please note that annotations should be set up till this point
`void`	`addOutputData(String slotName, JIPipeData data, JIPipeProgressInfo progressInfo)` Writes output data into the provided slot Please note that annotations should be set up till this point
`void`	`addOutputData(String slotName, JIPipeData data, List<JIPipeTextAnnotation> additionalAnnotations, JIPipeProgressInfo progressInfo)` Writes output data into the provided slot Please note that annotations should be set up till this point
`void`	`addOutputData(String slotName, JIPipeData data, List<JIPipeTextAnnotation> additionalAnnotations, JIPipeTextAnnotationMergeMode annotationMergeStrategy, JIPipeProgressInfo progressInfo)` Writes output data into the provided slot Please note that annotations should be set up till this point
`void`	`addOutputData(String slotName, JIPipeData data, List<JIPipeTextAnnotation> additionalAnnotations, JIPipeTextAnnotationMergeMode mergeStrategy, List<JIPipeDataAnnotation> additionalDataAnnotations, JIPipeDataAnnotationMergeMode dataAnnotationMergeStrategy, JIPipeProgressInfo progressInfo)` Writes output data into the provided slot Please note that annotations should be set up till this point
`int`	`compareTo(JIPipeMultiIterationStep o)`
`JIPipeDataContext`	`createNewContext()` Creates a context for new data that inherits direct predecessors from this iteration step's input
`<T extends JIPipeData> List<T>`	`getInputData(JIPipeDataSlot slot, Class<T> dataClass, JIPipeProgressInfo progressInfo)` Gets stored data from an input slot
`<T extends JIPipeData> T`	`getInputData(JIPipeDataSlot slot, int row, Class<T> dataClass, JIPipeProgressInfo progressInfo)` Gets stored data from an input slot
`<T extends JIPipeData> List<T>`	`getInputData(String slotName, Class<T> dataClass, JIPipeProgressInfo progressInfo)` Gets stored data from an input slot
`<T extends JIPipeData> T`	`getInputData(String slotName, int row, Class<T> dataClass, JIPipeProgressInfo progressInfo)` Gets stored data from an input slot
`List<JIPipeDataAnnotation>`	`getInputDataAnnotations(JIPipeDataSlot slot)` Gets the original annotations of given slot This returns all annotations (of all rows)
`List<JIPipeDataAnnotation>`	`getInputDataAnnotations(JIPipeDataSlot slot, Collection<Integer> rows)` Gets the original annotations of given slot
`List<JIPipeDataAnnotation>`	`getInputDataAnnotations(JIPipeDataSlot slot, int row)` Gets the original annotations of given slot
`List<JIPipeDataAnnotation>`	`getInputDataAnnotations(String slotName)` Gets the original annotations of given slot This returns all annotations (of all rows)
`List<JIPipeDataAnnotation>`	`getInputDataAnnotations(String slotName, Collection<Integer> rows)` Gets the original annotations of given slot
`List<JIPipeDataAnnotation>`	`getInputDataAnnotations(String slotName, int row)` Gets the original annotations of given slot
`List<JIPipeDataItemStore>`	`getInputDataStore(JIPipeDataSlot slot)` Gets stored data from an input slot
`List<JIPipeDataItemStore>`	`getInputDataStore(String slotName)` Gets stored data from an input slot
`Set<Integer>`	`getInputRows(JIPipeDataSlot slot)` Returns the row indices that belong to this data interface
`Set<Integer>`	`getInputRows(String slot)` Returns the row indices that belong to this data interface
`Set<String>`	`getInputSlotNames()` Gets the names of all input slots that are referenced
`Set<Integer>`	`getInputSlotRowIndices(String slotName)` Returns the referenced indices of given input slot name
`Map<JIPipeDataSlot,Set<Integer>>`	`getInputSlotRows()` Raw access to all data stored in the batch
`Set<JIPipeDataSlot>`	`getInputSlots()` Gets the input slots that are referenced
`List<JIPipeTextAnnotation>`	`getInputTextAnnotations(JIPipeDataSlot slot)` Gets the original annotations of given slot This returns all annotations (of all rows)
`List<JIPipeTextAnnotation>`	`getInputTextAnnotations(JIPipeDataSlot slot, Collection<Integer> rows)` Gets the original annotations of given slot
`List<JIPipeTextAnnotation>`	`getInputTextAnnotations(JIPipeDataSlot slot, int row)` Gets the original annotations of given slot
`List<JIPipeTextAnnotation>`	`getInputTextAnnotations(String slotName)` Gets the original annotations of given slot This returns all annotations (of all rows)
`List<JIPipeTextAnnotation>`	`getInputTextAnnotations(String slotName, Collection<Integer> rows)` Gets the original annotations of given slot
`List<JIPipeTextAnnotation>`	`getInputTextAnnotations(String slotName, int row)` Gets the original annotations of given slot
`JIPipeDataAnnotation`	`getMergedDataAnnotation(String name)` Returns a merged annotation
`Map<String,JIPipeDataAnnotation>`	`getMergedDataAnnotations()` Gets the list of annotations.
`JIPipeTextAnnotation`	`getMergedTextAnnotation(String name)` Returns a merged annotation
`Map<String,JIPipeTextAnnotation>`	`getMergedTextAnnotations()` Gets the list of annotations.
`JIPipeGraphNode`	`getNode()` The node that the iteration step is working on
`boolean`	`isEmpty()` Returns true if no data is referenced
`boolean`	`isIncomplete()` Returns true if there is at least one slot that has no rows attached to it
`boolean`	`isSingle()` Returns true if each slot only has one row
`void`	`removeMergedTextAnnotation(String info)` Removes an annotation of provided type
`void`	`setInputData(JIPipeDataSlot slot, int row)` Sets the input slot to only one row
`void`	`setMergedDataAnnotations(Map<String,JIPipeDataAnnotation> dataAnnotations)`
`void`	`setMergedTextAnnotations(Map<String,JIPipeTextAnnotation> annotations)`
`JIPipeDataSlot`	`toDummySlot(JIPipeDataSlotInfo info, JIPipeGraphNode node, JIPipeDataSlot sourceSlot, JIPipeProgressInfo progressInfo)` Creates a new dummy slot that contains the data of one input slot and the annotations of this batch
`String`	`toString()`

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

Constructor Detail
- JIPipeMultiIterationStep
```
public JIPipeMultiIterationStep(JIPipeGraphNode node)
```
  Creates a new interface
  
  Parameters:
  
  node - The algorithm
- JIPipeMultiIterationStep
```
public JIPipeMultiIterationStep(JIPipeMultiIterationStep other)
```
  Creates a copy
  
  Parameters:
  
  other - the original

Method Detail

getNode
```
public JIPipeGraphNode getNode()
```
Description copied from interface: JIPipeIterationStep

The node that the iteration step is working on

Specified by:

getNode in interface JIPipeIterationStep

Returns:

the node

getInputSlotRows
```
public Map<JIPipeDataSlot,Set<Integer>> getInputSlotRows()
```
Raw access to all data stored in the batch

Returns:

map from data slot to set of row indices

addInputData
```
public void addInputData(JIPipeDataSlot slot,
                         int row)
```
Adds the data row of a given slot. This should not be called after the interface was generated

Parameters:

slot - the data slot

row - the row

addInputData
```
public void addInputData(JIPipeDataSlot slot,
                         Collection<Integer> rowsToAdd)
```
Adds the data row of a given slot. This should not be called after the interface was generated

Parameters:

slot - the data slot

rowsToAdd - the rows to add

setInputData

public void setInputData(JIPipeDataSlot slot,
                         int row)

Sets the input slot to only one row

Parameters:: slot - the slot; row - the row

addMergedDataAnnotation

public void addMergedDataAnnotation(JIPipeDataAnnotation annotation,
                                    JIPipeDataAnnotationMergeMode strategy)

Adds an annotation to the annotation list

Parameters:: annotation - added annotation. Cannot be null.

addMergedDataAnnotations

public void addMergedDataAnnotations(Collection<JIPipeDataAnnotation> annotations,
                                     JIPipeDataAnnotationMergeMode strategy)

Adds annotations to the annotation list

Parameters:: annotations - added annotations

addMergedTextAnnotations
```
public void addMergedTextAnnotations(Map<String,String> annotations,
                                     JIPipeTextAnnotationMergeMode strategy)
```
Adds annotations to the merged annotation storage of this interface. Merged annotations are passed to all output slots.

Parameters:

annotations - the annotations

strategy - strategy to apply on merging existing values

addMergedTextAnnotations
```
public void addMergedTextAnnotations(List<JIPipeTextAnnotation> annotations,
                                     JIPipeTextAnnotationMergeMode strategy)
```
Adds annotations to the merged annotation storage of this interface. Merged annotations are passed to all output slots.

Parameters:

annotations - the annotations

strategy - strategy to apply on merging existing values

getInputData

public <T extends JIPipeData> List<T> getInputData(String slotName,
                                                   Class<T> dataClass,
                                                   JIPipeProgressInfo progressInfo)

Gets stored data from an input slot

Type Parameters:: T - Data type
Parameters:: slotName - The slot name; dataClass - The data type that should be returned; progressInfo - data access progress
Returns:: Input data with provided name

getInputData

public <T extends JIPipeData> T getInputData(String slotName,
                                             int row,
                                             Class<T> dataClass,
                                             JIPipeProgressInfo progressInfo)

Gets stored data from an input slot

Type Parameters:: T - Data type
Parameters:: slotName - The slot name; row - the row; dataClass - The data type that should be returned; progressInfo - data access progress
Returns:: Input data with provided name

getInputDataStore
```
public List<JIPipeDataItemStore> getInputDataStore(String slotName)
```
Gets stored data from an input slot

Parameters:

slotName - The slot name

Returns:

Input data with provided name

getInputData

public <T extends JIPipeData> List<T> getInputData(JIPipeDataSlot slot,
                                                   Class<T> dataClass,
                                                   JIPipeProgressInfo progressInfo)

Gets stored data from an input slot

Type Parameters:: T - Data type
Parameters:: slot - The slot; dataClass - The data type that should be returned; progressInfo - data access progress
Returns:: Input data with provided name

getInputData

public <T extends JIPipeData> T getInputData(JIPipeDataSlot slot,
                                             int row,
                                             Class<T> dataClass,
                                             JIPipeProgressInfo progressInfo)

Gets stored data from an input slot

Type Parameters:: T - Data type
Parameters:: slot - The slot; row - the row; dataClass - The data type that should be returned; progressInfo - data access progress
Returns:: Input data with provided name

getInputDataStore
```
public List<JIPipeDataItemStore> getInputDataStore(JIPipeDataSlot slot)
```
Gets stored data from an input slot

Parameters:

slot - The slot

Returns:

Input data with provided name

getInputRows
```
public Set<Integer> getInputRows(String slot)
```
Returns the row indices that belong to this data interface

Parameters:

slot - slot name

Returns:

the row indices that belong to this data interface

getInputRows
```
public Set<Integer> getInputRows(JIPipeDataSlot slot)
```
Returns the row indices that belong to this data interface

Parameters:

slot - slot

Returns:

the row indices that belong to this data interface

getMergedTextAnnotations
```
public Map<String,JIPipeTextAnnotation> getMergedTextAnnotations()
```
Gets the list of annotations. The map is mutable.

Returns:

map from annotation name to annotation value

setMergedTextAnnotations

public void setMergedTextAnnotations(Map<String,JIPipeTextAnnotation> annotations)

getMergedDataAnnotations
```
public Map<String,JIPipeDataAnnotation> getMergedDataAnnotations()
```
Gets the list of annotations. The map is mutable.

Returns:

map from annotation name to annotation value

setMergedDataAnnotations

public void setMergedDataAnnotations(Map<String,JIPipeDataAnnotation> dataAnnotations)

addMergedTextAnnotation

public void addMergedTextAnnotation(JIPipeTextAnnotation annotation,
                                    JIPipeTextAnnotationMergeMode strategy)

Adds an annotation to the annotation list

Parameters:: annotation - added annotation. Cannot be null.

createNewContext
```
public JIPipeDataContext createNewContext()
```
Creates a context for new data that inherits direct predecessors from this iteration step's input

Returns:

the new context

removeMergedTextAnnotation
```
public void removeMergedTextAnnotation(String info)
```
Removes an annotation of provided type

Parameters:

info - removed annotation

getMergedTextAnnotation
```
public JIPipeTextAnnotation getMergedTextAnnotation(String name)
```
Returns a merged annotation

Parameters:

name - name of the annotation

Returns:

the annotation instance or null if there is no such annotation

getMergedDataAnnotation
```
public JIPipeDataAnnotation getMergedDataAnnotation(String name)
```
Returns a merged annotation

Parameters:

name - name of the annotation

Returns:

the annotation instance or null if there is no such annotation

addOutputData

public void addOutputData(String slotName,
                          JIPipeData data,
                          JIPipeProgressInfo progressInfo)

Writes output data into the provided slot Please note that annotations should be set up till this point

Parameters:: slotName - Slot name; data - Added data; progressInfo - data storage progress

addOutputData

public void addOutputData(String slotName,
                          JIPipeDataItemStore data,
                          JIPipeProgressInfo progressInfo)

Writes output data into the provided slot Please note that annotations should be set up till this point

Parameters:: slotName - Slot name; data - Added data; progressInfo - the progress info

addOutputData

public void addOutputData(String slotName,
                          JIPipeData data,
                          List<JIPipeTextAnnotation> additionalAnnotations,
                          JIPipeProgressInfo progressInfo)

Writes output data into the provided slot Please note that annotations should be set up till this point

Parameters:: slotName - Slot name; data - Added data; additionalAnnotations - Annotations that are added additionally to the merged ones; progressInfo - data storage progress

addOutputData

public void addOutputData(String slotName,
                          JIPipeDataItemStore data,
                          List<JIPipeTextAnnotation> additionalAnnotations,
                          JIPipeProgressInfo progressInfo)

Writes output data into the provided slot Please note that annotations should be set up till this point

Parameters:: slotName - Slot name; data - Added data; additionalAnnotations - Annotations that are added additionally to the merged ones; progressInfo - the progress info

addOutputData

public void addOutputData(String slotName,
                          JIPipeData data,
                          List<JIPipeTextAnnotation> additionalAnnotations,
                          JIPipeTextAnnotationMergeMode annotationMergeStrategy,
                          JIPipeProgressInfo progressInfo)

Writes output data into the provided slot Please note that annotations should be set up till this point

Parameters:: slotName - Slot name; data - Added data; additionalAnnotations - Annotations that are added additionally to the merged ones; progressInfo - data storage progress

addOutputData

public void addOutputData(String slotName,
                          JIPipeDataItemStore data,
                          JIPipeTextAnnotationMergeMode annotationMergeStrategy,
                          List<JIPipeTextAnnotation> additionalAnnotations,
                          JIPipeProgressInfo progressInfo)

Writes output data into the provided slot Please note that annotations should be set up till this point

Parameters:: slotName - Slot name; data - Added data; additionalAnnotations - Annotations that are added additionally to the merged ones; progressInfo - the progress info

addOutputData

public void addOutputData(JIPipeOutputDataSlot slot,
                          JIPipeDataItemStore data,
                          List<JIPipeTextAnnotation> additionalAnnotations,
                          JIPipeTextAnnotationMergeMode annotationMergeStrategy,
                          List<JIPipeDataAnnotation> additionalDataAnnotations,
                          JIPipeDataAnnotationMergeMode dataAnnotationMergeStrategy,
                          JIPipeProgressInfo progressInfo)

addOutputData
```
public void addOutputData(JIPipeOutputDataSlot slot,
                          JIPipeData data,
                          JIPipeProgressInfo progressInfo)
```
Writes output data into the provided slot Please note that annotations that are added to all annotations should be set up till this point

Parameters:

slot - Slot instance

data - Added data

progressInfo - data storage progress

addOutputData

public void addOutputData(JIPipeOutputDataSlot slot,
                          JIPipeDataItemStore data,
                          JIPipeProgressInfo progressInfo)

Writes output data into the provided slot Please note that annotations that are added to all annotations should be set up till this point

Parameters:: slot - Slot instance; data - Added data; progressInfo - the progress info

addOutputData

public void addOutputData(String slotName,
                          JIPipeData data,
                          List<JIPipeTextAnnotation> additionalAnnotations,
                          JIPipeTextAnnotationMergeMode mergeStrategy,
                          List<JIPipeDataAnnotation> additionalDataAnnotations,
                          JIPipeDataAnnotationMergeMode dataAnnotationMergeStrategy,
                          JIPipeProgressInfo progressInfo)

Writes output data into the provided slot Please note that annotations should be set up till this point

Parameters:: slotName - Slot name; data - Added data; additionalAnnotations - Annotations that are added additionally to the merged ones; mergeStrategy - how annotations should be merged; progressInfo - storage progress

addOutputData

public void addOutputData(JIPipeOutputDataSlot slot,
                          JIPipeData data,
                          List<JIPipeTextAnnotation> additionalAnnotations,
                          JIPipeTextAnnotationMergeMode mergeStrategy,
                          List<JIPipeDataAnnotation> additionalDataAnnotations,
                          JIPipeDataAnnotationMergeMode dataAnnotationMergeStrategy,
                          JIPipeProgressInfo progressInfo)

Writes output data into the provided slot Please note that annotations that are added to all annotations should be set up till this point

Parameters:: slot - Slot instance; data - Added data; additionalAnnotations - Annotations that are added additionally to the merged ones; mergeStrategy - how annotations should be merged; progressInfo - storage progress

addOutputData

public void addOutputData(JIPipeOutputDataSlot slot,
                          JIPipeData data,
                          List<JIPipeTextAnnotation> additionalAnnotations,
                          JIPipeTextAnnotationMergeMode mergeStrategy,
                          JIPipeProgressInfo progressInfo)

Writes output data into the provided slot Please note that annotations that are added to all annotations should be set up till this point

Parameters:: slot - Slot instance; data - Added data; additionalAnnotations - Annotations that are added additionally to the merged ones; mergeStrategy - how annotations should be merged; progressInfo - data storage progress

addOutputData

public void addOutputData(JIPipeOutputDataSlot slot,
                          JIPipeDataItemStore data,
                          List<JIPipeTextAnnotation> additionalAnnotations,
                          JIPipeTextAnnotationMergeMode mergeStrategy,
                          JIPipeProgressInfo progressInfo)

Writes output data into the provided slot Please note that annotations that are added to all annotations should be set up till this point

Parameters:: slot - Slot instance; data - Added data; additionalAnnotations - Annotations that are added additionally to the merged ones; mergeStrategy - how annotations should be merged; progressInfo - the progress info

getInputTextAnnotations
```
public List<JIPipeTextAnnotation> getInputTextAnnotations(JIPipeDataSlot slot)
```
Gets the original annotations of given slot This returns all annotations (of all rows)

Parameters:

slot - the slot

Returns:

the annotations

getInputTextAnnotations
```
public List<JIPipeTextAnnotation> getInputTextAnnotations(String slotName)
```
Gets the original annotations of given slot This returns all annotations (of all rows)

Parameters:

slotName - the slot

Returns:

the annotations

getInputDataAnnotations
```
public List<JIPipeDataAnnotation> getInputDataAnnotations(JIPipeDataSlot slot)
```
Gets the original annotations of given slot This returns all annotations (of all rows)

Parameters:

slot - the slot

Returns:

the annotations

getInputDataAnnotations
```
public List<JIPipeDataAnnotation> getInputDataAnnotations(String slotName)
```
Gets the original annotations of given slot This returns all annotations (of all rows)

Parameters:

slotName - the slot

Returns:

the annotations