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

Class ChildrenCursor

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.ChildrenCursor

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 ChildrenCursor
extends AbstractIndexCursor<java.lang.String>

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

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<ParentIdAndRdn,java.lang.String>>	cursor A Cursor over the entries in the scope of the search base
private static boolean	IS_DEBUG Speedup for logs
private static org.slf4j.Logger	LOG_CURSOR A dedicated log for cursors
private java.lang.String	parentId The Parent ID
private IndexEntry<java.lang.String,java.lang.String>	prefetched The prefetched element
private static java.lang.String	UNSUPPORTED_MSG Error message for unsupported operations

Constructor Summary

Constructors

Constructor and Description
ChildrenCursor(Store db, 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.

Method Summary

Modifier and Type	Method and Description
void	afterLast()
void	beforeFirst()
void	close()
void	close(java.lang.Exception cause)
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

cursor

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

A Cursor over the entries in the scope of the search base

parentId

private java.lang.String parentId

The Parent ID

prefetched

private IndexEntry<java.lang.String,java.lang.String> prefetched

The prefetched element

Constructor Detail

ChildrenCursor

public ChildrenCursor(Store db,
                      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

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>>

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()