org.rvpf.store.server.the.bdb

Interface JEWrapper

public interface JEWrapper

JE wrapper.

Field Summary

Fields

Modifier and Type	Field and Description
static ClassDef	IMPL

Method Summary

Modifier and Type	Method and Description
void	abort(Object transaction) Aborts a transaction.
Object	beginTransaction() Begins a transaction.
void	close() Closes.
void	closeCursor(Object wrapperCursor) Closes wrapper a cursor.
void	commit(Object transaction) Commits a transaction.
long	countPointValues(Object wrapperCursor) Counts point values.
int	delete(Object transaction, VersionedValue pointValue) Deletes a point value from the archive.
Object	getCursor(StoreCursor storeCursor) Gets a wrapper cursor object.
Optional<VersionedValue>	nextPointValue(Object wrapperCursor) Returns the next point value.
void	open() Opens.
void	put(Object transaction, VersionedValue pointValue) Puts a point value into the archive.
boolean	setUp(File home, boolean snapshot, boolean pullDisabled) Sets up the environment and the database.
void	tearDown() Tears down what has been set up.

Field Detail

IMPL

static final ClassDef IMPL

Method Detail

abort

void abort(@Nonnull
           Object transaction)
    throws JEWrapperException

Aborts a transaction.

Parameters:

transaction - The transaction handle.

Throws:

JEWrapperException - To wrap exceptions.

beginTransaction

@Nonnull
 @CheckReturnValue
Object beginTransaction()
                                               throws JEWrapperException

Begins a transaction.

Returns:

A transaction handle.

Throws:

JEWrapperException - To wrap exceptions.

close

void close()
    throws JEWrapperException

Closes.

Throws:

JEWrapperException - To wrap exceptions.

closeCursor

void closeCursor(@Nonnull
                 Object wrapperCursor)
          throws JEWrapperException

Closes wrapper a cursor.

Parameters:

wrapperCursor - The wrapper cursor object.

Throws:

JEWrapperException - To wrap exceptions.

commit

void commit(@Nonnull
            Object transaction)
     throws JEWrapperException

Commits a transaction.

Parameters:

transaction - The transaction handle.

Throws:

JEWrapperException - To wrap exceptions.

countPointValues

@CheckReturnValue
long countPointValues(@Nonnull
                                         Object wrapperCursor)

Counts point values.

Parameters:

wrapperCursor - A wrapper cursor object.

Returns:

The number of point values.

delete

@CheckReturnValue
int delete(@Nonnull
                              Object transaction,
                              @Nonnull
                              VersionedValue pointValue)
                       throws JEWrapperException

Deletes a point value from the archive.

Parameters:

transaction - The transaction handle.

pointValue - The point value.

Returns:

The number of values deleted (0 .. 1).

Throws:

JEWrapperException - To wrap exceptions.

getCursor

@Nonnull
 @CheckReturnValue
Object getCursor(@Nonnull
                                               StoreCursor storeCursor)

Gets a wrapper cursor object.

Parameters:

storeCursor - The store cursor.

Returns:

The wrapper cursor object.

nextPointValue

@Nonnull
 @CheckReturnValue
Optional<VersionedValue> nextPointValue(@Nonnull
                                                                      Object wrapperCursor)

Returns the next point value.

Parameters:

wrapperCursor - A wrapper cursor object.

Returns:

A point value (empty when none left).

open

void open()
   throws JEWrapperException

Opens.

Throws:

JEWrapperException - To wrap exceptions.

put

void put(@Nonnull
         Object transaction,
         @Nonnull
         VersionedValue pointValue)
  throws JEWrapperException

Puts a point value into the archive.

Parameters:

transaction - The transaction handle.

pointValue - The point value.

Throws:

JEWrapperException - To wrap exceptions.

setUp

@CheckReturnValue
boolean setUp(@Nonnull
                                 File home,
                                 boolean snapshot,
                                 boolean pullDisabled)
                          throws JEWrapperException

Sets up the environment and the database.

Parameters:

home - The configuration.

snapshot - True in snapshot mode.

pullDisabled - True if pull is disabled.

Returns:

True on success.

Throws:

JEWrapperException - To wrap exceptions.

tearDown

void tearDown()
       throws JEWrapperException

Tears down what has been set up.

Throws:

JEWrapperException - To wrap exceptions.