com.sleepycat.collections
Class RangeCursor

java.lang.Object
  extended by com.sleepycat.collections.RangeCursor
All Implemented Interfaces:
Cloneable

 class RangeCursor
extends Object
implements Cloneable

A cursor-like interface that enforces a key range. The method signatures are actually those of SecondaryCursor, but the pKey parameter may be null. It was done this way to avoid doubling the number of methods.

This is not a general implementation of a range cursor and should not be used outside this package; however, it may evolve into a generally useful range cursor some day.

Author:
Mark Hayes

Constructor Summary
RangeCursor(DataView view, KeyRange range, boolean writeAllowed)
          Create a range cursor.
 
Method Summary
 void close()
           
 int count()
           
 OperationStatus delete()
           
(package private)  RangeCursor dup(boolean samePosition)
          Create a cloned range cursor.
 OperationStatus getCurrent(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
(package private)  Cursor getCursor()
          Returns the underlying cursor.
 OperationStatus getFirst(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
 OperationStatus getLast(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
 OperationStatus getNext(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
 OperationStatus getNextDup(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
 OperationStatus getNextNoDup(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
 OperationStatus getPrev(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
 OperationStatus getPrevDup(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
 OperationStatus getPrevNoDup(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
 OperationStatus getSearchBoth(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
 OperationStatus getSearchBothRange(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
 OperationStatus getSearchKey(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
 OperationStatus getSearchKeyRange(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
 OperationStatus getSearchRecordNumber(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
           
 OperationStatus put(DatabaseEntry key, DatabaseEntry data)
           
 OperationStatus putAfter(DatabaseEntry key, DatabaseEntry data)
           
 OperationStatus putBefore(DatabaseEntry key, DatabaseEntry data)
           
 OperationStatus putCurrent(DatabaseEntry data)
           
 OperationStatus putNoDupData(DatabaseEntry key, DatabaseEntry data)
           
 OperationStatus putNoOverwrite(DatabaseEntry key, DatabaseEntry data)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RangeCursor

RangeCursor(DataView view,
            KeyRange range,
            boolean writeAllowed)
      throws DatabaseException
Create a range cursor.

Throws:
DatabaseException
Method Detail

dup

RangeCursor dup(boolean samePosition)
          throws DatabaseException
Create a cloned range cursor. The caller must clone the underlying cursor before using this constructor, because cursor open/close is handled specially for CDS cursors outside this class.

Throws:
DatabaseException

getCursor

Cursor getCursor()
Returns the underlying cursor. Used for cloning.


getFirst

public OperationStatus getFirst(DatabaseEntry key,
                                DatabaseEntry pKey,
                                DatabaseEntry data,
                                LockMode lockMode)
                         throws DatabaseException
Throws:
DatabaseException

getLast

public OperationStatus getLast(DatabaseEntry key,
                               DatabaseEntry pKey,
                               DatabaseEntry data,
                               LockMode lockMode)
                        throws DatabaseException
Throws:
DatabaseException

getNext

public OperationStatus getNext(DatabaseEntry key,
                               DatabaseEntry pKey,
                               DatabaseEntry data,
                               LockMode lockMode)
                        throws DatabaseException
Throws:
DatabaseException

getNextNoDup

public OperationStatus getNextNoDup(DatabaseEntry key,
                                    DatabaseEntry pKey,
                                    DatabaseEntry data,
                                    LockMode lockMode)
                             throws DatabaseException
Throws:
DatabaseException

getPrev

public OperationStatus getPrev(DatabaseEntry key,
                               DatabaseEntry pKey,
                               DatabaseEntry data,
                               LockMode lockMode)
                        throws DatabaseException
Throws:
DatabaseException

getPrevNoDup

public OperationStatus getPrevNoDup(DatabaseEntry key,
                                    DatabaseEntry pKey,
                                    DatabaseEntry data,
                                    LockMode lockMode)
                             throws DatabaseException
Throws:
DatabaseException

getSearchKey

public OperationStatus getSearchKey(DatabaseEntry key,
                                    DatabaseEntry pKey,
                                    DatabaseEntry data,
                                    LockMode lockMode)
                             throws DatabaseException
Throws:
DatabaseException

getSearchBoth

public OperationStatus getSearchBoth(DatabaseEntry key,
                                     DatabaseEntry pKey,
                                     DatabaseEntry data,
                                     LockMode lockMode)
                              throws DatabaseException
Throws:
DatabaseException

getSearchKeyRange

public OperationStatus getSearchKeyRange(DatabaseEntry key,
                                         DatabaseEntry pKey,
                                         DatabaseEntry data,
                                         LockMode lockMode)
                                  throws DatabaseException
Throws:
DatabaseException

getSearchBothRange

public OperationStatus getSearchBothRange(DatabaseEntry key,
                                          DatabaseEntry pKey,
                                          DatabaseEntry data,
                                          LockMode lockMode)
                                   throws DatabaseException
Throws:
DatabaseException

getSearchRecordNumber

public OperationStatus getSearchRecordNumber(DatabaseEntry key,
                                             DatabaseEntry pKey,
                                             DatabaseEntry data,
                                             LockMode lockMode)
                                      throws DatabaseException
Throws:
DatabaseException

getNextDup

public OperationStatus getNextDup(DatabaseEntry key,
                                  DatabaseEntry pKey,
                                  DatabaseEntry data,
                                  LockMode lockMode)
                           throws DatabaseException
Throws:
DatabaseException

getPrevDup

public OperationStatus getPrevDup(DatabaseEntry key,
                                  DatabaseEntry pKey,
                                  DatabaseEntry data,
                                  LockMode lockMode)
                           throws DatabaseException
Throws:
DatabaseException

getCurrent

public OperationStatus getCurrent(DatabaseEntry key,
                                  DatabaseEntry pKey,
                                  DatabaseEntry data,
                                  LockMode lockMode)
                           throws DatabaseException
Throws:
DatabaseException

close

public void close()
           throws DatabaseException
Throws:
DatabaseException

count

public int count()
          throws DatabaseException
Throws:
DatabaseException

delete

public OperationStatus delete()
                       throws DatabaseException
Throws:
DatabaseException

put

public OperationStatus put(DatabaseEntry key,
                           DatabaseEntry data)
                    throws DatabaseException
Throws:
DatabaseException

putNoOverwrite

public OperationStatus putNoOverwrite(DatabaseEntry key,
                                      DatabaseEntry data)
                               throws DatabaseException
Throws:
DatabaseException

putNoDupData

public OperationStatus putNoDupData(DatabaseEntry key,
                                    DatabaseEntry data)
                             throws DatabaseException
Throws:
DatabaseException

putCurrent

public OperationStatus putCurrent(DatabaseEntry data)
                           throws DatabaseException
Throws:
DatabaseException

putAfter

public OperationStatus putAfter(DatabaseEntry key,
                                DatabaseEntry data)
                         throws DatabaseException
Throws:
DatabaseException

putBefore

public OperationStatus putBefore(DatabaseEntry key,
                                 DatabaseEntry data)
                          throws DatabaseException
Throws:
DatabaseException


Copyright 2004-2005 Sleepycat, Inc. All Rights Reserved.