org.boon.slumberdb.base

Class BaseSimpleSerializationKeyValueStore<K,V>

java.lang.Object

org.boon.slumberdb.base.BaseSimpleSerializationKeyValueStore<K,V>

Direct Known Subclasses:

SimpleJavaSerializationStore, SimpleJsonKeyValueStore, SimpleKryoKeyValueStore, SimpleStringKeyValueStore

public abstract class BaseSimpleSerializationKeyValueStore<K,V>
extends Object

Created by Richard on 4/9/14.

Field Summary

Fields

Modifier and Type	Field and Description
protected SimpleCache<K,byte[]>	keyCache
protected Function<byte[],K>	keyObjectConverter
protected Function<K,byte[]>	keyToByteArrayConverter
protected KeyValueStore<byte[],byte[]>	store Store that does the actual writing to DB (likely).
protected Function<byte[],V>	valueObjectConverter
protected Function<V,byte[]>	valueToByteArrayConverter

Constructor Summary

Constructors

Constructor and Description
BaseSimpleSerializationKeyValueStore(KeyValueStore<byte[],byte[]> store)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the store.
boolean	isClosed()
boolean	isOpen()
V	load(K key) Get a value from the key value store.
KeyValueIterable<K,V>	loadAll() Load all of the key / values from the store.
Map<K,V>	loadAllByKeys(Collection<K> keys)
Collection<K>	loadAllKeys()
void	put(K key, V value) Put a value in the key/value store.
void	putAll(Map<K,V> values) Put all of these values in the key value store.
void	remove(K key) Remove a key from the store.
void	removeAll(Iterable<K> keys) Remove all of these values from the key value store.
KeyValueIterable<K,V>	search(K startKey) Search for a key in the key / value store.
protected byte[]	toKeyBytes(K key) Convert a String key to bytes.
protected K	toKeyObject(byte[] key) Convert a binary array to a String.
protected byte[]	toValueBytes(V v) Converts an object to a byte array.
protected V	toValueObject(byte[] value) Use serializer to read this byte array as an object.

Methods inherited from class java.lang.Object

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

Field Detail

store

protected final KeyValueStore<byte[],byte[]> store

Store that does the actual writing to DB (likely).

keyObjectConverter

protected Function<byte[],K> keyObjectConverter

keyToByteArrayConverter

protected Function<K,byte[]> keyToByteArrayConverter

valueObjectConverter

protected Function<byte[],V> valueObjectConverter

valueToByteArrayConverter

protected Function<V,byte[]> valueToByteArrayConverter

keyCache

protected SimpleCache<K,byte[]> keyCache

Constructor Detail

BaseSimpleSerializationKeyValueStore

public BaseSimpleSerializationKeyValueStore(KeyValueStore<byte[],byte[]> store)

Method Detail

remove

public void remove(K key)

Remove a key from the store.

Parameters:

key -

search

public KeyValueIterable<K,V> search(K startKey)

Search for a key in the key / value store.

Parameters:

startKey -

Returns:

loadAll

public KeyValueIterable<K,V> loadAll()

Load all of the key / values from the store.

Returns:

loadAllKeys

public Collection<K> loadAllKeys()

load

public V load(K key)

Get a value from the key value store.

Parameters:

key - key

Returns:

loadAllByKeys

public Map<K,V> loadAllByKeys(Collection<K> keys)

close

public void close()

Close the store.

toKeyObject

protected K toKeyObject(byte[] key)

Convert a binary array to a String.

Parameters:

key - key

Returns:

toValueObject

protected V toValueObject(byte[] value)

Use serializer to read this byte array as an object.

Parameters:

value - value read

Returns:

new object read from key/value store

toValueBytes

protected byte[] toValueBytes(V v)

Converts an object to a byte array.

Parameters:

v - object to convert

Returns:

byte array representation of object.

toKeyBytes

protected byte[] toKeyBytes(K key)

Convert a String key to bytes.

Parameters:

key - key to convert

Returns:

value

put

public void put(K key,
       V value)

Put a value in the key/value store.

Parameters:

key - key

value - value

putAll

public void putAll(Map<K,V> values)

Put all of these values in the key value store.

Parameters:

values - values

removeAll

public void removeAll(Iterable<K> keys)

Remove all of these values from the key value store.

Parameters:

keys -

isOpen

public boolean isOpen()

isClosed

public boolean isClosed()