com.neocoretechs.rocksack.session

Class BufferedMap

java.lang.Object

com.neocoretechs.rocksack.session.BufferedMap

public class BufferedMap
extends java.lang.Object

BufferedMapDerived for subclasses of objects stored in a tablespace we use a separate column family . Functions as a wrapper around Session and we call methods there using ColumnFamilyHandle.

Author:

Jonathan Groff (C) NeoCoreTechs 2024

Constructor Summary

Constructors

Constructor and Description
BufferedMap(Session session) Encapsulates a RockSack session.
BufferedMap(Session session, java.lang.String derivedClassName) Encapsulates a RockSack session.

Method Summary

Modifier and Type	Method and Description
void	Close() Close the database
boolean	contains(java.lang.Comparable o) Does the database contain the key
boolean	containsKey(java.lang.Comparable tkey) Returns true if the collection contains the given key.
boolean	containsValue(java.lang.Object o) Session containsValue
void	dropColumn() Drop the column encapsulated by the session for this BufferedMap
java.util.Iterator<?>	entrySet() Obtain iterator over the entrySet.
java.util.stream.Stream<?>	entrySetStream() Stream of all elements as Map.Entry Session
java.lang.Object	first() Return the first element.
java.lang.Comparable	firstKey() Get the first key
java.lang.Object	get(java.lang.Comparable tkey) call a get from Session
java.lang.String	getDBName()
org.rocksdb.RocksDB	getKVStore() Return the RocksDB instance.
java.lang.Object	getMutexObject()
Session	getSession() Get the Session associated wit this database
java.lang.Object	getValue(java.lang.Object tkey) Get a value from backing store.
java.lang.Object	getViaBytes(byte[] tkey) Get a value from backing store.
java.util.Iterator<?>	headMap(java.lang.Comparable tkey)
java.util.Iterator<?>	headMapKV(java.lang.Comparable tkey)
java.util.stream.Stream<?>	headMapKVStream(java.lang.Comparable tkey)
java.util.stream.Stream<?>	headMapStream(java.lang.Comparable tkey) Stream of strictly less than 'to' elements.
java.util.Iterator<?>	headSet(java.lang.Comparable tkey) Not a real subset, returns Iterator
java.util.Iterator<?>	headSetKV(java.lang.Comparable tkey) Not a real subset, returns Iterator
java.util.stream.Stream<?>	headSetKVStream(java.lang.Comparable tkey) Get a stream of head set
java.util.stream.Stream<?>	headSetStream(java.lang.Comparable tkey) Get a stream of headset
boolean	isEmpty() Return boolean value indicating whether the map for the columnFamilyHandle encapsulated by this Session is empty
java.util.Iterator<?>	iterator() Session equivalent of keySet fulfills SetInterface
java.util.Iterator<?>	keySet() Get a keySet iterator.
java.util.stream.Stream<?>	keySetStream() Get a stream over keys Session
java.lang.Object	last() Return the last element.
java.lang.Comparable	lastKey() Get the last key in the KVStore
java.lang.Object	nearest(java.lang.Comparable key) Find the entry nearest to given key
void	Open() Open the files associated with the BTree for the instances of class
boolean	put(java.lang.Comparable tkey, java.lang.Object tvalue) Put a key/value pair to underlying store.
boolean	putViaBytes(byte[] tkey, java.lang.Object tvalue) Put a key/value pair to underlying store.
java.lang.Object	remove(java.lang.Comparable tkey) Remove object from cache and backing store.
long	size() Return the number of elements in the backing store.
java.util.Iterator<?>	subMap(java.lang.Comparable fkey, java.lang.Comparable tkey)
java.util.Iterator<?>	subMapKV(java.lang.Comparable fkey, java.lang.Comparable tkey)
java.util.stream.Stream<?>	subMapKVStream(java.lang.Comparable fkey, java.lang.Comparable tkey)
java.util.stream.Stream<?>	subMapStream(java.lang.Comparable fkey, java.lang.Comparable tkey)
java.util.Iterator<?>	subSet(java.lang.Comparable fkey, java.lang.Comparable tkey) Not a real subset, returns iterator vs set.
java.util.Iterator<?>	subSetKV(java.lang.Comparable fkey, java.lang.Comparable tkey) Not a real subset, returns iterator vs set.
java.util.stream.Stream<?>	subSetKVStream(java.lang.Comparable fkey, java.lang.Comparable tkey) Return a Streamof key/value pairs that delivers the subset of fkey to tkey
java.util.stream.Stream<?>	subSetStream(java.lang.Comparable fkey, java.lang.Comparable tkey) Return a Stream that delivers the subset of fkey to tkey
java.util.Iterator<?>	tailMap(java.lang.Comparable fkey)
java.util.Iterator<?>	tailMapKV(java.lang.Comparable fkey)
java.util.stream.Stream<?>	tailMapKVStream(java.lang.Comparable fkey)
java.util.stream.Stream<?>	tailMapStream(java.lang.Comparable fkey)
java.util.Iterator<?>	tailSet(java.lang.Comparable fkey) Not a real subset, returns Iterator
java.util.Iterator<?>	tailSetKV(java.lang.Comparable fkey) Not a real subset, returns Iterator
java.util.stream.Stream<?>	tailSetKVStream(java.lang.Comparable fkey) Return a tail set key/value stream
java.util.stream.Stream<?>	tailSetStream(java.lang.Comparable fkey) Return a tail set stream
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BufferedMap

