org.apache.directory.server.xdbm
Interface IndexCursor<V,E>
- All Superinterfaces:
- Cursor<IndexEntry<V,E>>, java.lang.Iterable<IndexEntry<V,E>>
- 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>
- extends Cursor<IndexEntry<V,E>>
A Cursor introducing new advance methods designed to reduce some
inefficiencies encountered when scanning over Tuples.
- Version:
- $Rev$
- Author:
- Apache Directory Project
Method Summary |
void |
afterValue(java.lang.Long 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(java.lang.Long 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.server.core.cursor.Cursor |
after, afterLast, available, before, beforeFirst, close, close, first, get, isClosed, isElementReused, last, next, previous, setClosureMonitor |
Methods inherited from interface java.lang.Iterable |
iterator |
beforeValue
void beforeValue(java.lang.Long id,
V indexValue)
throws java.lang.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 Long id for the entryindexValue
- the value to advance just before
- Throws:
java.lang.Exception
- if there are faults peforming this operation
afterValue
void afterValue(java.lang.Long id,
V indexValue)
throws java.lang.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 Long id for the entryindexValue
- the value to advance just after the last value
- Throws:
java.lang.Exception
- if there are faults peforming this operation
Copyright © 2003-2009 Apache Software Foundation. All Rights Reserved.