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

Class KeyTupleBTreeCursor<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.jdbm.KeyTupleBTreeCursor<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>>

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

Cursor over a set of values for the same key which are store in another BTree. This Cursor is limited to the same key and it's tuples will always return the same key.

Field Summary

Fields

Modifier and Type	Field and Description
private jdbm.helper.TupleBrowser<K,V>	browser
private jdbm.btree.BTree	btree
private java.util.Comparator<V>	comparator
private static boolean	IS_DEBUG Speedup for logs
private K	key
private static org.slf4j.Logger	LOG_CURSOR A dedicated log for cursors
private org.apache.directory.api.ldap.model.cursor.Tuple<K,V>	returnedTuple
private boolean	valueAvailable
private jdbm.helper.Tuple<K,V>	valueTuple

Constructor Summary

Constructors

Constructor and Description
KeyTupleBTreeCursor(jdbm.btree.BTree btree, K key, java.util.Comparator<V> comparator) Creates a Cursor over the tuples of a JDBM BTree.

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)
void	afterLast()
void	afterValue(K key, V value)
boolean	available()
void	before(org.apache.directory.api.ldap.model.cursor.Tuple<K,V> element) Positions this Cursor over the same keys before the value of the supplied valueTuple.
void	beforeFirst()
void	beforeKey(K key)
void	beforeValue(K key, V value)
private void	clearValue()
void	close()
void	close(java.lang.Exception cause)
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

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for logs

comparator

private final java.util.Comparator<V> comparator

btree

private final jdbm.btree.BTree btree

key

private final K key

valueTuple

private jdbm.helper.Tuple<K,V> valueTuple

returnedTuple

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

browser

private jdbm.helper.TupleBrowser<K,V> browser

valueAvailable

private boolean valueAvailable

Constructor Detail

KeyTupleBTreeCursor

public KeyTupleBTreeCursor(jdbm.btree.BTree btree,
                           K key,
                           java.util.Comparator<V> comparator)
                    throws java.lang.Exception

Creates a Cursor over the tuples of a JDBM BTree.

Parameters:

btree - the JDBM BTree to build a Cursor over

key - the constant key for which values are returned

comparator - the Comparator used to determine key ordering

Throws:

java.lang.Exception - of there are problems accessing the BTree

Method Detail

clearValue

private void clearValue()

available

public boolean available()

beforeKey

public void beforeKey(K key)
               throws java.lang.Exception

Throws:

java.lang.Exception

afterKey

public void afterKey(K key)
              throws java.lang.Exception

Throws:

java.lang.Exception

beforeValue

public void beforeValue(K key,
                        V value)
                 throws java.lang.Exception

Throws:

java.lang.Exception

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

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

Positions this Cursor over the same keys before the value of the supplied valueTuple. The supplied element Tuple's key is not considered at all.

Parameters:

element - the valueTuple who's value is used to position this Cursor

Throws:

java.lang.Exception - if there are failures to position the Cursor

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>>