public BufferedMap(Session session,
                   java.lang.String derivedClassName)
            throws java.lang.IllegalAccessException,
                   java.io.IOException,
                   org.rocksdb.RocksDBException

Encapsulates a RockSack session. Calls processColumnFamily on derivedClassName.

Parameters:

session - the Session instance

derivedClassName - the derived class for the ColumnFamily denoting subclasses stored in this database

Throws:

java.io.IOException - if global IO problem

java.lang.IllegalAccessException - if the database has been put offline

org.rocksdb.RocksDBException

BufferedMap

public BufferedMap(Session session)
            throws java.lang.IllegalAccessException,
                   java.io.IOException,
                   org.rocksdb.RocksDBException

Encapsulates a RockSack session. CAlls processColumnFamily on default.

Parameters:

session - the Session instance

Throws:

java.io.IOException - if global IO problem

java.lang.IllegalAccessException - if the database has been put offline

org.rocksdb.RocksDBException

Method Detail

getSession

public Session getSession()
                   throws java.io.IOException

Description copied from interface: SetInterface

Get the Session associated wit this database

Returns:

the Session instance after ensuring the database is open and ready for processing.

Throws:

java.io.IOException

put

public boolean put(java.lang.Comparable tkey,
                   java.lang.Object tvalue)
            throws java.io.IOException

Put a key/value pair to underlying store. Session

Parameters:

tkey - The key for the pair

tvalue - The value for the pair

Returns:

true if key/value previously existed

Throws:

java.io.IOException - if put to backing store fails

putViaBytes

public boolean putViaBytes(byte[] tkey,
                           java.lang.Object tvalue)
                    throws java.io.IOException

Put a key/value pair to underlying store. Session

Parameters:

tkey - The key for the pair, raw bytes unserialized before storage

tvalue - The value for the pair

Throws:

java.io.IOException - if put to backing store fails

get

public java.lang.Object get(java.lang.Comparable tkey)
                     throws java.io.IOException

call a get from Session

Parameters:

tkey - The key for the value

Returns:

The key/value for the key returned as KeyValue

Throws:

java.io.IOException - if get from backing store fails

getViaBytes

public java.lang.Object getViaBytes(byte[] tkey)
                             throws java.io.IOException

Get a value from backing store. Session

Parameters:

tkey - The key for the value

Returns:

The value for the key deserialized from RocksDB get

Throws:

java.io.IOException - if get from backing store fails

getValue

public java.lang.Object getValue(java.lang.Object tkey)
                          throws java.io.IOException

Get a value from backing store. Session

Parameters:

tkey - The key for the value

Returns:

The value for the key or null if not found returned as Entry implemented from Map.Entry

Throws:

java.io.IOException - if get from backing store fails

size

public long size()
          throws java.io.IOException

Return the number of elements in the backing store. Session

Returns:

A long value of number of elements

Throws:

java.io.IOException - If backing store retrieval failure

entrySet

public java.util.Iterator<?> entrySet()
                               throws java.io.IOException

Obtain iterator over the entrySet. Retrieve from backing store if not in cache. Session

Returns:

