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

Class OrCursor<V>

java.lang.Object

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

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

org.apache.directory.server.xdbm.search.cursor.OrCursor<V>

All Implemented Interfaces:

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

public class OrCursor<V>
extends AbstractIndexCursor<V>

A Cursor returning candidates satisfying a logical disjunction expression.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.util.Set<java.lang.String>>	blacklists
private int	cursorIndex
private java.util.List<org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,java.lang.String>>>	cursors
private java.util.List<Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode>>	evaluators
private static boolean	IS_DEBUG Speedup for logs
private static org.slf4j.Logger	LOG_CURSOR A dedicated log for cursors
private IndexEntry<V,java.lang.String>	prefetched The candidate we have fetched in the next/previous call
private static java.lang.String	UNSUPPORTED_MSG

Constructor Summary

Constructors

Constructor and Description
OrCursor(java.util.List<org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,java.lang.String>>> cursors, java.util.List<Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode>> evaluators)

Method Summary

Modifier and Type	Method and Description
void	afterLast()
void	beforeFirst()
private void	blackListIfDuplicate(IndexEntry<?,java.lang.String> indexEntry) The first sub-expression Cursor to advance to an entry adds the entry to the blacklists of other Cursors that might return that entry.
void	close()
void	close(java.lang.Exception cause)
private java.lang.String	dumpCursors(java.lang.String tabs) Dumps the cursors
private java.lang.String	dumpEvaluators(java.lang.String tabs) Dumps the evaluators
boolean	first()
IndexEntry<V,java.lang.String>	get()
protected java.lang.String	getUnsupportedMessage() Gets the message to return for operations that are not supported
private boolean	isBlackListed(java.lang.String id)
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

cursors

private final java.util.List<org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,java.lang.String>>> cursors

evaluators

private final java.util.List<Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode>> evaluators

blacklists

private final java.util.List<java.util.Set<java.lang.String>> blacklists

cursorIndex

private int cursorIndex

prefetched

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

The candidate we have fetched in the next/previous call

Constructor Detail

OrCursor

public OrCursor(java.util.List<org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,java.lang.String>>> cursors,
                java.util.List<Evaluator<? extends org.apache.directory.api.ldap.model.filter.ExprNode>> evaluators)

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

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

isBlackListed

private boolean isBlackListed(java.lang.String id)

blackListIfDuplicate

private void blackListIfDuplicate(IndexEntry<?,java.lang.String> indexEntry)
                           throws org.apache.directory.api.ldap.model.exception.LdapException

The first sub-expression Cursor to advance to an entry adds the entry to the blacklists of other Cursors that might return that entry.

Parameters:

indexEntry - the index entry to blacklist

Throws:

java.lang.Exception - if there are problems accessing underlying db

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

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<V,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<V,java.lang.String>>

Overrides:

close in class org.apache.directory.api.ldap.model.cursor.AbstractCursor<IndexEntry<V,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<V,java.lang.String>>

Overrides:

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

dumpEvaluators

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

Dumps the evaluators

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<V,java.lang.String>>

Overrides:

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

See Also:

Object.toString()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()