com.neocoretechs.rocksack.session

Interface TransactionSetInterface

public interface TransactionSetInterface

Interface contract for the Set abstraction in a transaction context.

Author:

Jonathan Groff Copyright (C) NeoCoreTechs 2025

Method Summary

Modifier and Type	Method and Description
void	Close() Close the seesion
boolean	contains(TransactionId transactionId, java.lang.Comparable o) Contains a value object
java.lang.Object	first(TransactionId transactionId) Get the value of the object associated with first key
java.lang.Object	get(TransactionId transactionId, java.lang.Comparable o) Cause the b seekKey for the Comparable type.
java.lang.String	getDBName()
java.lang.Object	getForUpdate(TransactionId transactionId, java.lang.Comparable o, boolean exclusive) Read a key and make the key value a precondition for commit.
java.lang.Object	getMutexObject()
Session	getSession()
boolean	isEmpty(TransactionId transactionId) Is the KVStore empty?
java.util.Iterator<?>	iterator(TransactionId transactionId) Returns iterator
java.lang.Object	last(TransactionId transactionId) Get the last object associated with greatest valued key in the KVStore
void	Open() Open the files associated with the BTree for the instances of class
java.lang.Object	remove(TransactionId transactionId, java.lang.Comparable o) Remove the key and value of the parameter.
long	size(TransactionId transactionId) Get the number of keys total.
void	undoGetForUpdate(TransactionId transactionId, java.lang.Comparable o) Inform the transaction that it no longer needs to do any conflict checking for this key.

Method Detail

getDBName

java.lang.String getDBName()

Returns:

the name of the associated database

getMutexObject

java.lang.Object getMutexObject()

get

java.lang.Object get(TransactionId transactionId,
                     java.lang.Comparable o)
              throws java.io.IOException

Cause the b seekKey for the Comparable type.

Parameters:

transactionId - the transaction Id

o - the Comparable object to seek.

Returns:

the value of object associated with the key, null if key was not found

Throws:

java.io.IOException

getForUpdate

java.lang.Object getForUpdate(TransactionId transactionId,
                              java.lang.Comparable o,
                              boolean exclusive)
                       throws java.io.IOException

Read a key and make the key value a precondition for commit. Used for optimistic concurrency control

Parameters:

transactionId - Transaction Id

o - key to get

exclusive - true to get exclusive access

Returns:

the key/value object retrieved

Throws:

java.io.IOException

undoGetForUpdate

void undoGetForUpdate(TransactionId transactionId,
                      java.lang.Comparable o)
               throws java.io.IOException

Inform the transaction that it no longer needs to do any conflict checking for this key.

Parameters:

transactionId - Transaction Id

o - key to undo

Throws:

java.io.IOException

iterator

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

Returns iterator

Parameters:

transactionId - Transaction Id

Returns:

The Iterator over the entrySet

Throws:

java.io.IOException - If we cannot obtain the iterator

contains

boolean contains(TransactionId transactionId,
                 java.lang.Comparable o)
          throws java.io.IOException

Contains a value object

Parameters:

transactionId - Transaction Id

o -

Returns:

boolean if the value object is found

Throws:

java.io.IOException

remove

java.lang.Object remove(TransactionId transactionId,
                        java.lang.Comparable o)
                 throws java.io.IOException

Remove the key and value of the parameter.

Parameters:

transactionId - Transaction Id

o - The object to remove

Returns:

null or previous object

Throws:

java.io.IOException

first

java.lang.Object first(TransactionId transactionId)
                throws java.io.IOException

Get the value of the object associated with first key

Parameters:

transactionId - Transaction Id

Returns:

Object from first key

Throws:

java.io.IOException

last

java.lang.Object last(TransactionId transactionId)
               throws java.io.IOException

Get the last object associated with greatest valued key in the KVStore

Parameters:

transactionId - Transaction Id

Returns:

The Object of the greatest key

Throws:

java.io.IOException

size

long size(TransactionId transactionId)
   throws java.io.IOException

Get the number of keys total.

Parameters:

transactionId - Transaction Id

Returns:

The size of the KVStore.

Throws:

java.io.IOException

isEmpty

boolean isEmpty(TransactionId transactionId)
         throws java.io.IOException

Is the KVStore empty?

Parameters:

transactionId - Transaction Id

Returns:

true if it is empty.

Throws:

java.io.IOException

Open

void Open()
   throws java.io.IOException

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

Throws:

java.io.IOException

Close

void Close()
    throws java.io.IOException

Close the seesion

Throws:

java.io.IOException

getSession

Session getSession()
            throws java.io.IOException

Returns:

The session instance

Throws:

java.io.IOException