The Iterator for all elements, iterator over Map.Entry

Throws:

java.io.IOException - if get from backing store fails

entrySetStream

public java.util.stream.Stream<?> entrySetStream()
                                          throws java.io.IOException

Stream of all elements as Map.Entry Session

Returns:

Throws:

java.io.IOException

keySet

public java.util.Iterator<?> keySet()
                             throws java.io.IOException

Get a keySet iterator. Session

Returns:

The iterator for the keys

Throws:

java.io.IOException - if get from backing store fails

keySetStream

public java.util.stream.Stream<?> keySetStream()
                                        throws java.io.IOException

Get a stream over keys Session

Returns:

Throws:

java.io.IOException

containsKey

public boolean containsKey(java.lang.Comparable tkey)
                    throws java.io.IOException

Returns true if the collection contains the given key. Session

Parameters:

tkey - The key to match

Returns:

true or false if in

Throws:

java.io.IOException - If backing store fails

remove

public java.lang.Object remove(java.lang.Comparable tkey)
                        throws java.io.IOException

Remove object from cache and backing store. Session

Parameters:

tkey - The key to match

Returns:

The removed object

Throws:

java.io.IOException - If backing store fails

firstKey

public java.lang.Comparable firstKey()
                              throws java.io.IOException

Get the first key

Returns:

First key in set. Session

Throws:

java.io.IOException - If backing store retrieval failure

lastKey

public java.lang.Comparable lastKey()
                             throws java.io.IOException

Get the last key in the KVStore

Returns:

Last key in set. Session

Throws:

java.io.IOException - If backing store retrieval failure

last

public java.lang.Object last()
                      throws java.io.IOException

Return the last element. Session

Returns:

A long value of number of elements

Throws:

java.io.IOException - If backing store retrieval failure

first

public java.lang.Object first()
                       throws java.io.IOException

Return the first element. Session

Returns:

The value of the Object of the first key

Throws:

java.io.IOException - If backing store retrieval failure

nearest

public java.lang.Object nearest(java.lang.Comparable key)
                         throws java.io.IOException

Find the entry nearest to given key

Parameters:

key -

Returns:

element nearest to given key or null if nothing

Throws:

java.io.IOException

headMap

public java.util.Iterator<?> headMap(java.lang.Comparable tkey)
                              throws java.io.IOException

Parameters:

tkey - Strictly less than 'to' this element. Session

Returns:

Iterator of first to tkey

Throws:

java.io.IOException - If backing store retrieval failure

headMapStream

public java.util.stream.Stream<?> headMapStream(java.lang.Comparable tkey)
                                         throws java.io.IOException

Stream of strictly less than 'to' elements. Session

Parameters:

tkey -

Returns:

Throws:

java.io.IOException

headMapKV

public java.util.Iterator<?> headMapKV(java.lang.Comparable tkey)
                                throws java.io.IOException

Parameters:

tkey - Strictly less than 'to' this element. Session

Returns:

Iterator of first to tkey returning KeyValuePairs implementation of Map.Entry

Throws:

java.io.IOException - If backing store retrieval failure

headMapKVStream

public java.util.stream.Stream<?> headMapKVStream(java.lang.Comparable tkey)
                                           throws java.io.IOException

Parameters:

tkey - Strictly less than 'to' this element. Session

Returns:

stream over first to tkey returning KeyValuePairs implementation of Map.Entry

Throws:

java.io.IOException - If backing store retrieval failure

tailMap

public java.util.Iterator<?> tailMap(java.lang.Comparable fkey)
                              throws java.io.IOException

Parameters:

fkey - Greater or equal to 'from' element. Session

Returns:

Iterator of objects from fkey to end

Throws:

java.io.IOException - If backing store retrieval failure

tailMapStream

public java.util.stream.Stream<?> tailMapStream(java.lang.Comparable fkey)
                                         throws java.io.IOException

Parameters:

fkey - Greater or equal to 'from' element. Session

Returns:

stream over objects from fkey to end.

Throws:

java.io.IOException - If backing store retrieval failure

tailMapKV

public java.util.Iterator<?> tailMapKV(java.lang.Comparable fkey)
                                throws java.io.IOException

Parameters:

fkey - Greater or equal to 'from' element. Session

Returns:

Iterator of objects from fkey to end which are KeyValuePairs implementation of Map.Entry

