com.sleepycat.util.keyrange

Class RangeCursor

java.lang.Object

com.sleepycat.util.keyrange.RangeCursor

All Implemented Interfaces:

Cloneable

public 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 fully general implementation of a range cursor and should not be used directly by applications; however, it may evolve into a generally useful range cursor some day.

Author:

Mark Hayes

Constructor Summary

Constructors

Constructor and Description
RangeCursor(KeyRange range, KeyRange pkRange, boolean sortedDups, Cursor cursor) Creates a range cursor with a duplicate range.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkRecordNumber() If the database is a RECNO or QUEUE database, we know its keys are record numbers.
void	close()
protected void	closeCursor(Cursor cursor) Closes the given cursor.
int	count()
OperationStatus	delete()
RangeCursor	dup(boolean samePosition) Create a cloned range cursor.
protected Cursor	dupCursor(Cursor cursor, boolean samePosition) Dups the given cursor.
DbCompat.OpResult	getCurrent(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options)
Cursor	getCursor() Returns the underlying cursor.
DbCompat.OpResult	getFirst(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options)
DbCompat.OpResult	getLast(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options) This method will restart the operation when a key range is used and an insertion at the end of the key range is performed in another thread.
DbCompat.OpResult	getNext(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options)
DbCompat.OpResult	getNextDup(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options)
DbCompat.OpResult	getNextNoDup(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options)
DbCompat.OpResult	getPrev(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options)
DbCompat.OpResult	getPrevDup(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options)
DbCompat.OpResult	getPrevNoDup(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options)
DbCompat.OpResult	getSearchBoth(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options)
DbCompat.OpResult	getSearchBothRange(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options)
DbCompat.OpResult	getSearchKey(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options)
DbCompat.OpResult	getSearchKeyRange(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options)
DbCompat.OpResult	getSearchRecordNumber(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, DbCompat.OpReadOptions options)
boolean	isInitialized() Returns whether the cursor is initialized at a valid position.
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

public RangeCursor(KeyRange range,
                   KeyRange pkRange,
                   boolean sortedDups,
                   Cursor cursor)

Creates a range cursor with a duplicate range.

Method Detail

dup

public 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

isInitialized

public boolean isInitialized()

Returns whether the cursor is initialized at a valid position.

getCursor

public Cursor getCursor()

Returns the underlying cursor. Used for cloning.

getFirst

public DbCompat.OpResult getFirst(DatabaseEntry key,
                                  DatabaseEntry pKey,
                                  DatabaseEntry data,
                                  DbCompat.OpReadOptions options)
                           throws DatabaseException

Throws:

DatabaseException

getLast

public DbCompat.OpResult getLast(DatabaseEntry key,
                                 DatabaseEntry pKey,
                                 DatabaseEntry data,
                                 DbCompat.OpReadOptions options)
                          throws DatabaseException

This method will restart the operation when a key range is used and an insertion at the end of the key range is performed in another thread. The restarts are needed because a sequence of cursor movements is performed, and serializable isolation cannot be relied on to prevent insertions in other threads. Without the restarts, getLast could return NOTFOUND when keys in the range exist. This may only be an issue for JE since it uses record locking, while DB core uses page locking.

Throws:

DatabaseException

getNext

public DbCompat.OpResult getNext(DatabaseEntry key,
                                 DatabaseEntry pKey,
                                 DatabaseEntry data,
                                 DbCompat.OpReadOptions options)
                          throws DatabaseException

Throws:

DatabaseException

getNextNoDup

public DbCompat.OpResult getNextNoDup(DatabaseEntry key,
                                      DatabaseEntry pKey,
                                      DatabaseEntry data,
                                      DbCompat.OpReadOptions options)
                               throws DatabaseException

Throws:

DatabaseException

getPrev

public DbCompat.OpResult getPrev(DatabaseEntry key,
                                 DatabaseEntry pKey,
                                 DatabaseEntry data,
                                 DbCompat.OpReadOptions options)
                          throws DatabaseException

Throws:

DatabaseException

getPrevNoDup

public DbCompat.OpResult getPrevNoDup(DatabaseEntry key,
                                      DatabaseEntry pKey,
                                      DatabaseEntry data,
                                      DbCompat.OpReadOptions options)
                               throws DatabaseException

Throws:

DatabaseException

getSearchKey

public DbCompat.OpResult getSearchKey(DatabaseEntry key,
                                      DatabaseEntry pKey,
                                      DatabaseEntry data,
                                      DbCompat.OpReadOptions options)
                               throws DatabaseException

Throws:

DatabaseException

getSearchBoth

public DbCompat.OpResult getSearchBoth(DatabaseEntry key,
                                       DatabaseEntry pKey,
                                       DatabaseEntry data,
                                       DbCompat.OpReadOptions options)
                                throws DatabaseException

Throws:

DatabaseException

getSearchKeyRange

public DbCompat.OpResult getSearchKeyRange(DatabaseEntry key,
                                           DatabaseEntry pKey,
                                           DatabaseEntry data,
                                           DbCompat.OpReadOptions options)
                                    throws DatabaseException

Throws:

DatabaseException

getSearchBothRange

public DbCompat.OpResult getSearchBothRange(DatabaseEntry key,
                                            DatabaseEntry pKey,
                                            DatabaseEntry data,
                                            DbCompat.OpReadOptions options)
                                     throws DatabaseException

Throws:

DatabaseException

getSearchRecordNumber

public DbCompat.OpResult getSearchRecordNumber(DatabaseEntry key,
                                               DatabaseEntry pKey,
                                               DatabaseEntry data,
                                               DbCompat.OpReadOptions options)
                                        throws DatabaseException

Throws:

DatabaseException

getNextDup

public DbCompat.OpResult getNextDup(DatabaseEntry key,
                                    DatabaseEntry pKey,
                                    DatabaseEntry data,
                                    DbCompat.OpReadOptions options)
                             throws DatabaseException

Throws:

DatabaseException

getPrevDup

public DbCompat.OpResult getPrevDup(DatabaseEntry key,
                                    DatabaseEntry pKey,
                                    DatabaseEntry data,
                                    DbCompat.OpReadOptions options)
                             throws DatabaseException

Throws:

DatabaseException

getCurrent

public DbCompat.OpResult getCurrent(DatabaseEntry key,
                                    DatabaseEntry pKey,
                                    DatabaseEntry data,
                                    DbCompat.OpReadOptions options)
                             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

dupCursor

protected Cursor dupCursor(Cursor cursor,
                           boolean samePosition)
                    throws DatabaseException

Dups the given cursor.

Throws:

DatabaseException

closeCursor

protected void closeCursor(Cursor cursor)
                    throws DatabaseException

Closes the given cursor.

Throws:

DatabaseException

checkRecordNumber

protected boolean checkRecordNumber()

If the database is a RECNO or QUEUE database, we know its keys are record numbers. We treat a non-positive record number as out of bounds, that is, we return NOTFOUND rather than throwing IllegalArgumentException as would happen if we passed a non-positive record number into the DB cursor. This behavior is required by the collections interface.