org.apache.directory.server.xdbm.search.impl
Class SubstringCursor<ID>

java.lang.Object
  org.apache.directory.server.xdbm.AbstractIndexCursor<java.lang.String,org.apache.directory.shared.ldap.entry.ServerEntry,ID>
      org.apache.directory.server.xdbm.search.impl.SubstringCursor<ID>

All Implemented Interfaces:

java.lang.Iterable<IndexEntry<java.lang.String,org.apache.directory.shared.ldap.entry.ServerEntry,ID>>, IndexCursor<java.lang.String,org.apache.directory.shared.ldap.entry.ServerEntry,ID>, org.apache.directory.shared.ldap.cursor.Cursor<IndexEntry<java.lang.String,org.apache.directory.shared.ldap.entry.ServerEntry,ID>>

public class SubstringCursor<ID>
extends AbstractIndexCursor<java.lang.String,org.apache.directory.shared.ldap.entry.ServerEntry,ID>

A Cursor traversing candidates matching a Substring assertion expression.

Version:

$Rev$

Author:

Apache Directory Project

Constructor Summary

SubstringCursor(Store<org.apache.directory.shared.ldap.entry.ServerEntry,ID> db, SubstringEvaluator<ID> substringEvaluator)

Method Summary

void	after(IndexEntry<java.lang.String,org.apache.directory.shared.ldap.entry.ServerEntry,ID> element)
void	afterLast()
void	afterValue(ID id, java.lang.String value)
boolean	available()
void	before(IndexEntry<java.lang.String,org.apache.directory.shared.ldap.entry.ServerEntry,ID> element)
void	beforeFirst()
void	beforeValue(ID id, java.lang.String value)
void	close()
boolean	first()
IndexEntry<java.lang.String,org.apache.directory.shared.ldap.entry.ServerEntry,ID>	get()
boolean	isElementReused()
boolean	last()
boolean	next()
boolean	previous()

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

checkNotClosed, close, isClosed, iterator, setClosureMonitor

Methods inherited from class java.lang.Object

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

Constructor Detail

SubstringCursor

public SubstringCursor(Store<org.apache.directory.shared.ldap.entry.ServerEntry,ID> db,
                       SubstringEvaluator<ID> substringEvaluator)
                throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

available

public boolean available()

beforeValue

public void beforeValue(ID id,
                        java.lang.String value)
                 throws java.lang.Exception

Throws:

java.lang.Exception

afterValue

public void afterValue(ID id,
                       java.lang.String value)
                throws java.lang.Exception

Throws:

java.lang.Exception

before

public void before(IndexEntry<java.lang.String,org.apache.directory.shared.ldap.entry.ServerEntry,ID> element)
            throws java.lang.Exception

Throws:

java.lang.Exception

after

public void after(IndexEntry<java.lang.String,org.apache.directory.shared.ldap.entry.ServerEntry,ID> element)
           throws java.lang.Exception

Throws:

java.lang.Exception

beforeFirst

public void beforeFirst()
                 throws java.lang.Exception

Throws:

java.lang.Exception

afterLast

public void afterLast()
               throws java.lang.Exception

Throws:

java.lang.Exception

first

public boolean first()
              throws java.lang.Exception

Throws:

java.lang.Exception

last

public boolean last()
             throws java.lang.Exception

Throws:

java.lang.Exception

previous

public boolean previous()
                 throws java.lang.Exception

Throws:

java.lang.Exception

next

public boolean next()
             throws java.lang.Exception

Throws:

java.lang.Exception

get

public IndexEntry<java.lang.String,org.apache.directory.shared.ldap.entry.ServerEntry,ID> get()
                                                                                       throws java.lang.Exception

Throws:

java.lang.Exception

isElementReused

public boolean isElementReused()

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface org.apache.directory.shared.ldap.cursor.Cursor<IndexEntry<java.lang.String,org.apache.directory.shared.ldap.entry.ServerEntry,ID>>

Overrides:

close in class AbstractIndexCursor<java.lang.String,org.apache.directory.shared.ldap.entry.ServerEntry,ID>

Throws:

java.lang.Exception