Throws:

java.io.IOException - If backing store retrieval failure

tailMapKVStream

public java.util.stream.Stream<?> tailMapKVStream(java.lang.Comparable fkey)
                                           throws java.io.IOException

Parameters:

fkey - Greater or equal to 'from' element, Session

Returns:

stream over objects from fkey to end which are KeyValuePairs implementation of Map.Entry

Throws:

java.io.IOException - If backing store retrieval failure

subMap

public java.util.Iterator<?> subMap(java.lang.Comparable fkey,
                                    java.lang.Comparable tkey)
                             throws java.io.IOException

Parameters:

fkey - 'from' element inclusive. Session

tkey - 'to' element exclusive

Returns:

Iterator of objects in subset from fkey to tkey

Throws:

java.io.IOException - If backing store retrieval failure

subMapStream

public java.util.stream.Stream<?> subMapStream(java.lang.Comparable fkey,
                                               java.lang.Comparable tkey)
                                        throws java.io.IOException

Parameters:

fkey - 'from' element inclusive. Session

tkey - 'to' element exclusive

Returns:

Stream over objects in subset from fkey to tkey

Throws:

java.io.IOException - If backing store retrieval failure

subMapKV

public java.util.Iterator<?> subMapKV(java.lang.Comparable fkey,
                                      java.lang.Comparable tkey)
                               throws java.io.IOException

Parameters:

fkey - 'from' element inclusive. Session

tkey - 'to' element exclusive

Returns:

Iterator of objects in subset from fkey to tkey composed of KeyValuePairs implementation of Map.Entry

Throws:

java.io.IOException - If backing store retrieval failure

subMapKVStream

public java.util.stream.Stream<?> subMapKVStream(java.lang.Comparable fkey,
                                                 java.lang.Comparable tkey)
                                          throws java.io.IOException

Parameters:

fkey - 'from' element inclusive. Session

tkey - 'to' element exclusive

Returns:

stream over objects in subset from fkey to tkey composed of KeyValuePairs implementation of Map.Entry

Throws:

java.io.IOException - If backing store retrieval failure

isEmpty

public boolean isEmpty()
                throws java.io.IOException

Return boolean value indicating whether the map for the columnFamilyHandle encapsulated by this Session is empty

Returns:

true if empty

Throws:

java.io.IOException - If backing store retrieval failure

getDBName

public java.lang.String getDBName()

Returns:

the name of the database

getMutexObject

public java.lang.Object getMutexObject()

iterator

public java.util.Iterator<?> iterator()
                               throws java.io.IOException

Session equivalent of keySet fulfills SetInterface

Returns:

Iterator over the keySet of elements in this map for the columnFAmilyhandle encapsulated by this Session

Throws:

java.io.IOException - if backing store fails

contains

public boolean contains(java.lang.Comparable o)
                 throws java.io.IOException

Description copied from interface: SetInterface

Does the database contain the key

Parameters:

o - the key to locate

Returns:

true if map contains the designated key

Throws:

java.io.IOException - if backing store fails

Open

public void Open()
          throws java.io.IOException

Description copied from interface: SetInterface

Open the files associated with the BTree for the instances of class

Throws:

java.io.IOException

Close

public void Close()
           throws java.io.IOException

Description copied from interface: SetInterface

Close the database

Throws:

java.io.IOException

getKVStore

public org.rocksdb.RocksDB getKVStore()

Return the RocksDB instance.

Returns:

the RocksDB database

containsValue

public boolean containsValue(java.lang.Object o)
                      throws java.io.IOException

Session containsValue

Returns:

boolean if the value object is found

Throws:

java.io.IOException

subSet

public java.util.Iterator<?> subSet(java.lang.Comparable fkey,
                                    java.lang.Comparable tkey)
                             throws java.io.IOException

Not a real subset, returns iterator vs set. 'from' element inclusive, 'to' element exclusive

Parameters:

fkey - 'from' element inclusive. Session

tkey - 'to' element exclusive

Returns:

Iterator of objects in subset from fkey to tkey

Throws:

java.io.IOException - If backing store retrieval failure

subSetStream

public java.util.stream.Stream<?> subSetStream(java.lang.Comparable fkey,
                                               java.lang.Comparable tkey)
                                        throws java.io.IOException

