org.hkijena.jipipe.api.data.storage

Interface JIPipeDataStorage

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

JIPipeReadDataStorage, JIPipeWriteDataStorage

All Known Implementing Classes:

JIPipeFileSystemReadDataStorage, JIPipeFileSystemWriteDataStorage, JIPipeZIPReadDataStorage, JIPipeZIPWriteDataStorage

public interface JIPipeDataStorage
extends AutoCloseable, Closeable

A storage for serialized JIPipeData

Method Summary

Modifier and Type	Method and Description
Path	getFileSystemPath() Returns a path on the file system where data can be read/written This path is always ensured to exist.
Path	getInternalPath() The current path relative to the root storage
JIPipeProgressInfo	getProgressInfo() Returns the JIPipeProgressInfo instance where information is logged
boolean	isFileSystemPathInitialized() Returns true if the file system path is initialized.
default Path	relativeToAbsolute(Path path) Converts a path relative to this storage into a path that is relative to the root storage.

Methods inherited from interface java.io.Closeable

close

Method Detail

getProgressInfo

JIPipeProgressInfo getProgressInfo()

Returns the JIPipeProgressInfo instance where information is logged

Returns:

the JIPipeProgressInfo instance

isFileSystemPathInitialized

boolean isFileSystemPathInitialized()

Returns true if the file system path is initialized. For example, for certain storage modes, the storage backend might require to create such a storage, which slows down the file operations.

Returns:

if the file system path is initialized

getFileSystemPath

Path getFileSystemPath()

Returns a path on the file system where data can be read/written This path is always ensured to exist. If possible, please use stream-based methods, as the backend might require additional operations to create a file system.

Returns:

the path

getInternalPath

Path getInternalPath()

The current path relative to the root storage

Returns:

the path relative to the root storage

relativeToAbsolute

default Path relativeToAbsolute(Path path)

Converts a path relative to this storage into a path that is relative to the root storage.

Parameters:

path - the relative path. must be relative to this storage.

Returns:

the path relative to the root storage