org.hkijena.jipipe.api.data

Class JIPipeDataItemStore

java.lang.Object

org.hkijena.jipipe.api.data.JIPipeDataItemStore

All Implemented Interfaces:

Closeable, AutoCloseable, Store<JIPipeData>

public class JIPipeDataItemStore
extends Object
implements AutoCloseable, Closeable, Store<JIPipeData>

Manages data and users

Constructor Summary

Constructors

Constructor and Description
JIPipeDataItemStore(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()
JIPipeDataItemStore	duplicate(JIPipeProgressInfo progressInfo) Fully duplicates the virtual data
JIPipeData	get() Gets the stored data or null if the data is not present
protected JIPipeData	getData_(JIPipeProgressInfo progressInfo) Gets the currently stored 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()
JIPipeThumbnailData	getThumbnail() Gets the currently stored thumbnail
boolean	isClosed() Returns true if this object is closed and thus should not be used anymore
boolean	isPresent() Returns true if the stored data is present
void	removeUser(Object obj) Un-marks the provided objects as user of this data
void	setThumbnail(JIPipeThumbnailData thumbnail) Sets the thumbnail

Methods inherited from class java.lang.Object

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

Constructor Detail

JIPipeDataItemStore

public JIPipeDataItemStore(JIPipeData data)

Create virtual data from data

Parameters:

data - data

Method Detail

duplicate

public JIPipeDataItemStore duplicate(JIPipeProgressInfo progressInfo)

Fully duplicates the virtual data

Parameters:

progressInfo - the progress info

Returns:

the copy

isClosed

public boolean isClosed()

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

Returns:

if the object is closed

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

getThumbnail

public JIPipeThumbnailData getThumbnail()

Gets the currently stored thumbnail

Returns:

the thumbnail or null

setThumbnail

public void setThumbnail(JIPipeThumbnailData thumbnail)

Sets the thumbnail

Parameters:

thumbnail - the thumbnail or null

getData_

protected JIPipeData getData_(JIPipeProgressInfo progressInfo)

Gets the currently stored data

Parameters:

progressInfo - the progress info

Returns:

the 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

get

public JIPipeData get()

Description copied from interface: Store

Gets the stored data or null if the data is not present

Specified by:

get in interface Store<JIPipeData>

Returns:

the stored data or null

isPresent

public boolean isPresent()

Description copied from interface: Store

Returns true if the stored data is present

Specified by:

isPresent in interface Store<JIPipeData>

Returns:

true if the stored data is present