org.hkijena.jipipe.plugins.omero.nodes.annotate

Class AnnotateOMERODatasetReferenceAlgorithm

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.omero.nodes.annotate.AnnotateOMERODatasetReferenceAlgorithm

All Implemented Interfaces:

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

public class AnnotateOMERODatasetReferenceAlgorithm
extends JIPipeSimpleIteratingAlgorithm
implements OMEROCredentialAccessNode

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

Method Summary

Modifier and Type	Method and Description
JIPipeTextAnnotationMergeMode	getAnnotationMergeMode()
OptionalTextAnnotationNameParameter	getDescriptionAnnotation()
void	getEnvironmentDependencies(List<JIPipeEnvironment> target) Gathers all known external environments
OptionalTextAnnotationNameParameter	getIdAnnotation()
OMEROKeyValuePairToAnnotationImporter	getKeyValuePairToAnnotationImporter()
OptionalTextAnnotationNameParameter	getNameAnnotation()
OptionalOMEROCredentialsEnvironment	getOverrideCredentials()
OMEROTagToAnnotationImporter	getTagToAnnotationImporter()
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
protected void	runIteration(JIPipeSingleIterationStep iterationStep, JIPipeIterationContext iterationContext, JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo) Runs code on one data row
void	setAnnotationMergeMode(JIPipeTextAnnotationMergeMode annotationMergeMode)
void	setDescriptionAnnotation(OptionalTextAnnotationNameParameter descriptionAnnotation)
void	setIdAnnotation(OptionalTextAnnotationNameParameter idAnnotation)
void	setNameAnnotation(OptionalTextAnnotationNameParameter nameAnnotation)
void	setOverrideCredentials(OptionalOMEROCredentialsEnvironment overrideCredentials)

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

createUIInputSlotIconDescriptionMenuItems, generateDataBatchesGenerationResult, getAdaptiveParameterSettings, getDataBatchGenerationSettings, getGenerationSettingsInterface, getLocalParallelizationNumThreads, getParallelizationBatchSize, isAllowEmptyIterationStep, isParameterUIVisible, isParameterUIVisible, runParameterSet, runPassThrough, setLocalParallelizationNumThreads, 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, 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.plugins.omero.OMEROCredentialAccessNode

getConfiguredOMEROCredentialsEnvironment, reportConfiguredOMEROEnvironmentValidity

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

AnnotateOMERODatasetReferenceAlgorithm

public AnnotateOMERODatasetReferenceAlgorithm(JIPipeNodeInfo info)

AnnotateOMERODatasetReferenceAlgorithm

public AnnotateOMERODatasetReferenceAlgorithm(AnnotateOMERODatasetReferenceAlgorithm other)

Method Detail

getEnvironmentDependencies

public void getEnvironmentDependencies(List<JIPipeEnvironment> target)

Description copied from class: JIPipeGraphNode

Gathers all known external environments

Overrides:

getEnvironmentDependencies in class JIPipeGraphNode

Parameters:

target - the list where the external environments will be gathered

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

getOverrideCredentials

public OptionalOMEROCredentialsEnvironment getOverrideCredentials()

Specified by:

getOverrideCredentials in interface OMEROCredentialAccessNode

setOverrideCredentials

public void setOverrideCredentials(OptionalOMEROCredentialsEnvironment overrideCredentials)

getNameAnnotation

public OptionalTextAnnotationNameParameter getNameAnnotation()

setNameAnnotation

public void setNameAnnotation(OptionalTextAnnotationNameParameter nameAnnotation)

getDescriptionAnnotation

public OptionalTextAnnotationNameParameter getDescriptionAnnotation()

setDescriptionAnnotation

public void setDescriptionAnnotation(OptionalTextAnnotationNameParameter descriptionAnnotation)

getKeyValuePairToAnnotationImporter

public OMEROKeyValuePairToAnnotationImporter getKeyValuePairToAnnotationImporter()

getTagToAnnotationImporter

public OMEROTagToAnnotationImporter getTagToAnnotationImporter()

getIdAnnotation

public OptionalTextAnnotationNameParameter getIdAnnotation()

setIdAnnotation

public void setIdAnnotation(OptionalTextAnnotationNameParameter idAnnotation)

getAnnotationMergeMode

public JIPipeTextAnnotationMergeMode getAnnotationMergeMode()

setAnnotationMergeMode

public void setAnnotationMergeMode(JIPipeTextAnnotationMergeMode annotationMergeMode)

reportValidity

public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Overrides:

reportValidity in class JIPipeSimpleIteratingAlgorithm

Parameters:

reportContext - the report context

report - the report to be added to