org.hkijena.jipipe.api.nodes

Class JIPipeMergingDataBatch

java.lang.Object

org.hkijena.jipipe.api.nodes.JIPipeMergingDataBatch

All Implemented Interfaces:

Comparable<JIPipeMergingDataBatch>

public class JIPipeMergingDataBatch
extends Object
implements Comparable<JIPipeMergingDataBatch>

Wraps a set of input and output slots that belong together. This is a less restricted variant of JIPipeDataBatch used by JIPipeMergingAlgorithm

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addEmptySlot(JIPipeDataSlot slot) Ensures that the specified slot is registered to the data batch
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(JIPipeDataSlot 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(JIPipeDataSlot 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(JIPipeDataSlot 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(JIPipeDataSlot slot, JIPipeVirtualData data) 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(JIPipeDataSlot slot, JIPipeVirtualData data, List<JIPipeTextAnnotation> additionalAnnotations, JIPipeTextAnnotationMergeMode mergeStrategy) 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(JIPipeDataSlot slot, JIPipeVirtualData data, List<JIPipeTextAnnotation> additionalAnnotations, JIPipeTextAnnotationMergeMode annotationMergeStrategy, List<JIPipeDataAnnotation> additionalDataAnnotations, JIPipeDataAnnotationMergeMode dataAnnotationMergeStrategy)
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
void	addOutputData(String slotName, JIPipeVirtualData data) Writes output data into the provided slot Please note that annotations should be set up till this point
void	addOutputData(String slotName, JIPipeVirtualData data, JIPipeTextAnnotationMergeMode annotationMergeStrategy, List<JIPipeTextAnnotation> additionalAnnotations) Writes output data into the provided slot Please note that annotations should be set up till this point
void	addOutputData(String slotName, JIPipeVirtualData data, List<JIPipeTextAnnotation> additionalAnnotations) Writes output data into the provided slot Please note that annotations should be set up till this point
int	compareTo(JIPipeMergingDataBatch o)
<T extends JIPipeData> List<T>	getInputData(JIPipeDataSlot slot, 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
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
Map<JIPipeDataSlot,Set<Integer>>	getInputSlotRows() Raw access to all data stored in the batch
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()
List<JIPipeTextAnnotation>	getOriginalAnnotations(JIPipeDataSlot slot) Gets the original annotations of given slot
List<JIPipeTextAnnotation>	getOriginalAnnotations(String slotName) Gets the original annotations of given slot
List<JIPipeDataAnnotation>	getOriginalDataAnnotations(JIPipeDataSlot slot) Gets the original annotations of given slot
List<JIPipeDataAnnotation>	getOriginalDataAnnotations(String slotName) Gets the original annotations of given slot
List<JIPipeVirtualData>	getVirtualInputData(JIPipeDataSlot slot) Gets stored data from an input slot
List<JIPipeVirtualData>	getVirtualInputData(String slotName) Gets stored data from an input slot
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) Creates a new dummy slot that contains the data of one input slot and the annotations of this batch

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JIPipeMergingDataBatch

public JIPipeMergingDataBatch(JIPipeGraphNode node)

Creates a new interface

Parameters:

node - The algorithm

JIPipeMergingDataBatch

public JIPipeMergingDataBatch(JIPipeMergingDataBatch other)

Creates a copy

Parameters:

other - the original

Method Detail

getNode

public JIPipeGraphNode getNode()

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

getVirtualInputData

public List<JIPipeVirtualData> getVirtualInputData(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

getVirtualInputData

public List<JIPipeVirtualData> getVirtualInputData(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.

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,
                          JIPipeVirtualData data)

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

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,
                          JIPipeVirtualData data,
                          List<JIPipeTextAnnotation> additionalAnnotations)

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

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,
                          JIPipeVirtualData data,
                          JIPipeTextAnnotationMergeMode annotationMergeStrategy,
                          List<JIPipeTextAnnotation> additionalAnnotations)

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

addOutputData

public void addOutputData(JIPipeDataSlot slot,
                          JIPipeVirtualData data,
                          List<JIPipeTextAnnotation> additionalAnnotations,
                          JIPipeTextAnnotationMergeMode annotationMergeStrategy,
                          List<JIPipeDataAnnotation> additionalDataAnnotations,
                          JIPipeDataAnnotationMergeMode dataAnnotationMergeStrategy)

addOutputData

public void addOutputData(JIPipeDataSlot 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(JIPipeDataSlot slot,
                          JIPipeVirtualData data)

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

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(JIPipeDataSlot 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(JIPipeDataSlot 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(JIPipeDataSlot slot,
                          JIPipeVirtualData data,
                          List<JIPipeTextAnnotation> additionalAnnotations,
                          JIPipeTextAnnotationMergeMode mergeStrategy)

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

getOriginalAnnotations

public List<JIPipeTextAnnotation> getOriginalAnnotations(JIPipeDataSlot slot)

Gets the original annotations of given slot

Parameters:

slot - the slot

Returns:

the annotations

getOriginalAnnotations

public List<JIPipeTextAnnotation> getOriginalAnnotations(String slotName)

Gets the original annotations of given slot

Parameters:

slotName - the slot

Returns:

the annotations

getOriginalDataAnnotations

public List<JIPipeDataAnnotation> getOriginalDataAnnotations(JIPipeDataSlot slot)

Gets the original annotations of given slot

Parameters:

slot - the slot

Returns:

the annotations

getOriginalDataAnnotations

public List<JIPipeDataAnnotation> getOriginalDataAnnotations(String slotName)

Gets the original annotations of given slot

Parameters:

slotName - the slot

Returns:

the annotations

isEmpty

public boolean isEmpty()

Returns true if no data is referenced

Returns:

if no data is referenced

isIncomplete

public boolean isIncomplete()

Returns true if there is at least one slot that has no rows attached to it

Returns:

if the batch is incomplete

isSingle

public boolean isSingle()

Returns true if each slot only has one row

Returns:

if the batch is single

toDummySlot

public JIPipeDataSlot toDummySlot(JIPipeDataSlotInfo info,
                                  JIPipeGraphNode node,
                                  JIPipeDataSlot sourceSlot)

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

Returns:

a new dummy slot

compareTo

public int compareTo(JIPipeMergingDataBatch o)

Specified by:

compareTo in interface Comparable<JIPipeMergingDataBatch>

addEmptySlot

public void addEmptySlot(JIPipeDataSlot slot)

Ensures that the specified slot is registered to the data batch

Parameters:

slot - the slot