public class IteratingFormProcessorAlgorithm extends JIPipeAlgorithm implements JIPipeDataBatchAlgorithm
JIPipeGraphNode.BaseDirectoryChangedEvent, JIPipeGraphNode.Serializer
JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent
Modifier and Type | Field and Description |
---|---|
static String |
SLOT_FORMS |
Constructor and Description |
---|
IteratingFormProcessorAlgorithm(IteratingFormProcessorAlgorithm other) |
IteratingFormProcessorAlgorithm(JIPipeNodeInfo info) |
Modifier and Type | Method and Description |
---|---|
protected boolean |
canPassThrough()
Returns true if the algorithm can apply pass-through.
|
static void |
extractRestoredAnnotations(JIPipeMergingDataBatch dataBatch,
Map<String,JIPipeTextAnnotation> preFormAnnotations,
JIPipeDataSlot inputSlot,
int row,
List<JIPipeTextAnnotation> annotations)
Extracts original annotations into the annotation list
|
List<JIPipeMergingDataBatch> |
generateDataBatchesDryRun(List<JIPipeInputDataSlot> slots,
JIPipeProgressInfo progressInfo)
Generates data batches.
|
JIPipeMergingAlgorithmDataBatchGenerationSettings |
getDataBatchGenerationSettings() |
List<JIPipeInputDataSlot> |
getDataInputSlots()
Method that can be overwritten by child classes.
|
JIPipeDataBatchGenerationSettings |
getGenerationSettingsInterface()
Returns the batch generation settings as interface
|
String |
getTabAnnotation() |
boolean |
isParameterUIVisible(JIPipeParameterTree tree,
JIPipeParameterCollection subParameter)
Allows to override the visibility of sub-parameters inside the UI
|
boolean |
isRestoreAnnotations() |
void |
run(JIPipeProgressInfo progressInfo)
Runs the workload
|
void |
setRestoreAnnotations(boolean restoreAnnotations) |
void |
setTabAnnotation(String tabAnnotation) |
canAutoPassThrough, functionallyEquals, getThreadPool, isEnabled, isParameterUIVisible, isPassThrough, isPostprocessor, isPreprocessor, loadExample, reportValidity, runPassThrough, setEnabled, setPassThrough, setThreadPool
archiveTo, canUserDelete, clearLocations, clearSlotData, copySlotConfiguration, duplicate, fromJson, fromJsonNode, getAliasIdInParentGraph, getBaseDirectory, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getDependencies, getDisplayName, getEventBus, getFirstInputSlot, getFirstOutputSlot, getInfo, getInputSlot, getInputSlotMap, getInputSlotOrder, getInputSlots, getInputSlotsWithRole, getInternalStoragePath, getLastInputSlot, getLastOutputSlot, getLocations, getLocationWithin, getName, getNewScratch, getOpenInputSlots, getOutputSlot, getOutputSlotMap, getOutputSlots, getOutputSlotsWithRole, getParentGraph, getProjectCompartment, getProjectDirectory, getScratchBaseDirectory, getSlotConfiguration, getStoragePath, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isVisibleIn, onDeserialized, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, onSlotConfigurationChanged, registerSubParameter, renderInputSlots, renderOutputSlots, setBaseDirectory, setBookmarked, setCustomDescription, setCustomName, setInfo, setInternalStoragePath, setLocations, setLocationWithin, setLocationWithin, setParentGraph, setProjectDirectory, setScratchBaseDirectory, setSlotConfiguration, setStoragePath, toggleSlot, toJson, triggerSlotsChangedEvent, updateGraphNodeSlots
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
generateValidityReport
addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange
public static final String SLOT_FORMS
public IteratingFormProcessorAlgorithm(JIPipeNodeInfo info)
public IteratingFormProcessorAlgorithm(IteratingFormProcessorAlgorithm other)
public static void extractRestoredAnnotations(JIPipeMergingDataBatch dataBatch, Map<String,JIPipeTextAnnotation> preFormAnnotations, JIPipeDataSlot inputSlot, int row, List<JIPipeTextAnnotation> annotations)
dataBatch
- the data batchpreFormAnnotations
- annotations before the form was appliedinputSlot
- the input slotrow
- row of the data in the input slotannotations
- target listpublic void run(JIPipeProgressInfo progressInfo)
JIPipeGraphNode
run
in class JIPipeAlgorithm
progressInfo
- progress passed from the runnerprotected boolean canPassThrough()
JIPipeAlgorithm
canPassThrough
in class JIPipeAlgorithm
public boolean isRestoreAnnotations()
public void setRestoreAnnotations(boolean restoreAnnotations)
public String getTabAnnotation()
public void setTabAnnotation(String tabAnnotation)
public JIPipeMergingAlgorithmDataBatchGenerationSettings getDataBatchGenerationSettings()
public boolean isParameterUIVisible(JIPipeParameterTree tree, JIPipeParameterCollection subParameter)
JIPipeParameterCollection
isParameterUIVisible
in interface JIPipeParameterCollection
tree
- the parameter tree that is used to access this parametersubParameter
- a sub parameterpublic JIPipeDataBatchGenerationSettings getGenerationSettingsInterface()
JIPipeDataBatchAlgorithm
getGenerationSettingsInterface
in interface JIPipeDataBatchAlgorithm
public List<JIPipeInputDataSlot> getDataInputSlots()
JIPipeGraphNode
getDataInputSlots
in class JIPipeGraphNode
public List<JIPipeMergingDataBatch> generateDataBatchesDryRun(List<JIPipeInputDataSlot> slots, JIPipeProgressInfo progressInfo)
JIPipeDataBatchAlgorithm
generateDataBatchesDryRun
in interface JIPipeDataBatchAlgorithm
slots
- the data slotsprogressInfo
- the progressCopyright © 2020–2023 Leibniz Institute for Natural Product Research and Infection Biology - Hans Knöll Institute (HKI). All rights reserved.