org.apache.directory.server.xdbm.search.impl
Class GreaterEqCursor<V,ID>

java.lang.Object
  extended by org.apache.directory.server.xdbm.AbstractIndexCursor<V,org.apache.directory.shared.ldap.entry.ServerEntry,ID>
      extended by org.apache.directory.server.xdbm.search.impl.GreaterEqCursor<V,ID>
All Implemented Interfaces:
java.lang.Iterable<IndexEntry<V,org.apache.directory.shared.ldap.entry.ServerEntry,ID>>, IndexCursor<V,org.apache.directory.shared.ldap.entry.ServerEntry,ID>, org.apache.directory.shared.ldap.cursor.Cursor<IndexEntry<V,org.apache.directory.shared.ldap.entry.ServerEntry,ID>>

public class GreaterEqCursor<V,ID>
extends AbstractIndexCursor<V,org.apache.directory.shared.ldap.entry.ServerEntry,ID>

A Cursor over entry candidates matching a GreaterEq assertion filter. This Cursor operates in two modes. The first is when an index exists for the attribute the 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.

Version:
$Rev$
Author:
Apache Directory Project

Constructor Summary
GreaterEqCursor(Store<org.apache.directory.shared.ldap.entry.ServerEntry,ID> db, GreaterEqEvaluator greaterEqEvaluator)
           
 
Method Summary
 void after(IndexEntry<V,org.apache.directory.shared.ldap.entry.ServerEntry,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,org.apache.directory.shared.ldap.entry.ServerEntry,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,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

GreaterEqCursor

public GreaterEqCursor(Store<org.apache.directory.shared.ldap.entry.ServerEntry,ID> db,
                       GreaterEqEvaluator greaterEqEvaluator)
                throws java.lang.Exception
Throws:
java.lang.Exception
Method Detail

available

public boolean available()

beforeValue

public void beforeValue(ID id,
                        V value)
                 throws java.lang.Exception
Description copied from interface: IndexCursor
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.

Parameters:
id - the id for the entry
value - the value to advance just before
Throws:
java.lang.Exception - if there are faults performing this operation

afterValue

public void afterValue(ID id,
                       V value)
                throws java.lang.Exception
Description copied from interface: IndexCursor
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.

Parameters:
id - the id for the entry
value - the value to advance just after the last value
Throws:
java.lang.Exception - if there are faults performing this operation

before

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

after

public void after(IndexEntry<V,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<V,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<V,org.apache.directory.shared.ldap.entry.ServerEntry,ID>>
Overrides:
close in class AbstractIndexCursor<V,org.apache.directory.shared.ldap.entry.ServerEntry,ID>
Throws:
java.lang.Exception


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.