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

Class ApproximateCursor<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.ApproximateCursor<V>

All Implemented Interfaces:

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

public class ApproximateCursor<V>
extends AbstractIndexCursor<V>

A Cursor over entry candidates matching an approximate assertion filter. This Cursor really is a copy of EqualityCursor for now but later on approximate matching can be implemented and this can change. It operates in two modes. The first is when an index exists for the attribute the approximate 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

Constructor Summary

Constructors

Constructor and Description
ApproximateCursor(Store store, ApproximateEvaluator<V> approximateEvaluator) Creates a new instance of ApproximateCursor

Method Summary

Methods

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

Constructor Detail

ApproximateCursor

public ApproximateCursor(Store store,
                 ApproximateEvaluator<V> approximateEvaluator)
                  throws Exception

Creates a new instance of ApproximateCursor

Parameters:

store - The Store we want to build a cursor on

approximateEvaluator - The evaluator

Throws:

Exception - If the creation failed

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

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

IOException

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

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

IOException

beforeFirst

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

Throws:

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

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

IOException

afterLast

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

Throws:

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

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

IOException

first

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

Throws:

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

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

IOException

last

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

Throws:

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

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

IOException

previous

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

Throws:

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

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

IOException

next

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

Throws:

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

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

IOException

get

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

Throws:

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

IOException

close

public void close()

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

close

public void close(Exception cause)

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

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