org.apache.directory.server.xdbm

Interface IndexCursor<V,E,ID>

All Superinterfaces:

org.apache.directory.shared.ldap.cursor.Cursor<IndexEntry<V,E,ID>>, Iterable<IndexEntry<V,E,ID>>

All Known Implementing Classes:

AbstractIndexCursor, AllEntriesCursor, AndCursor, ApproximateCursor, EmptyIndexCursor, EqualityCursor, GreaterEqCursor, IndexCursorAdaptor, LessEqCursor, NotCursor, OneLevelScopeCursor, OrCursor, PresenceCursor, SingletonIndexCursor, SubstringCursor, SubtreeScopeCursor

public interface IndexCursor<V,E,ID>
extends org.apache.directory.shared.ldap.cursor.Cursor<IndexEntry<V,E,ID>>

A Cursor introducing new advance methods designed to reduce some inefficiencies encountered when scanning over Tuples.

Version:

$Rev$

Author:

Apache Directory Project

Method Summary

Modifier and Type	Method and Description
void	afterValue(ID id, V indexValue) An alternative to calling after(IndexEntry) which often may require wrapping an id and value in a newly created IndexEntry object that may be an unnecessary object creation.
void	beforeValue(ID id, V indexValue) An alternative to calling before(IndexEntry) which often may require wrapping an id and value in a newly created IndexEntry object that may be an unnecessary object creation.

Methods inherited from interface org.apache.directory.shared.ldap.cursor.Cursor

after, afterLast, available, before, beforeFirst, close, close, first, get, isClosed, isElementReused, last, next, previous, setClosureMonitor

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

beforeValue

void beforeValue(ID id,
                 V indexValue)
          throws Exception

An alternative to calling before(IndexEntry) which often may require wrapping an id and value in a newly created IndexEntry object that may be an unnecessary object creation. Some implementations may not support this operation and may throw an UnsupportedOperationEception.

Parameters:

id - the id for the entry

indexValue - the value to advance just before

Throws:

Exception - if there are faults performing this operation

afterValue

void afterValue(ID id,
                V indexValue)
         throws Exception

An alternative to calling after(IndexEntry) which often may require wrapping an id and value in a newly created IndexEntry object that may be an unnecessary object creation. Some implementations may not support this operation and may throw an UnsupportedOperationEception.

Parameters:

id - the id for the entry

indexValue - the value to advance just after the last value

Throws:

Exception - if there are faults performing this operation