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

Class EqualityCursor<V>

java.lang.Object

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

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

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

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<IndexEntry<V,String>>, org.apache.directory.api.ldap.model.cursor.Cursor<IndexEntry<V,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.

Author:

Apache Directory Project

Field Summary

Fields inherited from class org.apache.directory.server.xdbm.AbstractIndexCursor

partitionTxn

Constructor Summary

Constructors

Constructor and Description
EqualityCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn, Store store, EqualityEvaluator<V> equalityEvaluator) Creates a new instance of an EqualityCursor

Method Summary

Modifier and Type	Method and Description
void	after(IndexEntry<V,String> element)
void	afterLast()
boolean	available()
void	before(IndexEntry<V,String> element)
void	beforeFirst()
void	close()
void	close(Exception cause)
boolean	first()
IndexEntry<V,String>	get()
protected String	getUnsupportedMessage() Gets the message to return for operations that are not supported
boolean	last()
boolean	next()
boolean	previous()
String	toString()
String	toString(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

Constructor Detail

EqualityCursor

public EqualityCursor(org.apache.directory.server.core.api.partition.PartitionTxn partitionTxn,
                      Store store,
                      EqualityEvaluator<V> equalityEvaluator)
               throws org.apache.directory.api.ldap.model.exception.LdapException,
                      IndexNotFoundException

Creates a new instance of an EqualityCursor

Parameters:

partitionTxn - The transaction to use

store - The store

equalityEvaluator - The EqualityEvaluator

Throws:

org.apache.directory.api.ldap.model.exception.LdapException - If the creation failed

IndexNotFoundException - If the index was not found

Method Detail

getUnsupportedMessage

protected 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,String>>

Overrides:

available in class AbstractIndexCursor<V>

before

public void before(IndexEntry<V,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,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,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,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

Specified by:

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

Overrides:

previous in class AbstractIndexCursor<V>

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<IndexEntry<V,String>>

Overrides:

next in class AbstractIndexCursor<V>

Throws:

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

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

get

public IndexEntry<V,String> get()
                         throws org.apache.directory.api.ldap.model.cursor.CursorException

Throws:

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

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

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

Throws:

IOException

close

public void close(Exception cause)
           throws IOException

Specified by:

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

Overrides:

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

Throws:

IOException

toString

public String toString(String tabs)

Specified by:

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

Overrides:

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

See Also:

Object.toString()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()