org.hkijena.jipipe.extensions.filesystem.dataypes

Class PathData

java.lang.Object

org.hkijena.jipipe.extensions.filesystem.dataypes.PathData

All Implemented Interfaces:

Closeable, AutoCloseable, JIPipeData

Direct Known Subclasses:

FileData, FolderData

public class PathData
extends Object
implements JIPipeData

Encapsulates a Path

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PathData()
	PathData(Path path) Initializes file data from a file
	PathData(String path)

Method Summary

Modifier and Type	Method and Description
void	display(String displayName, JIPipeWorkbench workbench, JIPipeDataSource source) This function should display the data in the GUI.
JIPipeData	duplicate(JIPipeProgressInfo progressInfo) Duplicates the data
void	exportData(JIPipeWriteDataStorage storage, String name, boolean forceName, JIPipeProgressInfo progressInfo) Saves the data to a folder
String	getPath()
static PathData	importData(JIPipeReadDataStorage storage, JIPipeProgressInfo progressInfo)
Component	preview(int width, int height) This function generates a preview component for usage within the GUI Can return null
void	setPath(Path path)
void	setPath(String path)
Path	toPath()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hkijena.jipipe.api.data.JIPipeData

close, exportThumbnails, getDescriptionOf, getMenuPathOf, getNameOf, getSortedList, getStorageDocumentation, getStorageSchema, groupByMenuPath, isCommon, isHeavy, isHidden, toDetailedString

Constructor Detail

PathData

public PathData(Path path)

Initializes file data from a file

Parameters:

path - File path

PathData

public PathData(String path)

PathData

protected PathData()

Method Detail

importData

public static PathData importData(JIPipeReadDataStorage storage,
                                  JIPipeProgressInfo progressInfo)

exportData

public void exportData(JIPipeWriteDataStorage storage,
                       String name,
                       boolean forceName,
                       JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

Saves the data to a folder

Specified by:

exportData in interface JIPipeData

Parameters:

storage - The storage where the data should be written

name - A name reference that can be used to generate filename(s)

forceName - If enabled, the data is saved potentially destructively. Generated files must always contain the name parameter. This is used to collect results for humans or other algorithms.

progressInfo - the progress

duplicate

public JIPipeData duplicate(JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

Duplicates the data

Specified by:

duplicate in interface JIPipeData

Parameters:

progressInfo - the progress of duplicating the data

Returns:

a deep copy of the data

display

public void display(String displayName,
                    JIPipeWorkbench workbench,
                    JIPipeDataSource source)

Description copied from interface: JIPipeData

This function should display the data in the GUI. The UI can handle multiple of such operations via JIPipeDataDisplayOperation that can be registered separately. This item will always be shown as "Default" in the list of operations.

Specified by:

display in interface JIPipeData

Parameters:

displayName - a name that can be used

workbench - the workbench

source - optional source of the data. Can be null or any kind of data type (e.g. JIPipeDataSlot)

preview

public Component preview(int width,
                         int height)

Description copied from interface: JIPipeData

This function generates a preview component for usage within the GUI Can return null

Specified by:

preview in interface JIPipeData

Parameters:

width - the target width

height - the target height

Returns:

the component or null if none should be available

getPath

public String getPath()

setPath

public void setPath(String path)

setPath

public void setPath(Path path)

toString

public String toString()

Overrides:

toString in class Object

toPath

public Path toPath()