org.apache.directory.server.xdbm.impl.avl

Class AvlTableDupsCursor<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.xdbm.impl.avl.AvlTableDupsCursor<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 AvlTableDupsCursor<K,V>
extends org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.cursor.Tuple<K,V>>

A Cursor which walks and advance over AvlTables that may contain duplicate keys with values stored in an AvlTree. All duplicate keys are traversed returning the key and the value in a Tuple.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.cursor.Cursor<V>	dupsCursor A Cursor over a set of value objects for the current key held in the containerTuple.
private static boolean	IS_DEBUG Speedup for logs
private static org.slf4j.Logger	LOG
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 that is used to return values via the get() method.
private AvlTable<K,V>	table The AVL backed table this Cursor traverses over.
private boolean	valueAvailable Whether or not a value is available when get() is called.
private AvlSingletonOrOrderedSetCursor<K,V>	wrappedCursor The underlying wrapped cursor which returns Tuples whose values are either V objects or AvlTree objects.
private org.apache.directory.api.ldap.model.cursor.Tuple<K,SingletonOrOrderedSet<V>>	wrappedTuple The current Tuple returned from the wrapped cursor.

Constructor Summary

Constructors

Constructor and Description
AvlTableDupsCursor(AvlTable<K,V> table) Creates a new instance of AvlTableDupsCursor.

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)
void	beforeFirst()
void	beforeKey(K key)
void	beforeValue(K key, V value)
private void	clearValue() Clears the returned Tuple and makes sure valueAvailable returns false.
void	close()
void	close(java.lang.Exception reason)
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

private static final org.slf4j.Logger LOG

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 AvlTable<K,V> table

The AVL backed table this Cursor traverses over.

wrappedCursor

private final AvlSingletonOrOrderedSetCursor<K,V> wrappedCursor

The underlying wrapped cursor which returns Tuples whose values are either V objects or AvlTree objects.

dupsCursor

private org.apache.directory.api.ldap.model.cursor.Cursor<V> dupsCursor

A Cursor over a set of value objects for the current key held in the containerTuple. A new Cursor will be set for each new key as we traverse. The Cursor traverses over either a AvlTree object full of values in a multi-valued key or it traverses over a BTree which contains the values in the key field of it's Tuples.

wrappedTuple

private final org.apache.directory.api.ldap.model.cursor.Tuple<K,SingletonOrOrderedSet<V>> wrappedTuple

The current Tuple returned from the wrapped cursor.

returnedTuple

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

The Tuple that is used to return values via the get() method. This same Tuple instance will be returned every time. At different positions it may return different values for the same key.

valueAvailable

private boolean valueAvailable

Whether or not a value is available when get() is called.

Constructor Detail

AvlTableDupsCursor

public AvlTableDupsCursor(AvlTable<K,V> table)

Creates a new instance of AvlTableDupsCursor.

Parameters:

table - the AvlTable to build a Cursor on.

Method Detail

available

public boolean available()

beforeKey

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

Throws:

java.lang.Exception

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

Throws:

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

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

afterKey

public void afterKey(K key)
              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

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

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

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

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

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

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

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

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

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

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

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

clearValue

private void clearValue()

Clears the returned Tuple and makes sure valueAvailable returns false.