org.hkijena.jipipe.plugins.annotation.algorithms

Class ExtractDataAnnotation

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.api.nodes.algorithm.JIPipeSimpleIteratingAlgorithm

org.hkijena.jipipe.plugins.annotation.algorithms.ExtractDataAnnotation

All Implemented Interfaces:

JIPipeSlotConfiguration.SlotConfigurationChangedEventListener, JIPipeFunctionallyComparable, JIPipeIterationStepAlgorithm, JIPipeAdaptiveParametersAlgorithm, JIPipeParallelizedAlgorithm, JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeValidatable

public class ExtractDataAnnotation
extends JIPipeSimpleIteratingAlgorithm

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
ExtractDataAnnotation(ExtractDataAnnotation other)
ExtractDataAnnotation(JIPipeNodeInfo info)

Method Summary

Modifier and Type	Method and Description
OptionalStringParameter	getAnnotateWithCurrentData()
StringQueryExpression	getAnnotationNameQuery()
boolean	isIgnoreMissingAnnotations()
boolean	isKeepCurrentAnnotation()
boolean	isKeepOtherDataAnnotations()
protected void	runIteration(JIPipeSingleIterationStep iterationStep, JIPipeIterationContext iterationContext, JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo) Runs code on one data row
void	setAnnotateWithCurrentData(OptionalStringParameter annotateWithCurrentData)
void	setAnnotationNameQuery(StringQueryExpression annotationNameQuery)
void	setIgnoreMissingAnnotations(boolean ignoreMissingAnnotations)
void	setKeepCurrentAnnotation(boolean keepCurrentAnnotation)
void	setKeepOtherDataAnnotations(boolean keepOtherDataAnnotations)

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

createUIInputSlotIconDescriptionMenuItems, generateDataBatchesGenerationResult, getAdaptiveParameterSettings, getDataBatchGenerationSettings, getGenerationSettingsInterface, getParallelizationBatchSize, isAllowEmptyIterationStep, isParameterUIVisible, isParameterUIVisible, reportValidity, runParameterSet, runPassThrough, supportsParallelization

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

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

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

canAutoPassThrough, canPassThrough, functionallyEquals, getDefaultCustomExpressionVariables, getRuntimePartition, isEnabled, isEnableDefaultCustomExpressionVariables, isPassThrough, isPostprocessor, isPreprocessor, isSkipped, loadExample, onDeserialized, runPassThrough, 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.nodes.iterationstep.JIPipeIterationStepAlgorithm

generateDataBatchesDryRun

Methods inherited from interface org.hkijena.jipipe.api.nodes.JIPipeAdaptiveParametersAlgorithm

installUIOverrideParameterEditor, installUIParameterOptions

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

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

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

Constructor Detail

ExtractDataAnnotation

public ExtractDataAnnotation(JIPipeNodeInfo info)

ExtractDataAnnotation

public ExtractDataAnnotation(ExtractDataAnnotation other)

Method Detail

runIteration

protected void runIteration(JIPipeSingleIterationStep iterationStep,
                            JIPipeIterationContext iterationContext,
                            JIPipeGraphNodeRunContext runContext,
                            JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeSimpleIteratingAlgorithm

Runs code on one data row

Specified by:

runIteration in class JIPipeSimpleIteratingAlgorithm

Parameters:

iterationStep - The data interface

iterationContext - the iteration context

runContext - the run context

progressInfo - the progress info from the run

getAnnotationNameQuery

public StringQueryExpression getAnnotationNameQuery()

setAnnotationNameQuery

public void setAnnotationNameQuery(StringQueryExpression annotationNameQuery)

isIgnoreMissingAnnotations

public boolean isIgnoreMissingAnnotations()

setIgnoreMissingAnnotations

public void setIgnoreMissingAnnotations(boolean ignoreMissingAnnotations)

isKeepOtherDataAnnotations

public boolean isKeepOtherDataAnnotations()

setKeepOtherDataAnnotations

public void setKeepOtherDataAnnotations(boolean keepOtherDataAnnotations)

getAnnotateWithCurrentData

public OptionalStringParameter getAnnotateWithCurrentData()

setAnnotateWithCurrentData

public void setAnnotateWithCurrentData(OptionalStringParameter annotateWithCurrentData)

isKeepCurrentAnnotation

public boolean isKeepCurrentAnnotation()

setKeepCurrentAnnotation

public void setKeepCurrentAnnotation(boolean keepCurrentAnnotation)