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

Class DupsContainerCursor<K,V>

java.lang.Object

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

org.apache.directory.server.core.partition.impl.btree.jdbm.DupsContainerCursor<K,V>

All Implemented Interfaces:

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

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

A cursor for browsing tables with duplicates which returns the container for values rather than just the value.

Field Summary

Fields

Modifier and Type	Field and Description
private jdbm.helper.TupleBrowser<K,V>	browser A browser over the JDBM Table
private java.lang.Boolean	forwardDirection TODO : do we need this flag ???
private static boolean	IS_DEBUG Speedup for logs
private jdbm.helper.Tuple<K,V>	jdbmTuple A container to pass to the underlying JDBM to get back a tuple
private static org.slf4j.Logger	LOG_CURSOR A dedicated log for cursors
private org.apache.directory.api.ldap.model.cursor.Tuple<K,DupsContainer<V>>	returnedTuple
private JdbmTable<K,V>	table The JDBM table we are building a cursor over
private boolean	valueAvailable Tells if we have a tuple to return

Constructor Summary

Constructors

Constructor and Description
DupsContainerCursor(JdbmTable<K,V> table) Creates a Cursor over the tuples of a JDBM table.

Method Summary

Modifier and Type	Method and Description
void	after(org.apache.directory.api.ldap.model.cursor.Tuple<K,DupsContainer<V>> element)
void	afterKey(K key)
void	afterLast()
void	afterValue(K key, DupsContainer<V> value)
boolean	available()
void	before(org.apache.directory.api.ldap.model.cursor.Tuple<K,DupsContainer<V>> element) Positions this Cursor before the key of the supplied tuple.
void	beforeFirst()
void	beforeKey(K key)
void	beforeValue(K key, DupsContainer<V> value)
private void	clearValue() Clean the tuples we use to store the returned resut.
void	close()
void	close(java.lang.Exception cause)
boolean	first()
org.apache.directory.api.ldap.model.cursor.Tuple<K,DupsContainer<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

table

private final JdbmTable<K,V> table

The JDBM table we are building a cursor over

jdbmTuple

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

A container to pass to the underlying JDBM to get back a tuple

returnedTuple

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

browser

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

A browser over the JDBM Table

valueAvailable

private boolean valueAvailable

Tells if we have a tuple to return

forwardDirection

private java.lang.Boolean forwardDirection

TODO : do we need this flag ???

Constructor Detail

DupsContainerCursor

public DupsContainerCursor(JdbmTable<K,V> table)

Creates a Cursor over the tuples of a JDBM table.

Parameters:

table - the JDBM Table to build a Cursor over

Throws:

java.io.IOException - of there are problems accessing the BTree or if this table does not allow duplicate values

Method Detail

clearValue

private void clearValue()

Clean the tuples we use to store the returned resut.

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

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

Throws:

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

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

beforeValue

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

Throws:

java.lang.Exception

afterValue

public void afterValue(K key,
                       DupsContainer<V> value)
                throws java.lang.Exception

Throws:

java.lang.Exception

before

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

Positions this Cursor before the key of the supplied tuple.

Parameters:

element - the tuple who's key is used to position this Cursor

Throws:

java.io.IOException - 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,DupsContainer<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,DupsContainer<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,DupsContainer<V>>>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,DupsContainer<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,DupsContainer<V>>>

Overrides:

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