org.apache.directory.server.xdbm.search.impl
Class SubtreeScopeCursor<ID extends Comparable<ID>>

java.lang.Object
  org.apache.directory.shared.ldap.model.cursor.AbstractCursor<IndexEntry<V,ID>>
      org.apache.directory.server.xdbm.AbstractIndexCursor<ID,org.apache.directory.shared.ldap.model.entry.Entry,ID>
          org.apache.directory.server.xdbm.search.impl.SubtreeScopeCursor<ID>

All Implemented Interfaces:

Iterable<IndexEntry<ID,ID>>, IndexCursor<ID,org.apache.directory.shared.ldap.model.entry.Entry,ID>, org.apache.directory.shared.ldap.model.cursor.Cursor<IndexEntry<ID,ID>>

public class SubtreeScopeCursor<ID extends Comparable<ID>>
extends AbstractIndexCursor<ID,org.apache.directory.shared.ldap.model.entry.Entry,ID>

A Cursor over entries satisfying scope constraints with alias dereferencing considerations.

Author:

Apache Directory Project

Constructor Summary

SubtreeScopeCursor(Store<org.apache.directory.shared.ldap.model.entry.Entry,ID> db, SubtreeScopeEvaluator<org.apache.directory.shared.ldap.model.entry.Entry,ID> evaluator)
Creates a Cursor over entries satisfying subtree level scope criteria.

Method Summary

void	afterLast()
void	beforeFirst()
void	close()
void	close(Exception cause)
boolean	first()
IndexEntry<ID,ID>	get()
protected String	getUnsupportedMessage() Gets the message to return for operations that are not supported
boolean	last()
boolean	next()
boolean	previous()

Methods inherited from class org.apache.directory.server.xdbm.AbstractIndexCursor

after, afterValue, available, before, beforeValue, isAfterLast, isBeforeFirst, isFirst, isLast, iterator, setAvailable

Methods inherited from class org.apache.directory.shared.ldap.model.cursor.AbstractCursor

checkNotClosed, isClosed, setClosureMonitor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

isClosed, setClosureMonitor

Constructor Detail

SubtreeScopeCursor

public SubtreeScopeCursor(Store<org.apache.directory.shared.ldap.model.entry.Entry,ID> db,
                          SubtreeScopeEvaluator<org.apache.directory.shared.ldap.model.entry.Entry,ID> evaluator)
                   throws Exception

Creates a Cursor over entries satisfying subtree level scope criteria.

Parameters:

db - the entry store

evaluator - an IndexEntry (candidate) evaluator

Throws:

Exception - on db access failures

Method Detail

getUnsupportedMessage

protected String getUnsupportedMessage()

Gets the message to return for operations that are not supported

Specified by:

getUnsupportedMessage in class AbstractIndexCursor<ID extends Comparable<ID>,org.apache.directory.shared.ldap.model.entry.Entry,ID extends Comparable<ID>>

Returns:

The Unsupported message

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,ID> get()
                                                                    throws Exception

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface org.apache.directory.shared.ldap.model.cursor.Cursor<IndexEntry<ID extends Comparable<ID>,ID extends Comparable<ID>>>

Overrides:

close in class org.apache.directory.shared.ldap.model.cursor.AbstractCursor<IndexEntry<ID extends Comparable<ID>,ID extends Comparable<ID>>>

Throws:

Exception

close

public void close(Exception cause)
           throws Exception

Specified by:

close in interface org.apache.directory.shared.ldap.model.cursor.Cursor<IndexEntry<ID extends Comparable<ID>,ID extends Comparable<ID>>>

Overrides:

close in class org.apache.directory.shared.ldap.model.cursor.AbstractCursor<IndexEntry<ID extends Comparable<ID>,ID extends Comparable<ID>>>

Throws:

Exception