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

Class SubstringCursor

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

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

A Cursor traversing candidates matching a Substring assertion expression.

Field Summary

Fields

Modifier and Type	Field and Description
private SubstringEvaluator	evaluator
private boolean	hasIndex
private IndexEntry<java.lang.String,java.lang.String>	indexEntry
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
private org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<java.lang.String,java.lang.String>>	wrapped

Constructor Summary

Constructors

Constructor and Description
SubstringCursor(Store store, SubstringEvaluator substringEvaluator)

Method Summary

Modifier and Type	Method and Description
void	afterLast()
void	beforeFirst()
private void	clear()
void	close()
void	close(java.lang.Exception cause)
private boolean	evaluateCandidate(IndexEntry<java.lang.String,java.lang.String> indexEntry)
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

hasIndex

private final boolean hasIndex

wrapped

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

evaluator

private final SubstringEvaluator evaluator

indexEntry

private final IndexEntry<java.lang.String,java.lang.String> indexEntry

Constructor Detail

SubstringCursor

public SubstringCursor(Store store,
                       SubstringEvaluator substringEvaluator)
                throws java.lang.Exception

Throws:

java.lang.Exception

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

clear

private void clear()

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

evaluateCandidate

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

Throws:

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

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