org.apache.directory.server.xdbm.search.impl
Class SubtreeScopeCursor<ID>
java.lang.Object
org.apache.directory.server.xdbm.AbstractIndexCursor<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID>
org.apache.directory.server.xdbm.search.impl.SubtreeScopeCursor<ID>
- All Implemented Interfaces:
- java.lang.Iterable<IndexEntry<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID>>, IndexCursor<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID>, org.apache.directory.shared.ldap.cursor.Cursor<IndexEntry<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID>>
public class SubtreeScopeCursor<ID>
- extends AbstractIndexCursor<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID>
A Cursor over entries satisfying scope constraints with alias dereferencing
considerations.
- Version:
- $Rev$
- Author:
- Apache Directory Project
Constructor Summary |
SubtreeScopeCursor(Store<org.apache.directory.shared.ldap.entry.ServerEntry,ID> db,
SubtreeScopeEvaluator<org.apache.directory.shared.ldap.entry.ServerEntry,ID> evaluator)
Creates a Cursor over entries satisfying subtree level scope criteria. |
Method Summary |
void |
after(IndexEntry<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID> element)
|
void |
afterLast()
|
void |
afterValue(ID id,
ID 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()
|
void |
before(IndexEntry<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID> element)
|
void |
beforeFirst()
|
void |
beforeValue(ID id,
ID 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()
|
IndexEntry<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID> |
get()
|
boolean |
isElementReused()
|
boolean |
last()
|
boolean |
next()
|
boolean |
previous()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SubtreeScopeCursor
public SubtreeScopeCursor(Store<org.apache.directory.shared.ldap.entry.ServerEntry,ID> db,
SubtreeScopeEvaluator<org.apache.directory.shared.ldap.entry.ServerEntry,ID> evaluator)
throws java.lang.Exception
- Creates a Cursor over entries satisfying subtree level scope criteria.
- Parameters:
db
- the entry storeevaluator
- an IndexEntry (candidate) evaluator
- Throws:
java.lang.Exception
- on db access failures
available
public boolean available()
beforeValue
public void beforeValue(ID id,
ID value)
throws java.lang.Exception
- Description copied from interface:
IndexCursor
- 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 entryvalue
- the value to advance just before
- Throws:
java.lang.Exception
- if there are faults performing this operation
before
public void before(IndexEntry<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID> element)
throws java.lang.Exception
- Throws:
java.lang.Exception
afterValue
public void afterValue(ID id,
ID value)
throws java.lang.Exception
- Description copied from interface:
IndexCursor
- 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 entryvalue
- the value to advance just after the last value
- Throws:
java.lang.Exception
- if there are faults performing this operation
after
public void after(IndexEntry<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID> element)
throws java.lang.Exception
- Throws:
java.lang.Exception
beforeFirst
public void beforeFirst()
throws java.lang.Exception
- Throws:
java.lang.Exception
afterLast
public void afterLast()
throws java.lang.Exception
- Throws:
java.lang.Exception
first
public boolean first()
throws java.lang.Exception
- Throws:
java.lang.Exception
last
public boolean last()
throws java.lang.Exception
- Throws:
java.lang.Exception
previous
public boolean previous()
throws java.lang.Exception
- Throws:
java.lang.Exception
next
public boolean next()
throws java.lang.Exception
- Throws:
java.lang.Exception
get
public IndexEntry<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID> get()
throws java.lang.Exception
- Throws:
java.lang.Exception
isElementReused
public boolean isElementReused()
Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.