org.apache.directory.server.xdbm.search.impl
Class AllEntriesCursor<ID extends Comparable<ID>>

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

All Implemented Interfaces:

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

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

A Cursor over all entries in a partition which returns IndexEntries.

Author:

Apache Directory Project

Field Summary

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

UNSUPPORTED_MSG

Constructor Summary

AllEntriesCursor(Store<org.apache.directory.shared.ldap.model.entry.Entry,ID> db)
Creates a new instance of AllEntriesCursor

Method Summary

void	after(IndexEntry<ID,ID> indexEntry)
void	afterLast()
void	afterValue(ID key, ID 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<ID,ID> indexEntry)
void	beforeFirst()
void	beforeValue(ID id, ID 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()
void	close(Exception cause)
boolean	first()
IndexEntry<ID,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, 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

isClosed, setClosureMonitor

Constructor Detail

AllEntriesCursor

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

Creates a new instance of AllEntriesCursor

Parameters:

db -

Throws:

Exception

Method Detail

getUnsupportedMessage

protected String getUnsupportedMessage()

Gets the message to return for operations that are not supported

Specified by:

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

Returns:

The Unsupported message

afterValue

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

Overrides:

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

Parameters:

key - the id for the entry

value - the value to advance just after the last value

Throws:

Exception - if there are faults performing this operation

beforeValue

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

Overrides:

beforeValue in class AbstractIndexCursor<ID extends Comparable<ID>,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

after

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

Specified by:

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

Overrides:

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

Throws:

Exception

afterLast

public void afterLast()
               throws Exception

Throws:

Exception

available

public boolean available()

Specified by:

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

Overrides:

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

before

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

Specified by:

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

Overrides:

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

Throws:

Exception

beforeFirst

public void beforeFirst()
                 throws Exception

Throws:

Exception

first

public boolean first()
              throws Exception

Throws:

Exception

get

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

Throws:

Exception

last

public boolean last()
             throws Exception

Throws:

Exception

next

public boolean next()
             throws Exception

Throws:

Exception

previous

public boolean previous()
                 throws Exception

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

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

Overrides:

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

Throws:

Exception

close

public void close(Exception cause)
           throws Exception

Specified by:

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

Overrides:

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

Throws:

Exception