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

Class DescendantCursor

java.lang.Object

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

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

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

All Implemented Interfaces:

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

public class DescendantCursor
extends AbstractIndexCursor<java.lang.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.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	baseId The initial entry ID we are looking descendants for
private org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<ParentIdAndRdn,java.lang.String>>	currentCursor The current Cursor over the entries in the scope of the search base
private java.lang.String	currentParentId The current Parent ID
private org.apache.commons.collections.ArrayStack	cursorStack The stack of cursors used to process the depth-first traversal
private Store	db The entry database/store
protected static boolean	INNER
private static boolean	IS_DEBUG Speedup for logs
private static org.slf4j.Logger	LOG_CURSOR A dedicated log for cursors
private org.apache.commons.collections.ArrayStack	parentIdStack The stack of parentIds used to process the depth-first traversal
private IndexEntry	prefetched The prefetched element
protected static boolean	TOP_LEVEL
private boolean	topLevel A flag to tell that we are in the top level cursor or not
private static java.lang.String	UNSUPPORTED_MSG Error message for unsupported operations

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	afterLast()
void	beforeFirst()
void	close()
void	close(java.lang.Exception cause)
private java.lang.String	dumpCursors(java.lang.String tabs) Dumps the cursors
boolean	first()
IndexEntry<java.lang.String,java.lang.String>	get()
protected java.lang.String	getUnsupportedMessage() Gets the message to return for operations that are not supported
boolean	last()
boolean	next()
boolean	previous()
java.lang.String	toString()
java.lang.String	toString(java.lang.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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

LOG_CURSOR

private static final org.slf4j.Logger LOG_CURSOR

A dedicated log for cursors

IS_DEBUG

private static final boolean IS_DEBUG

Speedup for logs

UNSUPPORTED_MSG

private static final java.lang.String UNSUPPORTED_MSG

Error message for unsupported operations

db

private final Store db

The entry database/store

prefetched

private IndexEntry prefetched

The prefetched element

currentCursor

private org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<ParentIdAndRdn,java.lang.String>> currentCursor

The current Cursor over the entries in the scope of the search base

currentParentId

private java.lang.String currentParentId

The current Parent ID

cursorStack

private org.apache.commons.collections.ArrayStack cursorStack

The stack of cursors used to process the depth-first traversal

parentIdStack

private org.apache.commons.collections.ArrayStack parentIdStack

The stack of parentIds used to process the depth-first traversal

baseId

private java.lang.String baseId

The initial entry ID we are looking descendants for

topLevel

private boolean topLevel

A flag to tell that we are in the top level cursor or not

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,
                        java.lang.String baseId,
                        java.lang.String parentId,
                        org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<ParentIdAndRdn,java.lang.String>> cursor)
                 throws java.lang.Exception

Creates a Cursor over entries satisfying one level scope criteria.

Parameters:

db - the entry store

evaluator - an IndexEntry (candidate) evaluator

Throws:

java.lang.Exception - on db access failures

DescendantCursor

public DescendantCursor(Store db,
                        java.lang.String baseId,
                        java.lang.String parentId,
                        org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<ParentIdAndRdn,java.lang.String>> cursor,
                        boolean topLevel)
                 throws java.lang.Exception

Creates a Cursor over entries satisfying one level scope criteria.

Parameters:

db - the entry store

evaluator - an IndexEntry (candidate) evaluator

Throws:

java.lang.Exception - on db access failures

Method Detail

getUnsupportedMessage

protected java.lang.String getUnsupportedMessage()

Gets the message to return for operations that are not supported

Specified by:

getUnsupportedMessage in class AbstractIndexCursor<java.lang.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<java.lang.String,java.lang.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<java.lang.String,java.lang.String>>

Overrides:

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

close

public void close(java.lang.Exception cause)

Specified by:

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

Overrides:

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

dumpCursors

private java.lang.String dumpCursors(java.lang.String tabs)

Dumps the cursors

toString

public java.lang.String toString(java.lang.String tabs)

Specified by:

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

Overrides:

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

See Also:

Object.toString()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()