org.hkijena.jipipe.api.data.storage

Class JIPipeFileSystemWriteDataStorage

java.lang.Object

org.hkijena.jipipe.api.data.storage.JIPipeFileSystemWriteDataStorage

All Implemented Interfaces:

Closeable, AutoCloseable, JIPipeDataStorage, JIPipeWriteDataStorage

public class JIPipeFileSystemWriteDataStorage
extends Object
implements JIPipeWriteDataStorage

Storage on a file system. This is the simplest JIPipeWriteDataStorage.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close()
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.
JIPipeWriteDataStorage	resolve(Path path) Returns a new storage that resolves to a path inside this storage
String	toString()
OutputStream	write(Path path) Creates an output stream that writes the specified file element.

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.JIPipeWriteDataStorage

resolve, write, writeBytes, writeJSON, writeText

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

relativeToAbsolute

Constructor Detail

JIPipeFileSystemWriteDataStorage

public JIPipeFileSystemWriteDataStorage(JIPipeProgressInfo progressInfo,
                                        Path fileSystemPath)

JIPipeFileSystemWriteDataStorage

public JIPipeFileSystemWriteDataStorage(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 JIPipeWriteDataStorage resolve(Path path)

Description copied from interface: JIPipeWriteDataStorage

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

Specified by:

resolve in interface JIPipeWriteDataStorage

Parameters:

path - the path

Returns:

the sub-storage

write

public OutputStream write(Path path)

Description copied from interface: JIPipeWriteDataStorage

Creates an output stream that writes the specified file element. Please do not forget to close the stream.

Specified by:

write in interface JIPipeWriteDataStorage

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