Return a Stream that delivers the subset of fkey to tkey

Parameters:

fkey - 'from' element inclusive. Session

tkey - 'to' element exclusive

Returns:

Stream of objects in subset from fkey to tkey

Throws:

java.io.IOException - If backing store retrieval failure

headSet

public java.util.Iterator<?> headSet(java.lang.Comparable tkey)
                              throws java.io.IOException

Not a real subset, returns Iterator

Parameters:

tkey - Strictly less than 'to' this element. Session

Returns:

Iterator of first to tkey returning set of keys

Throws:

java.io.IOException - If backing store retrieval failure

headSetStream

public java.util.stream.Stream<?> headSetStream(java.lang.Comparable tkey)
                                         throws java.io.IOException

Get a stream of headset

Parameters:

tkey - Strictly less than 'to' this element. Session

Returns:

Stream of first to tkey returning set of keys

Throws:

java.io.IOException - If backing store retrieval failure

tailSet

public java.util.Iterator<?> tailSet(java.lang.Comparable fkey)
                              throws java.io.IOException

Not a real subset, returns Iterator

Parameters:

fkey - Greater or equal to 'from' element. Session

Returns:

Iterator of objects from fkey to end which are set of keys

Throws:

java.io.IOException - If backing store retrieval failure

tailSetStream

public java.util.stream.Stream<?> tailSetStream(java.lang.Comparable fkey)
                                         throws java.io.IOException

Return a tail set stream

Parameters:

fkey - Greater or equal to 'from' element. Session

Returns:

Stream of objects from fkey to end which are set of keys

Throws:

java.io.IOException - If backing store retrieval failure

subSetKV

public java.util.Iterator<?> subSetKV(java.lang.Comparable fkey,
                                      java.lang.Comparable tkey)
                               throws java.io.IOException

Not a real subset, returns iterator vs set. 'from' element inclusive, 'to' element exclusive

Parameters:

fkey - 'from' element inclusive. Session

tkey - 'to' element exclusive

Returns:

Iterator of key/value objects in subset from fkey to tkey

Throws:

java.io.IOException - If backing store retrieval failure

subSetKVStream

public java.util.stream.Stream<?> subSetKVStream(java.lang.Comparable fkey,
                                                 java.lang.Comparable tkey)
                                          throws java.io.IOException

Return a Streamof key/value pairs that delivers the subset of fkey to tkey

Parameters:

fkey - 'from' element inclusive. Session

tkey - 'to' element exclusive

Returns:

Stream of key/value objects in subset from fkey to tkey

Throws:

java.io.IOException - If backing store retrieval failure

headSetKV

public java.util.Iterator<?> headSetKV(java.lang.Comparable tkey)
                                throws java.io.IOException

Not a real subset, returns Iterator

Parameters:

tkey - Strictly less than 'to' this element. Session

Returns:

Iterator of first to tkey returning KeyValuePairs implementation of Map.Entry

Throws:

java.io.IOException - If backing store retrieval failure

headSetKVStream

public java.util.stream.Stream<?> headSetKVStream(java.lang.Comparable tkey)
                                           throws java.io.IOException

Get a stream of head set

Parameters:

tkey - Strictly less than 'to' this element. Session

Returns:

Stream of first to tkey returning KeyValuePairs implementation of Map.Entry

Throws:

java.io.IOException - If backing store retrieval failure

tailSetKV

public java.util.Iterator<?> tailSetKV(java.lang.Comparable fkey)
                                throws java.io.IOException

Not a real subset, returns Iterator

Parameters:

fkey - Greater or equal to 'from' element. Session

Returns:

Iterator of objects from fkey to end which are KeyValuePairs implementation of Map.Entry

Throws:

java.io.IOException - If backing store retrieval failure

tailSetKVStream

public java.util.stream.Stream<?> tailSetKVStream(java.lang.Comparable fkey)
                                           throws java.io.IOException

Return a tail set key/value stream

Parameters:

fkey - Greater or equal to 'from' element. Session

Returns:

Stream of objects from fkey to end which are KeyValuePairs implementation of Map.Entry

Throws:

java.io.IOException - If backing store retrieval failure

dropColumn

public void dropColumn()
                throws java.io.IOException

Drop the column encapsulated by the session for this BufferedMap

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object