org.hkijena.jipipe.plugins.annotation.algorithms

Class AnnotateWithAnnotationTable

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

org.hkijena.jipipe.api.nodes.algorithm.JIPipeParameterSlotAlgorithm

org.hkijena.jipipe.plugins.annotation.algorithms.AnnotateWithAnnotationTable

All Implemented Interfaces:

JIPipeSlotConfiguration.SlotConfigurationChangedEventListener, JIPipeFunctionallyComparable, JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeValidatable

public class AnnotateWithAnnotationTable
extends JIPipeParameterSlotAlgorithm

Algorithm that merges the annotations of all inputs and outputs the data with the shared annotations

Nested Class Summary

Nested classes/interfaces inherited from class org.hkijena.jipipe.api.nodes.JIPipeGraphNode

JIPipeGraphNode.BaseDirectoryChangedEvent, JIPipeGraphNode.BaseDirectoryChangedEventEmitter, JIPipeGraphNode.BaseDirectoryChangedEventListener, JIPipeGraphNode.NodeSlotsChangedEvent, JIPipeGraphNode.NodeSlotsChangedEventEmitter, JIPipeGraphNode.NodeSlotsChangedEventListener, JIPipeGraphNode.Serializer

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Field Summary

Fields inherited from class org.hkijena.jipipe.api.nodes.algorithm.JIPipeParameterSlotAlgorithm

SLOT_PARAMETERS

Constructor Summary

Constructors

Constructor and Description
AnnotateWithAnnotationTable(AnnotateWithAnnotationTable other) Creates a copy
AnnotateWithAnnotationTable(JIPipeNodeInfo info) Creates a new instance

Method Summary

Modifier and Type	Method and Description
boolean	canPassThrough() Returns true if the algorithm can apply pass-through.
JIPipeIteratingAlgorithmIterationStepGenerationSettings	getTableMergeSettings()
boolean	isDiscardExistingAnnotations()
void	runParameterSet(JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo, List<JIPipeTextAnnotation> parameterAnnotations) Runs a parameter set iteration
protected void	runPassThrough(JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo) Runs the pass through.
void	setDiscardExistingAnnotations(boolean discardExistingAnnotations)

Methods inherited from class org.hkijena.jipipe.api.nodes.algorithm.JIPipeParameterSlotAlgorithm

createUIInputSlotIconDescriptionMenuItems, getDataInputSlotCount, getDataInputSlots, getFirstInputSlot, getNonParameterInputSlots, getParameterSlot, getParameterSlotAlgorithmSettings, getUIInputSlotIcon, getUIInputSlotIconBaseDimensions, isParameterUIVisible, onParameterChanged, run

Methods inherited from class org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

canAutoPassThrough, functionallyEquals, getDefaultCustomExpressionVariables, getRuntimePartition, isEnabled, isEnableDefaultCustomExpressionVariables, isParameterUIVisible, isPassThrough, isPostprocessor, isPreprocessor, isSkipped, loadExample, onDeserialized, reportValidity, setEnabled, setPassThrough, setRuntimePartition, setSkipped

Methods inherited from class org.hkijena.jipipe.api.nodes.JIPipeGraphNode

archiveTo, canUserDelete, clearLocations, clearSlotData, copySlotConfiguration, duplicate, emitNodeSlotsChangedEvent, fromJson, getAliasIdInParentGraph, getBaseDirectory, getBaseDirectoryChangedEventEmitter, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getCustomName, getDependencies, getDisplayName, getEnvironmentDependencies, getFirstOutputSlot, getInfo, getInputSlot, getInputSlotMap, getInputSlotOrder, getInputSlots, getInputSlotsWithRole, getInternalStoragePath, getLastInputSlot, getLastOutputSlot, getName, getNewScratch, getNodeSlotsChangedEventEmitter, getNodeUILocationPerViewModePerCompartment, getNodeUILocationWithin, getOpenInputSlots, getOutputSlot, getOutputSlotMap, getOutputSlots, getOutputSlotsWithRole, getParentGraph, getProject, getProjectCompartment, getProjectDataDirs, getProjectDirectory, getRuntimeProject, getScratchBaseDirectory, getSlotConfiguration, getStoragePath, getTextDescription, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isUiLocked, isVisibleIn, onSlotConfigurationChanged, renderInputSlots, renderOutputSlots, setBaseDirectory, setBookmarked, setCustomDescription, setCustomName, setInfo, setInternalStoragePath, setNodeUILocationPerViewModePerCompartment, setNodeUILocationWithin, setNodeUILocationWithin, setParentGraph, setProjectDirectory, setRuntimeProject, setScratchBaseDirectory, setSlotConfiguration, setStoragePath, setUiLocked, toggleSlot, toJson, updateGraphNodeSlots

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.validation.JIPipeValidatable

generateValidityReport

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection.ParameterUIChangedEventListener

onParameterUIChanged

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection.ParameterStructureChangedEventListener

onParameterStructureChanged

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Constructor Detail

AnnotateWithAnnotationTable

public AnnotateWithAnnotationTable(JIPipeNodeInfo info)

Creates a new instance

Parameters:

info - the info

AnnotateWithAnnotationTable

public AnnotateWithAnnotationTable(AnnotateWithAnnotationTable other)

Creates a copy

Parameters:

other - the original

Method Detail

getTableMergeSettings

public JIPipeIteratingAlgorithmIterationStepGenerationSettings getTableMergeSettings()

runParameterSet

public void runParameterSet(JIPipeGraphNodeRunContext runContext,
                            JIPipeProgressInfo progressInfo,
                            List<JIPipeTextAnnotation> parameterAnnotations)

Description copied from class: JIPipeParameterSlotAlgorithm

Runs a parameter set iteration

Specified by:

runParameterSet in class JIPipeParameterSlotAlgorithm

Parameters:

runContext - the run context

progressInfo - progress info from the run

parameterAnnotations - parameter annotations

canPassThrough

public boolean canPassThrough()

Description copied from class: JIPipeAlgorithm

Returns true if the algorithm can apply pass-through. Override this method to implement your own checks

Overrides:

canPassThrough in class JIPipeAlgorithm

Returns:

true if the algorithm can apply pass-through

runPassThrough

protected void runPassThrough(JIPipeGraphNodeRunContext runContext,
                              JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeAlgorithm

Runs the pass through. Override this for custom implementations if you want

Overrides:

runPassThrough in class JIPipeAlgorithm

Parameters:

runContext - the context of the running operation

progressInfo - the progress

isDiscardExistingAnnotations

public boolean isDiscardExistingAnnotations()

setDiscardExistingAnnotations

public void setDiscardExistingAnnotations(boolean discardExistingAnnotations)