|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.directory.server.xdbm.AbstractIndexCursor<java.lang.Long,ServerEntry>
org.apache.directory.server.xdbm.search.impl.OneLevelScopeCursor
public class OneLevelScopeCursor
A Cursor over entries satisfying one level scope constraints with alias dereferencing considerations when enabled during search.
Constructor Summary | |
---|---|
OneLevelScopeCursor(Store<ServerEntry> db,
OneLevelScopeEvaluator evaluator)
Creates a Cursor over entries satisfying one level scope criteria. |
Method Summary | |
---|---|
void |
after(IndexEntry<java.lang.Long,ServerEntry> element)
Prepares this Cursor, so a subsequent call to Cursor#previous() with a true return value, will have positioned the Cursor on a dataset element equal to or less than the element argument but not greater. |
void |
afterLast()
Positions this Curser after the last element. |
void |
afterValue(java.lang.Long id,
java.lang.Long value)
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. |
boolean |
available()
Determines whether or not a call to get() will succeed. |
void |
before(IndexEntry<java.lang.Long,ServerEntry> element)
Prepares this Cursor, so a subsequent call to Cursor#next() with a true return value, will have positioned the Cursor on a dataset element equal to or less than the element argument but not greater. |
void |
beforeFirst()
Positions this Curser before the first element. |
void |
beforeValue(java.lang.Long id,
java.lang.Long value)
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. |
boolean |
first()
Positions this Curser at the first element. |
IndexEntry<java.lang.Long,ServerEntry> |
get()
Gets the object at the current position. |
boolean |
isElementReused()
Gets whether or not this Cursor will return the same element object instance on get() operations for any position of this Cursor. |
boolean |
last()
Positions this Curser at the last element. |
boolean |
next()
Advances this Cursor to the next position. |
boolean |
previous()
Advances this Cursor to the previous position. |
Methods inherited from class org.apache.directory.server.xdbm.AbstractIndexCursor |
---|
checkNotClosed, close, close, isClosed, iterator, setClosureMonitor |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public OneLevelScopeCursor(Store<ServerEntry> db, OneLevelScopeEvaluator evaluator) throws java.lang.Exception
db
- the entry storeevaluator
- an IndexEntry (candidate) evaluator
java.lang.Exception
- on db access failuresMethod Detail |
---|
public boolean available()
Cursor
public void beforeValue(java.lang.Long id, java.lang.Long value) throws java.lang.Exception
IndexCursor
id
- the Long id for the entryvalue
- the value to advance just before
java.lang.Exception
- if there are faults peforming this operationpublic void afterValue(java.lang.Long id, java.lang.Long value) throws java.lang.Exception
IndexCursor
id
- the Long id for the entryvalue
- the value to advance just after the last value
java.lang.Exception
- if there are faults peforming this operationpublic void before(IndexEntry<java.lang.Long,ServerEntry> element) throws java.lang.Exception
Cursor
element
- the element to be positioned before
java.lang.Exception
- with problems accessing the underlying btree
java.lang.UnsupportedOperationException
- if this method is not supportedpublic void after(IndexEntry<java.lang.Long,ServerEntry> element) throws java.lang.Exception
Cursor
element
- the element to be positioned after
java.lang.Exception
- if there are problems positioning this cursor or if
this Cursor is closed
java.lang.UnsupportedOperationException
- if this method is not supportedpublic void beforeFirst() throws java.lang.Exception
Cursor
java.lang.Exception
- if there are problems positioning this cursor or if
this Cursor is closed
java.lang.UnsupportedOperationException
- if this method is not supportedpublic void afterLast() throws java.lang.Exception
Cursor
java.lang.Exception
- if there are problems positioning this Cursor or if
this Cursor is closed
java.lang.UnsupportedOperationException
- if this method is not supportedpublic boolean first() throws java.lang.Exception
Cursor
java.lang.Exception
- if there are problems positioning this Cursor or if
this Cursor is closed
java.lang.UnsupportedOperationException
- if this method is not supportedpublic boolean last() throws java.lang.Exception
Cursor
java.lang.Exception
- if there are problems positioning this Cursor or if
this Cursor is closed
java.lang.UnsupportedOperationException
- if this method is not supportedpublic boolean previous() throws java.lang.Exception
Cursor
java.lang.Exception
- if there are problems advancing to the next position
java.lang.UnsupportedOperationException
- if this method is not supportedpublic boolean next() throws java.lang.Exception
Cursor
java.lang.Exception
- if there are problems advancing to this Cursor to
the next position, or if this Cursor is closed
java.lang.UnsupportedOperationException
- if this method is not supportedpublic IndexEntry<java.lang.Long,ServerEntry> get() throws java.lang.Exception
Cursor
java.lang.Exception
- if the object at this Cursor's current position
cannot be retrieved, or if this Cursor is closedpublic boolean isElementReused()
Cursor
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |