org.hkijena.jipipe.api.data

Class JIPipeVirtualData

java.lang.Object

org.hkijena.jipipe.api.data.JIPipeVirtualData

All Implemented Interfaces:

Closeable, AutoCloseable

public class JIPipeVirtualData
extends Object
implements AutoCloseable, Closeable

Manages virtual data This class can store data in memory or in a temporary path. Please note that the temporary data is not automatically cleaned up by finalize()! Please call close() to remove any files.

Constructor Summary

Constructors

Constructor and Description
JIPipeVirtualData(Class<? extends JIPipeData> dataClass, Path virtualStoragePath, String stringRepresentation) Creates a custom virtual data.
JIPipeVirtualData(JIPipeData data) Create virtual data from data

Method Summary

Modifier and Type	Method and Description
void	addUser(Object obj) Marks the provided object as user of this data
boolean	canClose() Returns true if the data has no users and thus can be closed
void	close()
JIPipeVirtualData	duplicate(JIPipeProgressInfo progressInfo) Fully duplicates the virtual data
<T extends JIPipeData> T	getData(Class<T> klass, JIPipeProgressInfo progressInfo) Gets the currently stored data.
JIPipeData	getData(JIPipeProgressInfo progressInfo) Gets the currently stored data
Class<? extends JIPipeData>	getDataClass()
String	getStringRepresentation()
boolean	isClosed() Returns true if this object is closed and thus should not be used anymore
boolean	isVirtual() Returns true if the object is virtual
void	makeNonVirtual(JIPipeProgressInfo progressInfo, boolean removeVirtualDataStorage)
void	makeVirtual(JIPipeProgressInfo progressInfo, boolean discard) Makes the data virtual if not already
void	removeUser(Object obj) Un-marks the provided objects as user of this data

Methods inherited from class java.lang.Object

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

Constructor Detail

JIPipeVirtualData

public JIPipeVirtualData(JIPipeData data)

Create virtual data from data

Parameters:

data - data

JIPipeVirtualData

public JIPipeVirtualData(Class<? extends JIPipeData> dataClass,
                         Path virtualStoragePath,
                         String stringRepresentation)

Creates a custom virtual data. You have to ensure that everything inside here is correct!

Parameters:

dataClass - the data class

virtualStoragePath - path for virtual storage (to create a new one use VirtualDataSettings.generateTempDirectory). Must be a valid row storage folder for the data type!

stringRepresentation - string representation of the data

Method Detail

duplicate

public JIPipeVirtualData duplicate(JIPipeProgressInfo progressInfo)

Fully duplicates the virtual data

Parameters:

progressInfo - the progress info

Returns:

the copy

isVirtual

public boolean isVirtual()

Returns true if the object is virtual

Returns:

if the object is virtual

isClosed

public boolean isClosed()

Returns true if this object is closed and thus should not be used anymore

Returns:

if the object is closed

makeVirtual

public void makeVirtual(JIPipeProgressInfo progressInfo,
                        boolean discard)

Makes the data virtual if not already

Parameters:

progressInfo - progress

discard - if existing data should be saved or discarded. Discard has no effect if data was not saved, yet.

makeNonVirtual

public void makeNonVirtual(JIPipeProgressInfo progressInfo,
                           boolean removeVirtualDataStorage)

getData

public <T extends JIPipeData> T getData(Class<T> klass,
                                        JIPipeProgressInfo progressInfo)

Gets the currently stored data. Applies conversion if needed.

Type Parameters:

T - the output type

Parameters:

klass - the output type

progressInfo - the progress info

Returns:

the output data

getData

public JIPipeData getData(JIPipeProgressInfo progressInfo)

Gets the currently stored data

Parameters:

progressInfo - the progress info

Returns:

the data

getStringRepresentation

public String getStringRepresentation()

getDataClass

public Class<? extends JIPipeData> getDataClass()

addUser

public void addUser(Object obj)

Marks the provided object as user of this data

Parameters:

obj - the object

removeUser

public void removeUser(Object obj)

Un-marks the provided objects as user of this data

Parameters:

obj - the object

canClose

public boolean canClose()

Returns true if the data has no users and thus can be closed

Returns:

if the data has no users

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException