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/HeapRecordId.html | 817 +++++++++++++-------------- 1 file changed, 395 insertions(+), 422 deletions(-) (limited to 'docs/java/com/sleepycat/db/HeapRecordId.html') diff --git a/docs/java/com/sleepycat/db/HeapRecordId.html b/docs/java/com/sleepycat/db/HeapRecordId.html index fdd221e6..d51157ef 100644 --- a/docs/java/com/sleepycat/db/HeapRecordId.html +++ b/docs/java/com/sleepycat/db/HeapRecordId.html @@ -1,447 +1,420 @@ - - - - - -HeapRecordId (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 HeapRecordId

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

-Content used for the key in a Heap database record. Berkeley DB creates +

+
com.sleepycat.db
+

Class HeapRecordId

+
+
+ +
+
    +
  • +
    +
    +
    public class HeapRecordId
+extends java.lang.Object
    +
    Content used for the key in a Heap database record. Berkeley DB creates this value for you when you create a record in a Heap database. You should never create this structure yourself; Berkeley DB must create it for you. This structure is returned in the key DatabaseEntry parameter of the - method that you use to add a record to the Heap database. -

    - -

    -

    - -

    - + method that you use to add a record to the Heap database.

    +
    • +
+
+
+
    +
  • - - - - - - - - - -
    -Constructor Summary
    HeapRecordId(int pgno, - short indx) - -
    -          Construct a new record id, given a page number and index.
    -  +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      HeapRecordId(int pgno, + short indx) +
      Construct a new record id, given a page number and index.
      +
      +
      • +
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -Method Summary
    -static HeapRecordIdfromArray(byte[] data) - -
    -          Construct a HeapRecordId from a byte array, typically from - a DatabaseEntry.
    -static HeapRecordIdfromArray(byte[] data, - ByteOrder order) - -
    -          Construct a HeapRecordId from a byte array, typically from - a DatabaseEntry.
    - shortgetIndex() - -
    -          Get the index in the offset table where the record can be found.
    - intgetPageNumber() - -
    -          Get the database page number where the record is stored.
    - voidsetIndex(short indx) - -
    -          Set the index in the offset table where the record can be found.
    - voidsetPageNumber(int pgno) - -
    -          Set the database page number where the record is stored.
    - byte[]toArray() - -
    -          Return a byte array representing this record id.
    - byte[]toArray(ByteOrder order) - -
    -          Return a byte array representing this record id.
    -  - - - - - - - -
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    -  -

    - +

      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static HeapRecordIdfromArray(byte[] data) +
      Construct a HeapRecordId from a byte array, typically from + a DatabaseEntry.
      +
      static HeapRecordIdfromArray(byte[] data, + java.nio.ByteOrder order) +
      Construct a HeapRecordId from a byte array, typically from + a DatabaseEntry.
      +
      shortgetIndex() +
      Get the index in the offset table where the record can be found.
      +
      intgetPageNumber() +
      Get the database page number where the record is stored.
      +
      voidsetIndex(short indx) +
      Set the index in the offset table where the record can be found.
      +
      voidsetPageNumber(int pgno) +
      Set the database page number where the record is stored.
      +
      byte[]toArray() +
      Return a byte array representing this record id.
      +
      byte[]toArray(java.nio.ByteOrder order) +
      Return a byte array representing this record id.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • - - - - - - -
    -Constructor Detail
    - -

    -HeapRecordId

    -
    -public HeapRecordId(int pgno,
-                    short indx)
    -
    -
    Construct a new record id, given a page number and index. -

    -

    -

    -
    Parameters:
    pgno - The database page number where the record is stored. -

    indx - Index in the offset table where the record can be found.
    -
    - +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HeapRecordId

        +
        public HeapRecordId(int pgno,
+            short indx)
        +
        Construct a new record id, given a page number and index. +

        +
        Parameters:
        pgno - The database page number where the record is stored. +

        indx - Index in the offset table where the record can be found.
        +
        • +
      +
      • +
    - - - - - - -
    -Method Detail
    - -

    -fromArray

    -
    -public static HeapRecordId fromArray(byte[] data)
-                              throws IllegalArgumentException
    -
    -
    Construct a HeapRecordId from a byte array, typically from - a DatabaseEntry. -

    -

    -

    -
    Parameters:
    data - The array representing the record id. -

    -

    Returns:
    A new HeapRecordId -
    Throws: -
    IllegalArgumentException
    -
    -
    -
    - -

    -fromArray

    -
    -public static HeapRecordId fromArray(byte[] data,
-                                     ByteOrder order)
-                              throws IllegalArgumentException
    -
    -
    Construct a HeapRecordId from a byte array, typically from - a DatabaseEntry. -

    -

    -

    -
    Parameters:
    data - The array representing the record id. -

    order - The byte order of data stored in the array. -

    -

    Returns:
    A new HeapRecordId -
    Throws: -
    IllegalArgumentException
    -
    -
    -
    - -

    -toArray

    -
    -public byte[] toArray()
    -
    -
    Return a byte array representing this record id. -

    -

    -

    - -
    Returns:
    A byte array representing this record id.
    -
    -
    -
    - -

    -toArray

    -
    -public byte[] toArray(ByteOrder order)
    -
    -
    Return a byte array representing this record id. -

    -

    -

    -
    Parameters:
    order - The byte order to use when constructing the array. -

    -

    Returns:
    A byte array representing this record id.
    -
    -
    -
    - -

    -getPageNumber

    -
    -public int getPageNumber()
    -
    -
    Get the database page number where the record is stored. -

    -

    -

    - -
    Returns:
    The database page number where the record is stored.
    -
    -
    -
    - -

    -setPageNumber

    -
    -public void setPageNumber(int pgno)
    -
    -
    Set the database page number where the record is stored. -

    -

    -
    -
    -
    -
    - -

    -getIndex

    -
    -public short getIndex()
    -
    -
    Get the index in the offset table where the record can be found. -

    -

    -

    - -
    Returns:
    The index in the offset table where the record can be found.
    -
    -
    -
    - -

    -setIndex

    -
    -public void setIndex(short indx)
    -
    -
    Set the index in the offset table where the record can be found. -

    -

    -
    -
    -
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fromArray

        +
        public static HeapRecordId fromArray(byte[] data)
+                              throws java.lang.IllegalArgumentException
        +
        Construct a HeapRecordId from a byte array, typically from + a DatabaseEntry. +

        +
        Parameters:
        data - The array representing the record id. +

        +
        Returns:
        A new HeapRecordId
        +
        Throws:
        +
        java.lang.IllegalArgumentException
        +
        • +
      + + + +
        +
      • +

        fromArray

        +
        public static HeapRecordId fromArray(byte[] data,
+                     java.nio.ByteOrder order)
+                              throws java.lang.IllegalArgumentException
        +
        Construct a HeapRecordId from a byte array, typically from + a DatabaseEntry. +

        +
        Parameters:
        data - The array representing the record id. +

        order - The byte order of data stored in the array. +

        +
        Returns:
        A new HeapRecordId
        +
        Throws:
        +
        java.lang.IllegalArgumentException
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public byte[] toArray()
        +
        Return a byte array representing this record id. +

        +
        Returns:
        A byte array representing this record id.
        +
        • +
      + + + +
        +
      • +

        toArray

        +
        public byte[] toArray(java.nio.ByteOrder order)
        +
        Return a byte array representing this record id. +

        +
        Parameters:
        order - The byte order to use when constructing the array. +

        +
        Returns:
        A byte array representing this record id.
        +
        • +
      + + + +
        +
      • +

        getPageNumber

        +
        public int getPageNumber()
        +
        Get the database page number where the record is stored. +

        +
        Returns:
        The database page number where the record is stored.
        +
        • +
      + + + +
        +
      • +

        setPageNumber

        +
        public void setPageNumber(int pgno)
        +
        Set the database page number where the record is stored.
        +
        • +
      + + + +
        +
      • +

        getIndex

        +
        public short getIndex()
        +
        Get the index in the offset table where the record can be found. +

        +
        Returns:
        The index in the offset table where the record can be found.
        +
        • +
      + + + +
        +
      • +

        setIndex

        +
        public void setIndex(short indx)
        +
        Set the index in the offset table where the record can be found.
        +
        • +
      +
      • +
    +
    • +
+
+
-
- - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
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