org.apache.directory.server.xdbm.search.impl

Class OneLevelScopeCursor<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.OneLevelScopeCursor<ID>

All Implemented Interfaces:

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 OneLevelScopeCursor<ID>
extends AbstractIndexCursor<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID>

A Cursor over entries satisfying one level scope constraints with alias dereferencing considerations when enabled during search.

Version:

$Rev$

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
OneLevelScopeCursor(Store<org.apache.directory.shared.ldap.entry.ServerEntry,ID> db, OneLevelScopeEvaluator<org.apache.directory.shared.ldap.entry.ServerEntry,ID> evaluator) Creates a Cursor over entries satisfying one level scope criteria.

Method Summary

Methods

Modifier and Type	Method and Description
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 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

OneLevelScopeCursor

public OneLevelScopeCursor(Store<org.apache.directory.shared.ldap.entry.ServerEntry,ID> db,
                   OneLevelScopeEvaluator<org.apache.directory.shared.ldap.entry.ServerEntry,ID> evaluator)
                    throws Exception

Creates a Cursor over entries satisfying one level scope criteria.

Parameters:

db - the entry store

evaluator - an IndexEntry (candidate) evaluator

Throws:

Exception - on db access failures

Method Detail

available

public boolean available()

beforeValue

public void beforeValue(ID id,
               ID value)
                 throws 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 entry

value - the value to advance just before

Throws:

Exception - if there are faults performing this operation

afterValue

public void afterValue(ID id,
              ID value)
                throws 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 entry

value - the value to advance just after the last value

Throws:

Exception - if there are faults performing this operation

before

public void before(IndexEntry<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID> element)
            throws Exception

Throws:

Exception

after

public void after(IndexEntry<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID> element)
           throws Exception

Throws:

Exception

beforeFirst

public void beforeFirst()
                 throws Exception

Throws:

Exception

afterLast

public void afterLast()
               throws Exception

Throws:

Exception

first

public boolean first()
              throws Exception

Throws:

Exception

last

public boolean last()
             throws Exception

Throws:

Exception

previous

public boolean previous()
                 throws Exception

Throws:

Exception

next

public boolean next()
             throws Exception

Throws:

Exception

get

public IndexEntry<ID,org.apache.directory.shared.ldap.entry.ServerEntry,ID> get()
                                                                         throws Exception

Throws:

Exception

isElementReused

public boolean isElementReused()