edu.iu.dsc.tws.data.memory

Interface MemoryManager

All Known Implementing Classes:

AbstractMemoryManager, BufferedMemoryManager, LMDBMemoryManager

public interface MemoryManager

base interface for memory managers. Memory managers are responsible of keeping data in memoory for various requirements. The memory manager is also responsible of writing data to disk when the memory does not have enough space

Method Summary

Modifier and Type	Method and Description
OperationMemoryManager	addOperation(int opID, DataMessageType type) Add an memory manager instance for the given operation
OperationMemoryManager	addOperation(int opID, DataMessageType messageType, DataMessageType keyType)
boolean	append(int opID, java.nio.ByteBuffer key, java.nio.ByteBuffer value) Appends the given byte buffer to the current value in the store.
boolean	append(int opID, java.lang.String key, java.nio.ByteBuffer value)
boolean	close(int opID, java.nio.ByteBuffer key) flush and close the given key.
boolean	close(int opID, java.lang.String key)
boolean	containsKey(int opID, java.nio.ByteBuffer key) checks if the given key is in the memory manager
boolean	containsKey(int opID, java.lang.String key) checks if the given key is in the memory manager
boolean	delete(int opID, java.nio.ByteBuffer key) delete the given key from the store
boolean	delete(int opID, java.lang.String key) delete the given key from the store
boolean	flush(int opID)
boolean	flush(int opID, java.nio.ByteBuffer key) Flush all the data into the store.
boolean	flush(int opID, java.lang.String key)
java.nio.ByteBuffer	get(int opID, java.nio.ByteBuffer key) Get the corresponding value as ByteBuffer for the given key from the store
java.nio.ByteBuffer	get(int opID, java.lang.String key) Get the corresponding value as ByteBuffer for the given key from the store
java.util.Iterator<java.lang.Object>	getIterator(int opID, DataMessageType keyType, DataMessageType valueType, KryoSerializer deSerializer, java.nio.ByteOrder order)
java.util.Iterator<java.lang.Object>	getIterator(int opID, DataMessageType valueType, KryoSerializer deSerializer, java.nio.ByteOrder order)
boolean	init() Initializes the Memory manager
boolean	put(int opID, byte[] key, byte[] data)
boolean	put(int opID, java.nio.ByteBuffer key, java.nio.ByteBuffer value) Stores the give key value pair in the memory manager
boolean	put(int opID, java.lang.String key, java.nio.ByteBuffer value) Stores the give key value pair in the memory manager
boolean	removeOperation(int opID) Remove an operation from the memory manager.

Method Detail

init

boolean init()

Initializes the Memory manager

append

boolean append(int opID,
               java.nio.ByteBuffer key,
               java.nio.ByteBuffer value)

Appends the given byte buffer to the current value in the store. If the store does not contain the given key append works as a put operation

Parameters:

opID - id value of the operation

key - key to append to

value - value to be appended

Returns:

true if append was performed, false otherwise

append

boolean append(int opID,
               java.lang.String key,
               java.nio.ByteBuffer value)

put

boolean put(int opID,
            java.nio.ByteBuffer key,
            java.nio.ByteBuffer value)

Stores the give key value pair in the memory manager

put

boolean put(int opID,
            byte[] key,
            byte[] data)

put

boolean put(int opID,
            java.lang.String key,
            java.nio.ByteBuffer value)

Stores the give key value pair in the memory manager

get

java.nio.ByteBuffer get(int opID,
                        java.nio.ByteBuffer key)

Get the corresponding value as ByteBuffer for the given key from the store

get

java.nio.ByteBuffer get(int opID,
                        java.lang.String key)

Get the corresponding value as ByteBuffer for the given key from the store

containsKey

boolean containsKey(int opID,
                    java.nio.ByteBuffer key)

checks if the given key is in the memory manager

Parameters:

key - key to be checked

Returns:

true if the key is present, false otherwise

containsKey

boolean containsKey(int opID,
                    java.lang.String key)

checks if the given key is in the memory manager

Parameters:

key - key to be checked

Returns:

true if the key is present, false otherwise

delete

boolean delete(int opID,
               java.nio.ByteBuffer key)

delete the given key from the store

delete

boolean delete(int opID,
               java.lang.String key)

delete the given key from the store

addOperation

OperationMemoryManager addOperation(int opID,
                                    DataMessageType type)

Add an memory manager instance for the given operation

Returns:

returns the memory manager or null (Null is returned at the base layer)

addOperation

OperationMemoryManager addOperation(int opID,
                                    DataMessageType messageType,
                                    DataMessageType keyType)

removeOperation

boolean removeOperation(int opID)

Remove an operation from the memory manager. This will result in loss of all the data related to the operation in the memory manager

Parameters:

opID - operation id to be removed

Returns:

true if the operation was removed, false otherwise

flush

boolean flush(int opID,
              java.nio.ByteBuffer key)

Flush all the data into the store. This method is needed only if buffering is done at the Memory Manager

Parameters:

opID - id of the operation

key - key to be flushed

flush

boolean flush(int opID,
              java.lang.String key)

flush

boolean flush(int opID)

close

boolean close(int opID,
              java.nio.ByteBuffer key)

flush and close the given key. After close is performed the key data will only be available in the store. This method is needed only if buffering is done at the Memory Manager

Parameters:

opID - id of the operation

key - key to be closed

close

boolean close(int opID,
              java.lang.String key)

getIterator

java.util.Iterator<java.lang.Object> getIterator(int opID,
                                                 DataMessageType keyType,
                                                 DataMessageType valueType,
                                                 KryoSerializer deSerializer,
                                                 java.nio.ByteOrder order)

getIterator

java.util.Iterator<java.lang.Object> getIterator(int opID,
                                                 DataMessageType valueType,
                                                 KryoSerializer deSerializer,
                                                 java.nio.ByteOrder order)