org.hkijena.jipipe.extensions.filesystem.datasources

Class PathListDataSource

java.lang.Object

org.hkijena.jipipe.api.nodes.JIPipeGraphNode

org.hkijena.jipipe.api.nodes.JIPipeAlgorithm

org.hkijena.jipipe.extensions.filesystem.datasources.PathListDataSource

All Implemented Interfaces:

JIPipeFunctionallyComparable, JIPipeValidatable, JIPipeParameterCollection

public class PathListDataSource
extends JIPipeAlgorithm

Provides an input folder

Nested Class Summary

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

Constructor Summary

Constructors

Constructor and Description
PathListDataSource(JIPipeNodeInfo info) Creates a new instance
PathListDataSource(PathListDataSource other) Copies 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.
void	convertPathsToAbsolute()
void	convertPathsToRelative()
PathList	getAbsolutePaths()
PathList	getPaths()
PathList	getRelativePaths()
void	reportValidity(JIPipeIssueReport report) Generates a validity report
void	run(JIPipeProgressInfo progressInfo) Runs the workload
void	setBaseDirectory(Path baseDirectory) Sets the current work directory of this algorithm.
void	setPaths(PathList paths) Sets the folder path

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

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

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

canUserDelete, clearLocations, clearSlotData, copySlotConfiguration, createUIInputSlotIconDescriptionMenuItems, duplicate, fromJson, fromJsonNode, getAliasIdInParentGraph, getBaseDirectory, getCategory, getCompartmentDisplayName, getCompartmentUUIDInGraphAsString, getCompartmentUUIDInParentGraph, getCustomDescription, getDataInputSlots, 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, getUIInputSlotIcon, getUIInputSlotIconBaseDimensions, getUUIDInParentGraph, hasInputSlot, hasOutputSlot, isBookmarked, isVisibleIn, onDeserialized, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, onSlotConfigurationChanged, registerSubParameter, renderInputSlots, renderOutputSlots, setBookmarked, setCustomDescription, setCustomName, setInfo, setInternalStoragePath, setLocations, setLocationWithin, setLocationWithin, setParentGraph, setProjectDirectory, setScratchBaseDirectory, setSlotConfiguration, setStoragePath, toggleSlot, toJson, triggerSlotsChangedEvent, updateGraphNodeSlots

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, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Constructor Detail

PathListDataSource

public PathListDataSource(JIPipeNodeInfo info)

Creates a new instance

Parameters:

info - The algorithm info

PathListDataSource

public PathListDataSource(PathListDataSource other)

Copies the algorithm

Parameters:

other - The original

Method Detail

run

public void run(JIPipeProgressInfo progressInfo)

Description copied from class: JIPipeGraphNode

Runs the workload

Overrides:

run in class JIPipeAlgorithm

Parameters:

progressInfo - progress passed from the runner

getPaths

public PathList getPaths()

Returns:

Gets the folder paths

setPaths

public void setPaths(PathList paths)

Sets the folder path

Parameters:

paths - Folder paths

getAbsolutePaths

public PathList getAbsolutePaths()

Returns:

Folder paths as absolute paths

getRelativePaths

public PathList getRelativePaths()

Returns:

Relative paths (if available)

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

convertPathsToAbsolute

public void convertPathsToAbsolute()

convertPathsToRelative

public void convertPathsToRelative()

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 JIPipeAlgorithm

Parameters:

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