org.apache.directory.server.core.partition.impl.btree.mavibot

Class MavibotCursor<K,V>

java.lang.Object

org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

org.apache.directory.server.core.partition.impl.btree.mavibot.MavibotCursor<K,V>

All Implemented Interfaces:

java.lang.Iterable<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>, org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

class MavibotCursor<K,V>
extends org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

Cursor over the Tuples of a Mavibot BTree. If the BTree allows duplicate values, we will browse each value and return a Tuple for each one of them.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.mavibot.btree.TupleCursor<K,V>	browser The Tuple browser
private static org.slf4j.Logger	LOG_CURSOR A dedicated log for cursors
private org.apache.directory.api.ldap.model.cursor.Tuple<K,V>	returnedTuple The tuple which will be returned
private MavibotTable<K,V>	table The table we are building a cursor over
private boolean	valueAvailable A flag set when there is a Tuple available

Constructor Summary

Constructors

Constructor and Description
MavibotCursor(MavibotTable<K,V> table) Creates a Cursor over the tuples of a Mavibot table.

Method Summary

Modifier and Type	Method and Description
void	after(org.apache.directory.api.ldap.model.cursor.Tuple<K,V> element)
void	afterKey(K key) Sets the position before a given key
void	afterLast()
void	afterValue(K key, V value) Sets the position after a given key and a given value for this key
boolean	available()
void	before(org.apache.directory.api.ldap.model.cursor.Tuple<K,V> element)
void	beforeFirst()
void	beforeKey(K key) Sets the position before a given key
void	beforeValue(K key, V value) Sets the position before a given key and a given value for this key
private void	clearValue() Cleanup the returned tuple before reusing it.
void	close()
void	close(java.lang.Exception cause)
private void	closeBrowser(org.apache.directory.mavibot.btree.TupleCursor<K,V> browser) Close the browser
boolean	first()
org.apache.directory.api.ldap.model.cursor.Tuple<K,V>	get()
boolean	last()
boolean	next()
boolean	previous()

Methods inherited from class org.apache.directory.api.ldap.model.cursor.AbstractCursor

checkNotClosed, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, iterator, setClosureMonitor, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

LOG_CURSOR

private static final org.slf4j.Logger LOG_CURSOR

A dedicated log for cursors

table

private final MavibotTable<K,V> table

The table we are building a cursor over

returnedTuple

private org.apache.directory.api.ldap.model.cursor.Tuple<K,V> returnedTuple

The tuple which will be returned

valueAvailable

private boolean valueAvailable

A flag set when there is a Tuple available

browser

private org.apache.directory.mavibot.btree.TupleCursor<K,V> browser

The Tuple browser

Constructor Detail

MavibotCursor

public MavibotCursor(MavibotTable<K,V> table)

Creates a Cursor over the tuples of a Mavibot table.

Parameters:

table - the JDBM Table to build a Cursor over

Method Detail

clearValue

private void clearValue()

Cleanup the returned tuple before reusing it.

available

public boolean available()

beforeKey

public void beforeKey(K key)
               throws org.apache.directory.api.ldap.model.exception.LdapException,
                      org.apache.directory.api.ldap.model.cursor.CursorException

Sets the position before a given key

Parameters:

key - The key we want to start with

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

afterKey

public void afterKey(K key)
              throws org.apache.directory.api.ldap.model.exception.LdapException,
                     org.apache.directory.api.ldap.model.cursor.CursorException

Sets the position before a given key

Parameters:

key - The key we want to start with

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

beforeValue

public void beforeValue(K key,
                        V value)
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Sets the position before a given key and a given value for this key

Parameters:

key - The key we want to start with

value - The value we want to start with

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

afterValue

public void afterValue(K key,
                       V value)
                throws org.apache.directory.api.ldap.model.exception.LdapException,
                       org.apache.directory.api.ldap.model.cursor.CursorException

Sets the position after a given key and a given value for this key

Parameters:

key - The key we want to start with

value - The value we want to start with

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

before

public void before(org.apache.directory.api.ldap.model.cursor.Tuple<K,V> element)
            throws org.apache.directory.api.ldap.model.exception.LdapException,
                   org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

after

public void after(org.apache.directory.api.ldap.model.cursor.Tuple<K,V> element)
           throws org.apache.directory.api.ldap.model.exception.LdapException,
                  org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

beforeFirst

public void beforeFirst()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

afterLast

public void afterLast()
               throws org.apache.directory.api.ldap.model.exception.LdapException,
                      org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

first

public boolean first()
              throws org.apache.directory.api.ldap.model.exception.LdapException,
                     org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

last

public boolean last()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

previous

public boolean previous()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

next

public boolean next()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

get

public org.apache.directory.api.ldap.model.cursor.Tuple<K,V> get()
                                                          throws org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.cursor.CursorException

close

public void close()

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

close

public void close(java.lang.Exception cause)

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

closeBrowser

private void closeBrowser(org.apache.directory.mavibot.btree.TupleCursor<K,V> browser)

Close the browser