org.apache.directory.mavibot.btree

Class ValueBTreeCursor<V>

java.lang.Object

org.apache.directory.mavibot.btree.ValueBTreeCursor<V>

All Implemented Interfaces:

Cursor<V>, ValueCursor<V>

class ValueBTreeCursor<V>
extends java.lang.Object
implements ValueCursor<V>

A class that encapsulate the values into an sub-btree

Field Summary

Fields

Modifier and Type	Field and Description
private KeyCursor<V>	cursor Store the current position in the array or in the BTree
private BTree<V,V>	valueBtree The Value sub-btree

Fields inherited from interface org.apache.directory.mavibot.btree.Cursor

AFTER_LAST, BEFORE_FIRST

Constructor Summary

Constructors

Constructor and Description
ValueBTreeCursor(BTree<V,V> valueBtree) Create an instance

Method Summary

Modifier and Type	Method and Description
void	afterLast() Places the cursor at the end of the last position
void	beforeFirst() moves the cursor to the same position that was given at the time of instantiating the cursor.
void	close() Closes the cursor, thus releases the associated transaction
boolean	hasNext() Tells if the cursor can return a next element
boolean	hasPrev() Tells if the cursor can return a previous element
V	next() Find the next key/value
V	prev() Find the previous key/value
int	size()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

cursor

private KeyCursor<V> cursor

Store the current position in the array or in the BTree

valueBtree

private BTree<V,V> valueBtree

The Value sub-btree

Constructor Detail

ValueBTreeCursor

public ValueBTreeCursor(BTree<V,V> valueBtree)

Create an instance

Method Detail

hasNext

public boolean hasNext()

Tells if the cursor can return a next element}

Specified by:

hasNext in interface Cursor<V>

Returns:

true if there are some more elements

next

public V next()

Find the next key/value}

Specified by:

next in interface ValueCursor<V>

Returns:

A Tuple containing the found key and value

hasPrev

public boolean hasPrev()
                throws EndOfFileExceededException,
                       java.io.IOException

Tells if the cursor can return a previous element}

Specified by:

hasPrev in interface Cursor<V>

Returns:

true if there are some more elements

Throws:

EndOfFileExceededException

java.io.IOException

close

public void close()

Closes the cursor, thus releases the associated transaction}

Specified by:

close in interface Cursor<V>

beforeFirst

public void beforeFirst()
                 throws java.io.IOException

moves the cursor to the same position that was given at the time of instantiating the cursor. For example, if the cursor was created using browse() method, then beforeFirst() will place the cursor before the 0th position. If the cursor was created using browseFrom(K), then calling beforeFirst() will reset the position to the just before the position where K is present.}

Specified by:

beforeFirst in interface Cursor<V>

Throws:

java.io.IOException

afterLast

public void afterLast()
               throws java.io.IOException

Places the cursor at the end of the last position}

Specified by:

afterLast in interface Cursor<V>

Throws:

java.io.IOException

prev

public V prev()
       throws EndOfFileExceededException,
              java.io.IOException

Find the previous key/value}

Specified by:

prev in interface ValueCursor<V>

Returns:

A Tuple containing the found key and value

Throws:

EndOfFileExceededException

java.io.IOException

size

public int size()

Specified by:

size in interface ValueCursor<V>

Returns:

The number of elements stored in the cursor

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()