org.hkijena.jipipe.api.nodes.iterationstep

Class JIPipeSingleIterationStep

java.lang.Object

org.hkijena.jipipe.api.nodes.iterationstep.JIPipeSingleIterationStep

All Implemented Interfaces:

Comparable<JIPipeSingleIterationStep>, JIPipeIterationStep

public class JIPipeSingleIterationStep
extends Object
implements JIPipeIterationStep, Comparable<JIPipeSingleIterationStep>

Wraps a set of input and output slots that belong together This can be used for convenience

Constructor Summary

Constructors

Constructor and Description
JIPipeSingleIterationStep(JIPipeGraphNode node) Creates a new interface
JIPipeSingleIterationStep(JIPipeSingleIterationStep other) Creates a copy

Method Summary

Modifier and Type	Method and Description
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(Collection<JIPipeTextAnnotation> annotations, JIPipeTextAnnotationMergeMode strategy) Adds annotations to the merged annotation storage of this interface.
void	addOutputData(JIPipeOutputDataSlot slot, JIPipeDataItemStore virtualData, 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(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, 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, JIPipeTextAnnotationMergeMode mergeStrategy, 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(JIPipeSingleIterationStep o)
JIPipeDataContext	createNewContext() Creates a context for new data that inherits direct predecessors from this iteration step's input
<T extends JIPipeData> T	getInputData(JIPipeDataSlot slot, Class<T> dataClass, JIPipeProgressInfo progressInfo) Gets stored data from an input slot
<T extends JIPipeData> T	getInputData(String slotName, Class<T> dataClass, JIPipeProgressInfo progressInfo) Gets stored data from an input slot
List<JIPipeDataAnnotation>	getInputDataAnnotations(JIPipeDataSlot slot) Gets the original annotations of given slot
List<JIPipeDataAnnotation>	getInputDataAnnotations(String slotName) Gets the original annotations of given slot
int	getInputRow(JIPipeDataSlot slot) Returns the row of the data in the original data slot
int	getInputRow(String slot) Returns the row of the data in the original data slot
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,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
List<JIPipeTextAnnotation>	getInputTextAnnotations(String slotName) 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
void	removeMergedDataAnnotation(String name) Removes a data annotation
void	removeMergedTextAnnotation(String name) Removes an annotation of provided type
void	setInputData(JIPipeDataSlot slot, int row) Sets the data row of a given slot.
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

JIPipeSingleIterationStep

public JIPipeSingleIterationStep(JIPipeGraphNode node)

Creates a new interface

Parameters:

node - The algorithm

JIPipeSingleIterationStep

public JIPipeSingleIterationStep(JIPipeSingleIterationStep 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

getInputTextAnnotations

public List<JIPipeTextAnnotation> getInputTextAnnotations(JIPipeDataSlot slot)

Gets the original annotations of given slot

Parameters:

slot - the slot

Returns:

the annotations

getInputTextAnnotations

public List<JIPipeTextAnnotation> getInputTextAnnotations(String slotName)

Gets the original annotations of given slot

Parameters:

slotName - the slot

Returns:

the annotations

getInputDataAnnotations

public List<JIPipeDataAnnotation> getInputDataAnnotations(JIPipeDataSlot slot)

Gets the original annotations of given slot

Parameters:

slot - the slot

Returns:

the annotations

getInputDataAnnotations

public List<JIPipeDataAnnotation> getInputDataAnnotations(String slotName)

Gets the original annotations of given slot

Parameters:

slotName - the slot

Returns:

the annotations

getInputSlotRows

public Map<JIPipeDataSlot,Integer> getInputSlotRows()

Raw access to all data stored in the batch

Returns:

map from data slot to row index

setInputData

public void setInputData(JIPipeDataSlot slot,
                         int row)

Sets 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

addMergedTextAnnotations

public void addMergedTextAnnotations(Collection<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> 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 - storage progress

Returns:

Input data with provided name. Returns null if no data is available.

getInputData

public <T extends JIPipeData> 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 - storage progress

Returns:

Input data with provided name. Returns null if no data is available

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.

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

removeMergedTextAnnotation

public void removeMergedTextAnnotation(String name)

Removes an annotation of provided type

Parameters:

name - removed annotation

removeMergedDataAnnotation

public void removeMergedDataAnnotation(String name)

Removes a data annotation

Parameters:

name - the name

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

createNewContext

public JIPipeDataContext createNewContext()

Creates a context for new data that inherits direct predecessors from this iteration step's input

Returns:

the new context

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 - storage progress

addOutputData

public void addOutputData(String slotName,
                          JIPipeData data,
                          List<JIPipeTextAnnotation> additionalAnnotations,
                          JIPipeTextAnnotationMergeMode mergeStrategy,
                          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(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,
                          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 - 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 - 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,
                          JIPipeDataItemStore virtualData,
                          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

virtualData - Added data

additionalAnnotations - Annotations that are added additionally to the merged ones

mergeStrategy - how annotations should be merged

progressInfo - storage progress

toDummySlot

public 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

Parameters:

info - info of the new slot

node - the node that will own the new slot

sourceSlot - the source slot

progressInfo - the progress info

Returns:

a new dummy slot

getInputRow

public int getInputRow(String slot)

Returns the row of the data in the original data slot

Parameters:

slot - the slot name

Returns:

the row or -1 if no data is present

getInputRow

public int getInputRow(JIPipeDataSlot slot)

Returns the row of the data in the original data slot

Parameters:

slot - the slot

Returns:

the row or -1 if no data is present

compareTo

public int compareTo(JIPipeSingleIterationStep o)

Specified by:

compareTo in interface Comparable<JIPipeSingleIterationStep>

toString

public String toString()

Overrides:

toString in class Object

getInputSlotRowIndices

public Set<Integer> getInputSlotRowIndices(String slotName)

Description copied from interface: JIPipeIterationStep

Returns the referenced indices of given input slot name

Specified by:

getInputSlotRowIndices in interface JIPipeIterationStep

Parameters:

slotName - the slot name

Returns:

the indices

getInputSlotNames

public Set<String> getInputSlotNames()

Description copied from interface: JIPipeIterationStep

Gets the names of all input slots that are referenced

Specified by:

getInputSlotNames in interface JIPipeIterationStep

Returns:

the names of the input slots

getInputSlots

public Set<JIPipeDataSlot> getInputSlots()

Description copied from interface: JIPipeIterationStep

Gets the input slots that are referenced

Specified by:

getInputSlots in interface JIPipeIterationStep

Returns:

the input slots