org.apache.directory.server.xdbm

Class AbstractIndexCursor<V>

java.lang.Object

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AllEntriesCursor, AndCursor, ApproximateCursor, ChildrenCursor, DescendantCursor, EmptyIndexCursor, EqualityCursor, GreaterEqCursor, IndexCursorAdaptor, LessEqCursor, NotCursor, OrCursor, PresenceCursor, SingletonIndexCursor, SubstringCursor

public abstract class AbstractIndexCursor<V>
extends org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<V,String>>

An abstract Cursor used by the index cursors.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.directory.server.core.api.partition.PartitionTxn	partitionTxn A transaction associated with this cursor
protected static String	UNSUPPORTED_MSG The message used for unsupported operations

Constructor Summary

Constructors

Constructor and Description
AbstractIndexCursor()

Method Summary

Modifier and Type	Method and Description
void	after(IndexEntry<V,String> element)
boolean	available()
void	before(IndexEntry<V,String> element)
protected abstract String	getUnsupportedMessage() Gets the message to return for operations that are not supported
boolean	next()
boolean	previous()
protected boolean	setAvailable(boolean available)

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

checkNotClosed, close, close, 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 org.apache.directory.api.ldap.model.cursor.Cursor

afterLast, beforeFirst, first, get, last

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

partitionTxn

protected org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn

A transaction associated with this cursor

UNSUPPORTED_MSG

protected static final String UNSUPPORTED_MSG

The message used for unsupported operations

See Also:

Constant Field Values

Constructor Detail

AbstractIndexCursor

public AbstractIndexCursor()

Method Detail

available

public boolean available()

getUnsupportedMessage

protected abstract String getUnsupportedMessage()

Gets the message to return for operations that are not supported

Returns:

The Unsupported message

after

public void after(IndexEntry<V,String> 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

before

public void before(IndexEntry<V,String> 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

setAvailable

protected boolean setAvailable(boolean available)

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