com.sleepycat.je
Class SecondaryCursor

java.lang.Object
  extended by com.sleepycat.je.Cursor
      extended by com.sleepycat.je.SecondaryCursor

public class SecondaryCursor
extends Cursor

Javadoc for this public class is generated via the doc templates in the doc_src directory.


Field Summary
 
Fields inherited from class com.sleepycat.je.Cursor
config, cursorImpl
 
Constructor Summary
SecondaryCursor(SecondaryDatabase dbHandle, Transaction txn, CursorConfig cursorConfig)
          Cursor constructor.
 
Method Summary
 OperationStatus delete()
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 Cursor dup(boolean samePosition)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 SecondaryCursor dupSecondary(boolean samePosition)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getCurrent(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getCurrent(DatabaseEntry key, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getFirst(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getFirst(DatabaseEntry key, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getLast(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getLast(DatabaseEntry key, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getNext(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getNext(DatabaseEntry key, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getNextDup(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getNextDup(DatabaseEntry key, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getNextNoDup(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getNextNoDup(DatabaseEntry key, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getPrev(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getPrev(DatabaseEntry key, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getPrevDup(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getPrevDup(DatabaseEntry key, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getPrevNoDup(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getPrevNoDup(DatabaseEntry key, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 Database getPrimaryDatabase()
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getSearchBoth(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getSearchBoth(DatabaseEntry key, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getSearchBothRange(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getSearchBothRange(DatabaseEntry key, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getSearchKey(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getSearchKey(DatabaseEntry key, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getSearchKeyRange(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus getSearchKeyRange(DatabaseEntry key, DatabaseEntry data, LockMode lockMode)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
(package private)  OperationStatus position(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode, boolean first)
          Calls position() and retrieves primary data.
 OperationStatus put(DatabaseEntry key, DatabaseEntry data)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus putCurrent(DatabaseEntry data)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus putNoDupData(DatabaseEntry key, DatabaseEntry data)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
 OperationStatus putNoOverwrite(DatabaseEntry key, DatabaseEntry data)
          Javadoc for this public method is generated via the doc templates in the doc_src directory.
(package private)  OperationStatus retrieveNext(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode, GetMode getMode)
          Calls retrieveNext() and retrieves primary data.
(package private)  OperationStatus search(DatabaseEntry key, DatabaseEntry pKey, DatabaseEntry data, LockMode lockMode, CursorImpl.SearchMode searchMode)
          Calls search() and retrieves primary data.
 
Methods inherited from class com.sleepycat.je.Cursor
advanceCursor, checkEnv, checkState, checkUpdatesAllowed, close, count, countInternal, deleteInternal, deleteNoNotify, getConfig, getCurrentInternal, getCursorImpl, getDatabase, getDatabaseImpl, isReadUncommittedMode, position, putInternal, putNoNotify, retrieveNext, search, trace, trace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SecondaryCursor

SecondaryCursor(SecondaryDatabase dbHandle,
                Transaction txn,
                CursorConfig cursorConfig)
          throws DatabaseException
Cursor constructor. Not public. To get a cursor, the user should call SecondaryDatabase.cursor();

Throws:
DatabaseException
Method Detail

getPrimaryDatabase

public Database getPrimaryDatabase()
Javadoc for this public method is generated via the doc templates in the doc_src directory.


dup

public Cursor dup(boolean samePosition)
           throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
dup in class Cursor
Throws:
DatabaseException

dupSecondary

public SecondaryCursor dupSecondary(boolean samePosition)
                             throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

delete

public OperationStatus delete()
                       throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
delete in class Cursor
Throws:
DatabaseException

put

public OperationStatus put(DatabaseEntry key,
                           DatabaseEntry data)
                    throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
put in class Cursor
Throws:
DatabaseException

putNoOverwrite

public OperationStatus putNoOverwrite(DatabaseEntry key,
                                      DatabaseEntry data)
                               throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
putNoOverwrite in class Cursor
Throws:
DatabaseException

putNoDupData

public OperationStatus putNoDupData(DatabaseEntry key,
                                    DatabaseEntry data)
                             throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
putNoDupData in class Cursor
Throws:
DatabaseException

putCurrent

public OperationStatus putCurrent(DatabaseEntry data)
                           throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
putCurrent in class Cursor
Throws:
DatabaseException

getCurrent

public OperationStatus getCurrent(DatabaseEntry key,
                                  DatabaseEntry data,
                                  LockMode lockMode)
                           throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
getCurrent in class Cursor
Throws:
DatabaseException

getCurrent

public OperationStatus getCurrent(DatabaseEntry key,
                                  DatabaseEntry pKey,
                                  DatabaseEntry data,
                                  LockMode lockMode)
                           throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

getFirst

public OperationStatus getFirst(DatabaseEntry key,
                                DatabaseEntry data,
                                LockMode lockMode)
                         throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
getFirst in class Cursor
Throws:
DatabaseException

getFirst

public OperationStatus getFirst(DatabaseEntry key,
                                DatabaseEntry pKey,
                                DatabaseEntry data,
                                LockMode lockMode)
                         throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

getLast

public OperationStatus getLast(DatabaseEntry key,
                               DatabaseEntry data,
                               LockMode lockMode)
                        throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
getLast in class Cursor
Throws:
DatabaseException

getLast

public OperationStatus getLast(DatabaseEntry key,
                               DatabaseEntry pKey,
                               DatabaseEntry data,
                               LockMode lockMode)
                        throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

getNext

public OperationStatus getNext(DatabaseEntry key,
                               DatabaseEntry data,
                               LockMode lockMode)
                        throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
getNext in class Cursor
Throws:
DatabaseException

getNext

public OperationStatus getNext(DatabaseEntry key,
                               DatabaseEntry pKey,
                               DatabaseEntry data,
                               LockMode lockMode)
                        throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

getNextDup

public OperationStatus getNextDup(DatabaseEntry key,
                                  DatabaseEntry data,
                                  LockMode lockMode)
                           throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
getNextDup in class Cursor
Throws:
DatabaseException

getNextDup

public OperationStatus getNextDup(DatabaseEntry key,
                                  DatabaseEntry pKey,
                                  DatabaseEntry data,
                                  LockMode lockMode)
                           throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

getNextNoDup

public OperationStatus getNextNoDup(DatabaseEntry key,
                                    DatabaseEntry data,
                                    LockMode lockMode)
                             throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
getNextNoDup in class Cursor
Throws:
DatabaseException

getNextNoDup

public OperationStatus getNextNoDup(DatabaseEntry key,
                                    DatabaseEntry pKey,
                                    DatabaseEntry data,
                                    LockMode lockMode)
                             throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

getPrev

public OperationStatus getPrev(DatabaseEntry key,
                               DatabaseEntry data,
                               LockMode lockMode)
                        throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
getPrev in class Cursor
Throws:
DatabaseException

getPrev

public OperationStatus getPrev(DatabaseEntry key,
                               DatabaseEntry pKey,
                               DatabaseEntry data,
                               LockMode lockMode)
                        throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

getPrevDup

public OperationStatus getPrevDup(DatabaseEntry key,
                                  DatabaseEntry data,
                                  LockMode lockMode)
                           throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
getPrevDup in class Cursor
Throws:
DatabaseException

getPrevDup

public OperationStatus getPrevDup(DatabaseEntry key,
                                  DatabaseEntry pKey,
                                  DatabaseEntry data,
                                  LockMode lockMode)
                           throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

getPrevNoDup

public OperationStatus getPrevNoDup(DatabaseEntry key,
                                    DatabaseEntry data,
                                    LockMode lockMode)
                             throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
getPrevNoDup in class Cursor
Throws:
DatabaseException

getPrevNoDup

public OperationStatus getPrevNoDup(DatabaseEntry key,
                                    DatabaseEntry pKey,
                                    DatabaseEntry data,
                                    LockMode lockMode)
                             throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

getSearchKey

public OperationStatus getSearchKey(DatabaseEntry key,
                                    DatabaseEntry data,
                                    LockMode lockMode)
                             throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
getSearchKey in class Cursor
Throws:
DatabaseException

getSearchKey

public OperationStatus getSearchKey(DatabaseEntry key,
                                    DatabaseEntry pKey,
                                    DatabaseEntry data,
                                    LockMode lockMode)
                             throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

getSearchKeyRange

public OperationStatus getSearchKeyRange(DatabaseEntry key,
                                         DatabaseEntry data,
                                         LockMode lockMode)
                                  throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
getSearchKeyRange in class Cursor
Throws:
DatabaseException

getSearchKeyRange

public OperationStatus getSearchKeyRange(DatabaseEntry key,
                                         DatabaseEntry pKey,
                                         DatabaseEntry data,
                                         LockMode lockMode)
                                  throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

getSearchBoth

public OperationStatus getSearchBoth(DatabaseEntry key,
                                     DatabaseEntry data,
                                     LockMode lockMode)
                              throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
getSearchBoth in class Cursor
Throws:
DatabaseException

getSearchBoth

public OperationStatus getSearchBoth(DatabaseEntry key,
                                     DatabaseEntry pKey,
                                     DatabaseEntry data,
                                     LockMode lockMode)
                              throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

getSearchBothRange

public OperationStatus getSearchBothRange(DatabaseEntry key,
                                          DatabaseEntry data,
                                          LockMode lockMode)
                                   throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Overrides:
getSearchBothRange in class Cursor
Throws:
DatabaseException

getSearchBothRange

public OperationStatus getSearchBothRange(DatabaseEntry key,
                                          DatabaseEntry pKey,
                                          DatabaseEntry data,
                                          LockMode lockMode)
                                   throws DatabaseException
Javadoc for this public method is generated via the doc templates in the doc_src directory.

Throws:
DatabaseException

search

OperationStatus search(DatabaseEntry key,
                       DatabaseEntry pKey,
                       DatabaseEntry data,
                       LockMode lockMode,
                       CursorImpl.SearchMode searchMode)
                 throws DatabaseException
Calls search() and retrieves primary data.

Throws:
DatabaseException

position

OperationStatus position(DatabaseEntry key,
                         DatabaseEntry pKey,
                         DatabaseEntry data,
                         LockMode lockMode,
                         boolean first)
                   throws DatabaseException
Calls position() and retrieves primary data.

Throws:
DatabaseException

retrieveNext

OperationStatus retrieveNext(DatabaseEntry key,
                             DatabaseEntry pKey,
                             DatabaseEntry data,
                             LockMode lockMode,
                             GetMode getMode)
                       throws DatabaseException
Calls retrieveNext() and retrieves primary data.

Throws:
DatabaseException


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