com.datumbox.framework.common.storage.interfaces

Interface StorageEngine

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

AbstractFileStorageEngine, AbstractStorageEngine, InMemoryEngine

public interface StorageEngine
extends java.lang.AutoCloseable

StorageEngines that give access to a permanent storage should implement this interface. The storage engine should open the connection on its constructor and be responsible for managing and storing the data.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StorageEngine.MapType The supported MapTypes.
static class	StorageEngine.StorageHint A hint on where to ideally store the map.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all the data stored in the storage while keeping the connection open.
<T extends java.util.Map> void	dropBigMap(java.lang.String name, T map) Drops the Big Map.
boolean	existsObject(java.lang.String name) Checks if an object exists with the particular name.
<K,V> java.util.Map<K,V>	getBigMap(java.lang.String name, java.lang.Class<K> keyClass, java.lang.Class<V> valueClass, StorageEngine.MapType type, StorageEngine.StorageHint storageHint, boolean isConcurrent, boolean isTemporary) Creates or loads a Big Map collection.
java.lang.String	getStorageName() Returns the name of the storage.
boolean	isClosed() Checks if the storage engine is closed.
<T extends java.io.Serializable> T	loadObject(java.lang.String name, java.lang.Class<T> klass) Loads a serializable object from the storage.
boolean	rename(java.lang.String newStorageName) Renames the storage.
<T extends java.io.Serializable> void	saveObject(java.lang.String name, T serializableObject) Stores a serializable object in the storage.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

rename

boolean rename(java.lang.String newStorageName)

Renames the storage. Returns true if the operation was completed and false if it was not necessary.

Parameters:

newStorageName -

Returns:

isClosed

boolean isClosed()

Checks if the storage engine is closed.

Returns:

clear

void clear()

Clears all the data stored in the storage while keeping the connection open.

existsObject

boolean existsObject(java.lang.String name)

Checks if an object exists with the particular name.

Parameters:

name -

Returns:

saveObject

<T extends java.io.Serializable> void saveObject(java.lang.String name,
                                                 T serializableObject)
                                          throws java.util.NoSuchElementException

Stores a serializable object in the storage.

Type Parameters:

T -

Parameters:

name -

serializableObject -

Throws:

java.util.NoSuchElementException

loadObject

<T extends java.io.Serializable> T loadObject(java.lang.String name,
                                              java.lang.Class<T> klass)

Loads a serializable object from the storage.

Type Parameters:

T -

Parameters:

name -

klass -

Returns:

getBigMap

<K,V> java.util.Map<K,V> getBigMap(java.lang.String name,
                                   java.lang.Class<K> keyClass,
                                   java.lang.Class<V> valueClass,
                                   StorageEngine.MapType type,
                                   StorageEngine.StorageHint storageHint,
                                   boolean isConcurrent,
                                   boolean isTemporary)

Creates or loads a Big Map collection.

Type Parameters:

K -

V -

Parameters:

name -

keyClass -

valueClass -

type -

storageHint -

isConcurrent -

isTemporary -

Returns:

dropBigMap

<T extends java.util.Map> void dropBigMap(java.lang.String name,
                                          T map)

Drops the Big Map.

Type Parameters:

T -

Parameters:

name -

map -

getStorageName

java.lang.String getStorageName()

Returns the name of the storage.

Returns: