| 
 | Berkeley DB version 5.3.28 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.sleepycat.db.HeapRecordId
public class HeapRecordId
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.
| Constructor Summary | |
|---|---|
| HeapRecordId(int pgno,
             short indx)Construct a new record id, given a page number and index. | |
| Method Summary | |
|---|---|
| static HeapRecordId | fromArray(byte[] data)Construct a HeapRecordId from a byte array, typically from a DatabaseEntry. | 
| static HeapRecordId | fromArray(byte[] data,
          ByteOrder order)Construct a HeapRecordId from a byte array, typically from a DatabaseEntry. | 
|  short | getIndex()Get the index in the offset table where the record can be found. | 
|  int | getPageNumber()Get the database page number where the record is stored. | 
|  void | setIndex(short indx)Set the index in the offset table where the record can be found. | 
|  void | setPageNumber(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 | 
| Constructor Detail | 
|---|
public HeapRecordId(int pgno,
                    short indx)
pgno - The database page number where the record is stored.
       indx - Index in the offset table where the record can be found.| Method Detail | 
|---|
public static HeapRecordId fromArray(byte[] data)
                              throws IllegalArgumentException
DatabaseEntry.
       
data - The array representing the record id.
       
IllegalArgumentException
public static HeapRecordId fromArray(byte[] data,
                                     ByteOrder order)
                              throws IllegalArgumentException
DatabaseEntry.
       
data - The array representing the record id.
       order - The byte order of data stored in the array.
       
IllegalArgumentExceptionpublic byte[] toArray()
public byte[] toArray(ByteOrder order)
order - The byte order to use when constructing the array.
       
public int getPageNumber()
public void setPageNumber(int pgno)
public short getIndex()
public void setIndex(short indx)
| 
 | Berkeley DB version 5.3.28 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||