org.apache.directory.server.core.api.filtering

Class CursorList

java.lang.Object

org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

org.apache.directory.server.core.api.filtering.CursorList

All Implemented Interfaces:

java.lang.Iterable<org.apache.directory.api.ldap.model.entry.Entry>, org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>, EntryFilteringCursor

public class CursorList
extends org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>
implements EntryFilteringCursor

An implementation of a Cursor based on a List of Cursors. Optionally, the Cursor may be limited to a specific range within the list. This class is modeled based on the implementation of ListCursor WARN this is only used internally !

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	closed flag to detect the closed cursor
private EntryFilteringCursor	currentCursor The current cursor being used
private int	end The ending position for the cursor in the list.
private int	index The current position in the list
private static boolean	IS_DEBUG Speedup for logs
private java.util.List<EntryFilteringCursor>	list The inner List
private int	listSize The number of cursors in the list
private static org.slf4j.Logger	LOG The logger for this class
private static org.slf4j.Logger	LOG_CURSOR A dedicated log for cursors
private SearchOperationContext	searchContext the operation context
private int	start The starting position for the cursor in the list.

Constructor Summary

Constructors

Constructor and Description
CursorList(int start, java.util.List<EntryFilteringCursor> list, int end, SearchOperationContext searchContext) Creates a new ListCursor with lower (inclusive) and upper (exclusive) bounds.
CursorList(java.util.List<EntryFilteringCursor> list, SearchOperationContext searchContext) Creates a new ListCursor without specific bounds: the bounds are acquired from the size of the list.

Method Summary

Modifier and Type	Method and Description
boolean	addEntryFilter(EntryFilter filter) Adds an entry filter to this BaseEntryFilteringCursor at the very end of the filter list.
void	after(org.apache.directory.api.ldap.model.entry.Entry element)
void	afterLast()
boolean	available()
void	before(org.apache.directory.api.ldap.model.entry.Entry element)
void	beforeFirst()
void	close()
void	close(java.lang.Exception reason)
boolean	first()
org.apache.directory.api.ldap.model.entry.Entry	get()
java.util.List<EntryFilter>	getEntryFilters() Gets an unmodifiable list of EntryFilters applied.
SearchOperationContext	getOperationContext()
boolean	isAbandoned()
boolean	isAfterLast()
boolean	isBeforeFirst()
boolean	isClosed()
boolean	isFirst()
boolean	isLast()
java.util.Iterator<org.apache.directory.api.ldap.model.entry.Entry>	iterator()
boolean	last()
boolean	next()
boolean	previous()
void	setAbandoned(boolean abandoned)
void	setClosureMonitor(org.apache.directory.api.ldap.model.cursor.ClosureMonitor monitor)

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

checkNotClosed, toString

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.api.ldap.model.cursor.Cursor

toString

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

list

private final java.util.List<EntryFilteringCursor> list

The inner List

start

private final int start

The starting position for the cursor in the list. It can be > 0

end

private final int end

The ending position for the cursor in the list. It can be < List.size()

listSize

private final int listSize

The number of cursors in the list

index

private int index

The current position in the list

currentCursor

private EntryFilteringCursor currentCursor

The current cursor being used

searchContext

private SearchOperationContext searchContext

the operation context

closed

private boolean closed

flag to detect the closed cursor

LOG

private static final org.slf4j.Logger LOG

The logger for this class

Constructor Detail

CursorList

public CursorList(int start,
                  java.util.List<EntryFilteringCursor> list,
                  int end,
                  SearchOperationContext searchContext)

Creates a new ListCursor with lower (inclusive) and upper (exclusive) bounds. As with all Cursors, this ListCursor requires a successful return from advance operations (next() or previous()) to properly return values using the get() operation.

Parameters:

start - the lower bound index

list - the list this ListCursor operates on

end - the upper bound index

CursorList

public CursorList(java.util.List<EntryFilteringCursor> list,
                  SearchOperationContext searchContext)

Creates a new ListCursor without specific bounds: the bounds are acquired from the size of the list.

Parameters:

list - the backing for this ListCursor

Method Detail

available

public boolean available()

Specified by:

available in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

before

public void before(org.apache.directory.api.ldap.model.entry.Entry element)
            throws org.apache.directory.api.ldap.model.exception.LdapException,
                   org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

before in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

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

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

after

public void after(org.apache.directory.api.ldap.model.entry.Entry element)
           throws org.apache.directory.api.ldap.model.exception.LdapException,
                  org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

after in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

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

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

beforeFirst

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

Specified by:

beforeFirst in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

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

Specified by:

afterLast in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

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

Specified by:

first in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

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

Specified by:

last in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

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

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

isFirst

public boolean isFirst()

Specified by:

isFirst in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

isFirst in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

isLast

public boolean isLast()

Specified by:

isLast in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

isLast in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

isAfterLast

public boolean isAfterLast()

Specified by:

isAfterLast in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

isAfterLast in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

isBeforeFirst

public boolean isBeforeFirst()

Specified by:

isBeforeFirst in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

isBeforeFirst in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

previous

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

Specified by:

previous in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

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

Specified by:

next in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

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

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

get

public org.apache.directory.api.ldap.model.entry.Entry get()
                                                    throws org.apache.directory.api.ldap.model.cursor.CursorException

Specified by:

get in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Throws:

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

addEntryFilter

public boolean addEntryFilter(EntryFilter filter)

Adds an entry filter to this BaseEntryFilteringCursor at the very end of the filter list. EntryFilters are applied in the order of addition.

Specified by:

addEntryFilter in interface EntryFilteringCursor

Parameters:

filter - a filter to apply to the entries

Returns:

the result of List.add(Object)

getEntryFilters

public java.util.List<EntryFilter> getEntryFilters()

Gets an unmodifiable list of EntryFilters applied.

Specified by:

getEntryFilters in interface EntryFilteringCursor

Returns:

an unmodifiable list of EntryFilters applied

getOperationContext

public SearchOperationContext getOperationContext()

Specified by:

getOperationContext in interface EntryFilteringCursor

Returns:

the operationContext

isAbandoned

public boolean isAbandoned()

setAbandoned

public void setAbandoned(boolean abandoned)

close

public void close()

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

close

public void close(java.lang.Exception reason)

Specified by:

close in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

isClosed in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

iterator

public java.util.Iterator<org.apache.directory.api.ldap.model.entry.Entry> iterator()

Specified by:

iterator in interface java.lang.Iterable<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

iterator in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>

setClosureMonitor

public void setClosureMonitor(org.apache.directory.api.ldap.model.cursor.ClosureMonitor monitor)

Specified by:

setClosureMonitor in interface org.apache.directory.api.ldap.model.cursor.Cursor<org.apache.directory.api.ldap.model.entry.Entry>

Overrides:

setClosureMonitor in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<org.apache.directory.api.ldap.model.entry.Entry>