org.hkijena.jipipe.api.data.storage

Class JIPipeFileSystemReadDataStorage

java.lang.Object

org.hkijena.jipipe.api.data.storage.JIPipeFileSystemReadDataStorage

All Implemented Interfaces:

Closeable, AutoCloseable, JIPipeDataStorage, JIPipeReadDataStorage

public class JIPipeFileSystemReadDataStorage
extends Object
implements JIPipeReadDataStorage

Storage on a file system

Constructor Summary

Constructors

Constructor and Description
JIPipeFileSystemReadDataStorage(JIPipeProgressInfo progressInfo, Path fileSystemPath)
JIPipeFileSystemReadDataStorage(JIPipeProgressInfo progressInfo, Path fileSystemPath, Path internalPath)

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	exists(Path path) Returns true if the storage contains given element
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	isDirectory(Path path) Returns true if the element with given name is a directory
boolean	isFile(Path path) Returns true if the element with given name is a file
boolean	isFileSystemPathInitialized() Returns true if the file system path is initialized.
Collection<Path>	list() Lists the relative paths of all elements in this storage
InputStream	open(Path path) Opens the specified file element as stream.
JIPipeReadDataStorage	resolve(Path path) Returns a new storage that resolves to a path inside this storage
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.storage.JIPipeReadDataStorage

exists, findFileByExtension, findFilesByExtension, isDirectory, isFile, listNames, open, readBytes, readJSON, readText, resolve

Methods inherited from interface org.hkijena.jipipe.api.data.storage.JIPipeDataStorage

relativeToAbsolute

Constructor Detail

JIPipeFileSystemReadDataStorage

public JIPipeFileSystemReadDataStorage(JIPipeProgressInfo progressInfo,
                                       Path fileSystemPath)

JIPipeFileSystemReadDataStorage

public JIPipeFileSystemReadDataStorage(JIPipeProgressInfo progressInfo,
                                       Path fileSystemPath,
                                       Path internalPath)

Method Detail

getInternalPath

public Path getInternalPath()

Description copied from interface: JIPipeDataStorage

The current path relative to the root storage

Specified by:

getInternalPath in interface JIPipeDataStorage

Returns:

the path relative to the root storage

isFileSystemPathInitialized

public boolean isFileSystemPathInitialized()

Description copied from interface: JIPipeDataStorage

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.

Specified by:

isFileSystemPathInitialized in interface JIPipeDataStorage

Returns:

if the file system path is initialized

getFileSystemPath

public Path getFileSystemPath()

Description copied from interface: JIPipeDataStorage

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.

Specified by:

getFileSystemPath in interface JIPipeDataStorage

Returns:

the path

getProgressInfo

public JIPipeProgressInfo getProgressInfo()

Description copied from interface: JIPipeDataStorage

Returns the JIPipeProgressInfo instance where information is logged

Specified by:

getProgressInfo in interface JIPipeDataStorage

Returns:

the JIPipeProgressInfo instance

resolve

public JIPipeReadDataStorage resolve(Path path)

Description copied from interface: JIPipeReadDataStorage

Returns a new storage that resolves to a path inside this storage

Specified by:

resolve in interface JIPipeReadDataStorage

Parameters:

path - the path

Returns:

the sub-storage

isFile

public boolean isFile(Path path)

Description copied from interface: JIPipeReadDataStorage

Returns true if the element with given name is a file

Specified by:

isFile in interface JIPipeReadDataStorage

Parameters:

path - the element path. relative to the current storage.

Returns:

if the element is a file

exists

public boolean exists(Path path)

Description copied from interface: JIPipeReadDataStorage

Returns true if the storage contains given element

Specified by:

exists in interface JIPipeReadDataStorage

Parameters:

path - the element path. relative to the current storage.

Returns:

if the storage contains the element

isDirectory

public boolean isDirectory(Path path)

Description copied from interface: JIPipeReadDataStorage

Returns true if the element with given name is a directory

Specified by:

isDirectory in interface JIPipeReadDataStorage

Parameters:

path - the element path. relative to the current storage.

Returns:

if the element is a file

list

public Collection<Path> list()

Description copied from interface: JIPipeReadDataStorage

Lists the relative paths of all elements in this storage

Specified by:

list in interface JIPipeReadDataStorage

Returns:

list of elements. relative to the current storage.

open

public InputStream open(Path path)

Description copied from interface: JIPipeReadDataStorage

Opens the specified file element as stream. Please do not forget to close the stream.

Specified by:

open in interface JIPipeReadDataStorage

Parameters:

path - the file path. relative to the current store.

Returns:

the file stream

toString

public String toString()

Overrides:

toString in class Object

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException