org.hkijena.jipipe.plugins.filesystem.datasources

Class FolderDataSource

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

org.hkijena.jipipe.plugins.filesystem.datasources.FolderDataSource

All Implemented Interfaces:

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

public class FolderDataSource
extends JIPipeAlgorithm

Provides an input folder

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

Constructor Summary

Constructors

Constructor and Description
FolderDataSource(FolderDataSource other) Copies the algorithm
FolderDataSource(JIPipeNodeInfo info) Initializes the algorithm

Method Summary

Modifier and Type	Method and Description
void	archiveTo(JIPipeWriteDataStorage projectStorage, JIPipeWriteDataStorage wrappedExternalStorage, JIPipeProgressInfo progressInfo, Path originalBaseDirectory) Called when the node is being archived into the specified storage.
Path	getAbsoluteFolderPath()
Path	getFolderPath()
boolean	isNeedsToExist()
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	run(JIPipeGraphNodeRunContext runContext, JIPipeProgressInfo progressInfo) Runs the workload
void	setBaseDirectory(Path baseDirectory) Sets the current work directory of this algorithm.
void	setFolderPath(Path folderPath) Sets the folder path
void	setNeedsToExist(boolean needsToExist)

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

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

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

canUserDelete, clearLocations, clearSlotData, copySlotConfiguration, createUIInputSlotIconDescriptionMenuItems, duplicate, emitNodeSlotsChangedEvent, fromJson, getAliasIdInParentGraph, getBaseDirectory, getBaseDirectoryChangedEventEmitter, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getCustomName, getDataInputSlots, getDependencies, getDisplayName, getEnvironmentDependencies, getFirstInputSlot, 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, getUIInputSlotIcon, getUIInputSlotIconBaseDimensions, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isUiLocked, isVisibleIn, onParameterChanged, onSlotConfigurationChanged, renderInputSlots, renderOutputSlots, 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

FolderDataSource

public FolderDataSource(JIPipeNodeInfo info)

Initializes the algorithm

Parameters:

info - Algorithm info

FolderDataSource

public FolderDataSource(FolderDataSource other)

Copies the algorithm

Parameters:

other - The original

Method Detail

run

public void run(JIPipeGraphNodeRunContext runContext,
                JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeGraphNode

Runs the workload

Overrides:

run in class JIPipeAlgorithm

Parameters:

runContext - the context of the run process

progressInfo - progress passed from the runner

getFolderPath

public Path getFolderPath()

Returns:

The folder path

setFolderPath

public void setFolderPath(Path folderPath)

Sets the folder path

Parameters:

folderPath - The folder path

isNeedsToExist

public boolean isNeedsToExist()

setNeedsToExist

public void setNeedsToExist(boolean needsToExist)

archiveTo

public void archiveTo(JIPipeWriteDataStorage projectStorage,
                      JIPipeWriteDataStorage wrappedExternalStorage,
                      JIPipeProgressInfo progressInfo,
                      Path originalBaseDirectory)

Description copied from class: JIPipeGraphNode

Called when the node is being archived into the specified storage. The function is called on the copy of the node

Overrides:

archiveTo in class JIPipeGraphNode

Parameters:

projectStorage - the storage where the data will be archived. storage where the project itself is located.

wrappedExternalStorage - storage where wrapped external files are put

progressInfo - the progress info

originalBaseDirectory - current project directory

getAbsoluteFolderPath

public Path getAbsoluteFolderPath()

Returns:

The folder path as absolute path

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 JIPipeAlgorithm

Parameters:

reportContext - the report context

report - the report to be added to

setBaseDirectory

public void setBaseDirectory(Path baseDirectory)

Description copied from class: JIPipeGraphNode

Sets the current work directory of this algorithm. This is used internally to allow loading data from relative paths. This triggers a JIPipeGraphNode.BaseDirectoryChangedEvent that can be received by JIPipeDataSlot instances to adapt to the work directory.

Overrides:

setBaseDirectory in class JIPipeGraphNode

Parameters:

baseDirectory - The work directory. Can be null