From 780b92ada9afcf1d58085a83a0b9e6bc982203d1 Mon Sep 17 00:00:00 2001 From: Lorry Tar Creator Date: Tue, 17 Feb 2015 17:25:57 +0000 Subject: Imported from /home/lorry/working-area/delta_berkeleydb/db-6.1.23.tar.gz. --- docs/java/com/sleepycat/db/SecondaryCursor.html | 1829 +++++++++++------------ 1 file changed, 883 insertions(+), 946 deletions(-) (limited to 'docs/java/com/sleepycat/db/SecondaryCursor.html') diff --git a/docs/java/com/sleepycat/db/SecondaryCursor.html b/docs/java/com/sleepycat/db/SecondaryCursor.html index 6c2f4a4a..e4fcb72a 100644 --- a/docs/java/com/sleepycat/db/SecondaryCursor.html +++ b/docs/java/com/sleepycat/db/SecondaryCursor.html @@ -1,126 +1,128 @@ - - - - - -SecondaryCursor (Oracle - Berkeley DB Java API) - - - - - - - - - - - - -
- - +//--> + + - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 -Berkeley DB
version 5.3.21 -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
-

- -com.sleepycat.db -
-Class SecondaryCursor

-
-java.lang.Object
-  extended by com.sleepycat.db.Cursor
-      extended by com.sleepycat.db.SecondaryCursor
-
-
-
-
public class SecondaryCursor
extends Cursor
- - -

-A database cursor for a secondary database. Cursors are not thread safe +

+
com.sleepycat.db
+

Class SecondaryCursor

+
+
+ +
+
    +
  • +
    +
    +
    public class SecondaryCursor
+extends Cursor
    +
    A database cursor for a secondary database. Cursors are not thread safe and the application is responsible for coordinating any multithreaded access to a single cursor object.

    Secondary cursors are returned by -SecondaryDatabase.openCursor and -SecondaryDatabase.openSecondaryCursor. The distinguishing characteristics +SecondaryDatabase.openCursor and +SecondaryDatabase.openSecondaryCursor. The distinguishing characteristics of a secondary cursor are:

    • Direct calls to put() methods on a secondary cursor are prohibited. -
    • The Cursor.delete() method of a secondary cursor will delete the primary +
    • The Cursor.delete() method of a secondary cursor will delete the primary record and as well as all its associated secondary records.
    • Calls to all get methods will return the data from the associated primary database.
    • Additional get method signatures are provided to return the primary key in an additional pKey parameter. -
    • Calls to dup(boolean) will return a SecondaryCursor. -
    • The dupSecondary(boolean) method is provided to return a SecondaryCursor that doesn't require casting. +
    • Calls to dup(boolean) will return a SecondaryCursor. +
    • The dupSecondary(boolean) method is provided to return a SecondaryCursor that doesn't require casting.

    To obtain a secondary cursor with default attributes: @@ -132,454 +134,406 @@ To customize the attributes of a cursor, use a CursorConfig object. CursorConfig config = new CursorConfig(); config.setDirtyRead(true); SecondaryCursor cursor = myDb.openSecondaryCursor(txn, config); - -

    - -

    -

    - -

    - +

    +
    • +
+
+
+ + + +
+
+
    +
  • - - - - - - -
    -Method Detail
    - -

    -getSecondaryDatabase

    -
    -public SecondaryDatabase getSecondaryDatabase()
    -
    -
    Return the SecondaryDatabase handle associated with this Cursor. -

    -

    -

    - -
    Returns:
    The SecondaryDatabase handle associated with this Cursor. -

    -
    -
    -
    - -

    -dup

    -
    -public Cursor dup(boolean samePosition)
-           throws DatabaseException
    -
    -
    Returns a new SecondaryCursor for the same transaction as - the original cursor. -

    -

    -
    Overrides:
    dup in class Cursor
    -
    -
    -
    Parameters:
    samePosition - If true, the newly created cursor is initialized to refer to the +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getSecondaryDatabase

        +
        public SecondaryDatabase getSecondaryDatabase()
        +
        Return the SecondaryDatabase handle associated with this Cursor. +

        +
        Returns:
        The SecondaryDatabase handle associated with this Cursor. +

        +
        • +
      + + + +
        +
      • +

        dup

        +
        public Cursor dup(boolean samePosition)
+           throws DatabaseException
        +
        Returns a new SecondaryCursor for the same transaction as + the original cursor.
        +
        +
        Overrides:
        +
        dup in class Cursor
        +
        Parameters:
        samePosition - If true, the newly created cursor is initialized to refer to the same position in the database as the original cursor (if any) and hold the same locks (if any). If false, or the original cursor does not hold a database position and locks, the returned cursor is uninitialized and will behave like a newly created cursor. -

        -

        Returns:
        A new cursor with the same transaction and locker ID as the original +

        +
        Returns:
        A new cursor with the same transaction and locker ID as the original cursor.

        +

        +
        Throws:
        +
        DatabaseException - if a failure occurs.
        +
        • +
      + + + +
    -
    -
    -
    - -

    -dupSecondary

    -
    -public SecondaryCursor dupSecondary(boolean samePosition)
-                             throws DatabaseException
    -
    -
    Returns a new copy of the cursor as a SecondaryCursor. -

    - Calling this method is the equivalent of calling dup(boolean) and - casting the result to SecondaryCursor. -

    -

    -

    - -
    Throws: -
    DatabaseException
    See Also:
    dup(boolean)
    -
    -
    -
    - -

    -getCurrent

    -
    -public OperationStatus getCurrent(DatabaseEntry key,
-                                  DatabaseEntry pKey,
-                                  DatabaseEntry data,
-                                  LockMode lockMode)
-                           throws DatabaseException
    -
    -
    Returns the key/data pair to which the cursor refers. + Calling this method is the equivalent of calling dup(boolean) and + casting the result to SecondaryCursor. +

+
Throws:
+
DatabaseException
See Also:
dup(boolean)
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ -
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
-		 -Berkeley DB
version 5.3.21 -
- PREV CLASS  - NEXT CLASS - FRAMES   - NO FRAMES   -  - - - -
- SUMMARY: NESTED | FIELD | CONSTR | METHOD -DETAIL: FIELD | CONSTR | METHOD
- + + +
+ + +
+ + + - -
-Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved. - - +

Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.

+ + -- cgit v1.2.1