org.apache.directory.server.xdbm.search.impl
Class EqualityCursor<V,ID extends Comparable<ID>>

java.lang.Object
  org.apache.directory.shared.ldap.model.cursor.AbstractCursor<IndexEntry<V,ID>>
      org.apache.directory.server.xdbm.AbstractIndexCursor<V,org.apache.directory.shared.ldap.model.entry.Entry,ID>
          org.apache.directory.server.xdbm.search.impl.EqualityCursor<V,ID>

All Implemented Interfaces:

Iterable<IndexEntry<V,ID>>, IndexCursor<V,org.apache.directory.shared.ldap.model.entry.Entry,ID>, org.apache.directory.shared.ldap.model.cursor.Cursor<IndexEntry<V,ID>>

public class EqualityCursor<V,ID extends Comparable<ID>>
extends AbstractIndexCursor<V,org.apache.directory.shared.ldap.model.entry.Entry,ID>

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

Constructor Summary

EqualityCursor(Store<org.apache.directory.shared.ldap.model.entry.Entry,ID> db, EqualityEvaluator<V,ID> equalityEvaluator)
Creates a new instance of an EqualityCursor

Method Summary

void	after(IndexEntry<V,ID> element)
void	afterLast()
void	afterValue(ID id, V value) An alternative to calling after(IndexEntry) which often may require wrapping an id and value in a newly created IndexEntry object that may be an unnecessary object creation.
boolean	available()
void	before(IndexEntry<V,ID> element)
void	beforeFirst()
void	beforeValue(ID id, V value) An alternative to calling before(IndexEntry) which often may require wrapping an id and value in a newly created IndexEntry object that may be an unnecessary object creation.
void	close()
boolean	first()
IndexEntry<V,ID>	get()
protected String	getUnsupportedMessage() Gets the message to return for operations that are not supported
boolean	last()
boolean	next()
boolean	previous()

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

isAfterLast, isBeforeFirst, isFirst, isLast, iterator, setAvailable

Methods inherited from class org.apache.directory.shared.ldap.model.cursor.AbstractCursor

checkNotClosed, close, isClosed, setClosureMonitor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.directory.shared.ldap.model.cursor.Cursor

close, isClosed, setClosureMonitor

Constructor Detail

EqualityCursor

public EqualityCursor(Store<org.apache.directory.shared.ldap.model.entry.Entry,ID> db,
                      EqualityEvaluator<V,ID> equalityEvaluator)
               throws Exception

Creates a new instance of an EqualityCursor

Parameters:

db - The store

equalityEvaluator - The EqualityEvaluator

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,org.apache.directory.shared.ldap.model.entry.Entry,ID extends Comparable<ID>>

Returns:

The Unsupported message

available

public boolean available()

Specified by:

available in interface org.apache.directory.shared.ldap.model.cursor.Cursor<IndexEntry<V,ID extends Comparable<ID>>>

Overrides:

available in class AbstractIndexCursor<V,org.apache.directory.shared.ldap.model.entry.Entry,ID extends Comparable<ID>>

beforeValue

public void beforeValue(ID id,
                        V value)
                 throws Exception

An alternative to calling before(IndexEntry) which often may require wrapping an id and value in a newly created IndexEntry object that may be an unnecessary object creation. Some implementations may not support this operation and may throw an UnsupportedOperationEception.

Specified by:

beforeValue in interface IndexCursor<V,org.apache.directory.shared.ldap.model.entry.Entry,ID extends Comparable<ID>>

Overrides:

beforeValue in class AbstractIndexCursor<V,org.apache.directory.shared.ldap.model.entry.Entry,ID extends Comparable<ID>>

Parameters:

id - the id for the entry

value - the value to advance just before

Throws:

Exception - if there are faults performing this operation

before

public void before(IndexEntry<V,ID> element)
            throws Exception

Specified by:

before in interface org.apache.directory.shared.ldap.model.cursor.Cursor<IndexEntry<V,ID extends Comparable<ID>>>

Overrides:

before in class AbstractIndexCursor<V,org.apache.directory.shared.ldap.model.entry.Entry,ID extends Comparable<ID>>

Throws:

Exception

afterValue

public void afterValue(ID id,
                       V value)
                throws Exception

An alternative to calling after(IndexEntry) which often may require wrapping an id and value in a newly created IndexEntry object that may be an unnecessary object creation. Some implementations may not support this operation and may throw an UnsupportedOperationEception.

Specified by:

afterValue in interface IndexCursor<V,org.apache.directory.shared.ldap.model.entry.Entry,ID extends Comparable<ID>>

Overrides:

afterValue in class AbstractIndexCursor<V,org.apache.directory.shared.ldap.model.entry.Entry,ID extends Comparable<ID>>

Parameters:

id - the id for the entry

value - the value to advance just after the last value

Throws:

Exception - if there are faults performing this operation

after

public void after(IndexEntry<V,ID> element)
           throws Exception

Specified by:

after in interface org.apache.directory.shared.ldap.model.cursor.Cursor<IndexEntry<V,ID extends Comparable<ID>>>

Overrides:

after in class AbstractIndexCursor<V,org.apache.directory.shared.ldap.model.entry.Entry,ID extends Comparable<ID>>

Throws:

Exception

beforeFirst

public void beforeFirst()
                 throws Exception

Throws:

Exception

afterLast

public void afterLast()
               throws Exception

Throws:

Exception

first

public boolean first()
              throws Exception

Throws:

Exception

last

public boolean last()
             throws Exception

Throws:

Exception

previous

public boolean previous()
                 throws Exception

Throws:

Exception

next

public boolean next()
             throws Exception

Throws:

Exception

get

public IndexEntry<V,ID> get()
                                            throws Exception

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface org.apache.directory.shared.ldap.model.cursor.Cursor<IndexEntry<V,ID extends Comparable<ID>>>

Overrides:

close in class org.apache.directory.shared.ldap.model.cursor.AbstractCursor<IndexEntry<V,ID extends Comparable<ID>>>

Throws:

Exception