org.hkijena.jipipe.extensions.filesystem.algorithms

Class SimplePathAnnotationGenerator

java.lang.Object

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

org.hkijena.jipipe.api.nodes.JIPipeParameterSlotAlgorithm

org.hkijena.jipipe.api.nodes.JIPipeSimpleIteratingAlgorithm

org.hkijena.jipipe.extensions.filesystem.algorithms.SimplePathAnnotationGenerator

All Implemented Interfaces:

JIPipeValidatable, JIPipeAdaptiveParametersAlgorithm, JIPipeDataBatchAlgorithm, JIPipeParallelizedAlgorithm, JIPipeParameterCollection

public class SimplePathAnnotationGenerator
extends JIPipeSimpleIteratingAlgorithm

Algorithm that generates annotations from folder names

Nested Class Summary

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

JIPipeAlgorithm.StateSerializer

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

JIPipeGraphNode.BaseDirectoryChangedEvent, JIPipeGraphNode.Serializer

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

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Field Summary

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

SLOT_PARAMETERS

Constructor Summary

Constructors

Constructor and Description
SimplePathAnnotationGenerator(JIPipeNodeInfo info) Creates a new instance
SimplePathAnnotationGenerator(SimplePathAnnotationGenerator other) Copies the algorithm

Method Summary

Modifier and Type	Method and Description
JIPipeTextAnnotationMergeMode	getAnnotationMergeStrategy()
String	getGeneratedAnnotation()
boolean	isFullPath()
boolean	isRemoveExtensions()
void	reportValidity(JIPipeIssueReport report) Generates a validity report
protected void	runIteration(JIPipeDataBatch dataBatch, JIPipeProgressInfo progressInfo) Runs code on one data row
void	setAnnotationMergeStrategy(JIPipeTextAnnotationMergeMode annotationMergeStrategy)
void	setFullPath(boolean fullPath)
void	setGeneratedAnnotation(String generatedAnnotation)
void	setRemoveExtensions(boolean removeExtensions)

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

generateDataBatchesDryRun, getAdaptiveParameterSettings, getDataBatchGenerationSettings, getGenerationSettingsInterface, getParallelizationBatchSize, isParallelizationEnabled, isParameterUIVisible, isParameterUIVisible, runParameterSet, runPassThrough, setParallelizationEnabled, supportsParallelization

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

getDataInputSlotCount, getDataInputSlots, getFirstInputSlot, getNonParameterInputSlots, getParameterSlot, getParameterSlotAlgorithmSettings, run

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

canAutoPassThrough, canPassThrough, getStateId, getThreadPool, isEnabled, isPassThrough, isPostprocessor, isPreprocessor, loadExample, runPassThrough, setEnabled, setPassThrough, setThreadPool

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

canUserDelete, clearLocations, clearSlotData, copySlotConfiguration, duplicate, fromJson, fromJsonNode, getAliasIdInParentGraph, getBaseDirectory, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getDependencies, getDisplayName, getEventBus, 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, onSlotConnected, onSlotDisconnected, registerSubParameter, renderInputSlots, renderOutputSlots, setAllSlotsVirtual, setBaseDirectory, setBookmarked, setCustomDescription, setCustomName, setInfo, setInternalStoragePath, setLocations, setLocationWithin, setLocationWithin, setParentGraph, setProjectDirectory, setScratchBaseDirectory, setSlotConfiguration, setStoragePath, toggleSlot, toJson, triggerSlotsChangedEvent, updateGraphNodeSlots, updateSlotInheritance

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.JIPipeValidatable

generateValidityReport

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

addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Constructor Detail

SimplePathAnnotationGenerator

public SimplePathAnnotationGenerator(JIPipeNodeInfo info)

Creates a new instance

Parameters:

info - The algorithm info

SimplePathAnnotationGenerator

public SimplePathAnnotationGenerator(SimplePathAnnotationGenerator other)

Copies the algorithm

Parameters:

other - The original

Method Detail

runIteration

protected void runIteration(JIPipeDataBatch dataBatch,
                            JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeSimpleIteratingAlgorithm

Runs code on one data row

Specified by:

runIteration in class JIPipeSimpleIteratingAlgorithm

Parameters:

dataBatch - The data interface

progressInfo - the progress info from the run

reportValidity

public void reportValidity(JIPipeIssueReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Overrides:

reportValidity in class JIPipeSimpleIteratingAlgorithm

Parameters:

report - the report to be added to

getGeneratedAnnotation

public String getGeneratedAnnotation()

setGeneratedAnnotation

public void setGeneratedAnnotation(String generatedAnnotation)

isFullPath

public boolean isFullPath()

setFullPath

public void setFullPath(boolean fullPath)

isRemoveExtensions

public boolean isRemoveExtensions()

setRemoveExtensions

public void setRemoveExtensions(boolean removeExtensions)

getAnnotationMergeStrategy

public JIPipeTextAnnotationMergeMode getAnnotationMergeStrategy()

setAnnotationMergeStrategy

public void setAnnotationMergeStrategy(JIPipeTextAnnotationMergeMode annotationMergeStrategy)