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

Class IndexCursorAdaptor<K>

java.lang.Object

org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<V,String>>

org.apache.directory.server.xdbm.AbstractIndexCursor<K>

org.apache.directory.server.core.partition.impl.btree.IndexCursorAdaptor<K>

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<IndexEntry<K,String>>, org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

public class IndexCursorAdaptor<K>
extends AbstractIndexCursor<K>

A Cursor which adapts an underlying Tuple based Cursor to one which returns IndexEntry objects rather than tuples.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.server.xdbm.AbstractIndexCursor

partitionTxn, UNSUPPORTED_MSG

Constructor Summary

Constructors

Constructor and Description
IndexCursorAdaptor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.cursor.Tuple> wrappedCursor, boolean forwardIndex) Creates an IndexCursorAdaptor which wraps and adapts a Cursor from a table to one which returns an IndexEntry.

Method Summary

Modifier and Type	Method and Description
void	after(IndexEntry<K,String> element)
void	afterLast()
boolean	available()
void	before(IndexEntry<K,String> element)
void	beforeFirst()
void	close()
void	close(Exception reason)
boolean	first()
IndexEntry<K,String>	get()
protected String	getUnsupportedMessage() Gets the message to return for operations that are not supported
boolean	isAfterLast()
boolean	isBeforeFirst()
boolean	isClosed()
boolean	isFirst()
boolean	isLast()
Iterator<IndexEntry<K,String>>	iterator()
boolean	last()
boolean	next()
boolean	previous()
void	setClosureMonitor(org.apache.directory.api.ldap.model.cursor.ClosureMonitor monitor)
String	toString()
String	toString(String tabs)

Methods inherited from class org.apache.directory.server.xdbm.AbstractIndexCursor

setAvailable

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

checkNotClosed

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

IndexCursorAdaptor

public IndexCursorAdaptor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                          org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.cursor.Tuple> wrappedCursor,
                          boolean forwardIndex)

Creates an IndexCursorAdaptor which wraps and adapts a Cursor from a table to one which returns an IndexEntry.

Parameters:

partitionTxn - The transaction to use

wrappedCursor - the Cursor being adapted

forwardIndex - true for a cursor over a forward index, false for one over a reverse index

Method Detail

available

public boolean available()

Specified by:

available in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

available in class AbstractIndexCursor<K>

before

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

Specified by:

before in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

before in class AbstractIndexCursor<K>

Throws:

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

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

after

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

Specified by:

after in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

after in class AbstractIndexCursor<K>

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

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

isClosed in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<K,String>>

previous

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

Specified by:

previous in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

previous in class AbstractIndexCursor<K>

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

Specified by:

next in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

next in class AbstractIndexCursor<K>

Throws:

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

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

get

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

Throws:

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

setClosureMonitor

public final void setClosureMonitor(org.apache.directory.api.ldap.model.cursor.ClosureMonitor monitor)

Specified by:

setClosureMonitor in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

setClosureMonitor in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<K,String>>

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

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

Throws:

IOException

close

public void close(Exception reason)
           throws IOException

Specified by:

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

Overrides:

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

Throws:

IOException

iterator

public Iterator<IndexEntry<K,String>> iterator()

Specified by:

iterator in interface Iterable<IndexEntry<K,String>>

Overrides:

iterator in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<K,String>>

isAfterLast

public boolean isAfterLast()

Specified by:

isAfterLast in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

isAfterLast in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<K,String>>

isBeforeFirst

public boolean isBeforeFirst()

Specified by:

isBeforeFirst in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

isBeforeFirst in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<K,String>>

isFirst

public boolean isFirst()

Specified by:

isFirst in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

isFirst in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<K,String>>

isLast

public boolean isLast()

Specified by:

isLast in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

isLast in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<K,String>>

getUnsupportedMessage

protected String getUnsupportedMessage()

Gets the message to return for operations that are not supported

Specified by:

getUnsupportedMessage in class AbstractIndexCursor<K>

Returns:

The Unsupported message

toString

public String toString(String tabs)

Specified by:

toString in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<K,String>>

Overrides:

toString in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<K,String>>

See Also:

Object.toString()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()