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

Class EqualityCursor<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.EqualityCursor<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 EqualityCursor<V>
extends AbstractIndexCursor<V>

A Cursor over entry candidates matching an equality assertion filter. This Cursor operates in two modes. The first is when an index exists for the attribute the equality assertion is built on. The second is when the user index for the assertion attribute does not exist. Different Cursors are used in each of these cases where the other remains null.

Field Summary

Fields

Modifier and Type	Field and Description
private EqualityEvaluator<V>	equalityEvaluator An equality evaluator for candidates
private static boolean	IS_DEBUG Speedup for logs
private static org.slf4j.Logger	LOG_CURSOR A dedicated log for cursors
private static java.lang.String	UNSUPPORTED_MSG The message for unsupported operations
private org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,java.lang.String>>	userIdxCursor Cursor over attribute entry matching filter: set when index present
private org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<java.lang.String,java.lang.String>>	uuidIdxCursor NDN Cursor on all entries in (set when no index on user attribute)

Constructor Summary

Constructors

Constructor and Description
EqualityCursor(Store store, EqualityEvaluator<V> equalityEvaluator) Creates a new instance of an EqualityCursor

Method Summary

Modifier and Type	Method and Description
void	after(IndexEntry<V,java.lang.String> element)
void	afterLast()
boolean	available()
void	before(IndexEntry<V,java.lang.String> element)
void	beforeFirst()
void	close()
void	close(java.lang.Exception cause)
boolean	first()
IndexEntry<V,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

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

The message for unsupported operations

equalityEvaluator

private final EqualityEvaluator<V> equalityEvaluator

An equality evaluator for candidates

userIdxCursor

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

Cursor over attribute entry matching filter: set when index present

uuidIdxCursor

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

NDN Cursor on all entries in (set when no index on user attribute)

Constructor Detail

EqualityCursor

public EqualityCursor(Store store,
                      EqualityEvaluator<V> equalityEvaluator)
               throws java.lang.Exception

Creates a new instance of an EqualityCursor

Parameters:

store - The store

equalityEvaluator - The EqualityEvaluator

Throws:

java.lang.Exception - If the creation failed

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

available

public boolean available()

Specified by:

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

Overrides:

available in class AbstractIndexCursor<V>

before

public void before(IndexEntry<V,java.lang.String> 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<IndexEntry<V,java.lang.String>>

Overrides:

before in class AbstractIndexCursor<V>

Throws:

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

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

after

public void after(IndexEntry<V,java.lang.String> 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<IndexEntry<V,java.lang.String>>

Overrides:

after in class AbstractIndexCursor<V>

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

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

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