org.apache.directory.server.xdbm.search.cursor

Class DescendantCursor

java.lang.Object

org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<V,String>>

org.apache.directory.server.xdbm.AbstractIndexCursor<String>

org.apache.directory.server.xdbm.search.cursor.DescendantCursor

All Implemented Interfaces:

Iterable<IndexEntry<String,String>>, org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<String,String>>

public class DescendantCursor
extends AbstractIndexCursor<String>

A Cursor over entries satisfying one level scope constraints with alias dereferencing considerations when enabled during search. We use the Rdn index to fetch all the descendants of a given entry.

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	INNER
protected static boolean	TOP_LEVEL

Constructor Summary

Constructors

Constructor and Description
DescendantCursor(Store db, String baseId, String parentId, org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<ParentIdAndRdn,String>> cursor) Creates a Cursor over entries satisfying one level scope criteria.
DescendantCursor(Store db, String baseId, String parentId, org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<ParentIdAndRdn,String>> cursor, boolean topLevel) Creates a Cursor over entries satisfying one level scope criteria.

Method Summary

Methods

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

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

after, available, before, setAvailable

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

checkNotClosed, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, iterator, setClosureMonitor

Methods inherited from class java.lang.Object

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

Field Detail

TOP_LEVEL

protected static final boolean TOP_LEVEL

See Also:

Constant Field Values

INNER

protected static final boolean INNER

See Also:

Constant Field Values

Constructor Detail

DescendantCursor

public DescendantCursor(Store db,
                String baseId,
                String parentId,
                org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<ParentIdAndRdn,String>> cursor)
                 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

DescendantCursor

public DescendantCursor(Store db,
                String baseId,
                String parentId,
                org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<ParentIdAndRdn,String>> cursor,
                boolean topLevel)
                 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

getUnsupportedMessage

protected String getUnsupportedMessage()

Gets the message to return for operations that are not supported

Specified by:

getUnsupportedMessage in class AbstractIndexCursor<String>

Returns:

The Unsupported message

beforeFirst

public void beforeFirst()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

afterLast

public void afterLast()
               throws org.apache.directory.api.ldap.model.exception.LdapException,
                      org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

first

public boolean first()
              throws org.apache.directory.api.ldap.model.exception.LdapException,
                     org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

last

public boolean last()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

previous

public boolean previous()
                 throws org.apache.directory.api.ldap.model.exception.LdapException,
                        org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

next

public boolean next()
             throws org.apache.directory.api.ldap.model.exception.LdapException,
                    org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.exception.LdapException

org.apache.directory.api.ldap.model.cursor.CursorException

get

public IndexEntry<String,String> get()
                              throws org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

org.apache.directory.api.ldap.model.cursor.CursorException

close

public void close()

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<String,String>>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<String,String>>

close

public void close(Exception cause)

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<String,String>>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<String,String>>

toString

public String toString(String tabs)

Specified by:

toString in interface org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<String,String>>

Overrides:

toString in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<String,String>>

See Also:

Object.toString()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()