<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_75) on Fri May 13 13:32:16 PDT 2016 -->
<title>HeapRecordId (Oracle - Berkeley DB Java API)</title>
<meta name="date" content="2016-05-13">
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="HeapRecordId (Oracle - Berkeley DB Java API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/HeapRecordId.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/db/HeapFullException.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/db/HeapStats.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/db/HeapRecordId.html" target="_top">Frames</a></li>
<li><a href="HeapRecordId.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.sleepycat.db</div>
<h2 title="Class HeapRecordId" class="title">Class HeapRecordId</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.db.HeapRecordId</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">HeapRecordId</span>
extends java.lang.Object</pre>
<div class="block">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.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../com/sleepycat/db/HeapRecordId.html#HeapRecordId(int,%20short)">HeapRecordId</a></strong>(int pgno,
short indx)</code>
<div class="block">Construct a new record id, given a page number and index.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../com/sleepycat/db/HeapRecordId.html" title="class in com.sleepycat.db">HeapRecordId</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/HeapRecordId.html#fromArray(byte[])">fromArray</a></strong>(byte[] data)</code>
<div class="block">Construct a HeapRecordId from a byte array, typically from
a <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../com/sleepycat/db/HeapRecordId.html" title="class in com.sleepycat.db">HeapRecordId</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/HeapRecordId.html#fromArray(byte[],%20java.nio.ByteOrder)">fromArray</a></strong>(byte[] data,
java.nio.ByteOrder order)</code>
<div class="block">Construct a HeapRecordId from a byte array, typically from
a <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/HeapRecordId.html#getIndex()">getIndex</a></strong>()</code>
<div class="block">Get the index in the offset table where the record can be found.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/HeapRecordId.html#getPageNumber()">getPageNumber</a></strong>()</code>
<div class="block">Get the database page number where the record is stored.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/HeapRecordId.html#setIndex(short)">setIndex</a></strong>(short indx)</code>
<div class="block">Set the index in the offset table where the record can be found.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/HeapRecordId.html#setPageNumber(int)">setPageNumber</a></strong>(int pgno)</code>
<div class="block">Set the database page number where the record is stored.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/HeapRecordId.html#toArray()">toArray</a></strong>()</code>
<div class="block">Return a byte array representing this record id.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/HeapRecordId.html#toArray(java.nio.ByteOrder)">toArray</a></strong>(java.nio.ByteOrder order)</code>
<div class="block">Return a byte array representing this record id.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="HeapRecordId(int, short)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HeapRecordId</h4>
<pre>public HeapRecordId(int pgno,
short indx)</pre>
<div class="block">Construct a new record id, given a page number and index.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pgno</code> - The database page number where the record is stored.
<p></dd><dd><code>indx</code> - Index in the offset table where the record can be found.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="fromArray(byte[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromArray</h4>
<pre>public static <a href="../../../com/sleepycat/db/HeapRecordId.html" title="class in com.sleepycat.db">HeapRecordId</a> fromArray(byte[] data)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Construct a HeapRecordId from a byte array, typically from
a <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a>.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - The array representing the record id.
<p></dd>
<dt><span class="strong">Returns:</span></dt><dd>A new HeapRecordId</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code></dd></dl>
</li>
</ul>
<a name="fromArray(byte[], java.nio.ByteOrder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromArray</h4>
<pre>public static <a href="../../../com/sleepycat/db/HeapRecordId.html" title="class in com.sleepycat.db">HeapRecordId</a> fromArray(byte[] data,
java.nio.ByteOrder order)
throws java.lang.IllegalArgumentException</pre>
<div class="block">Construct a HeapRecordId from a byte array, typically from
a <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a>.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - The array representing the record id.
<p></dd><dd><code>order</code> - The byte order of data stored in the array.
<p></dd>
<dt><span class="strong">Returns:</span></dt><dd>A new HeapRecordId</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code></dd></dl>
</li>
</ul>
<a name="toArray()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toArray</h4>
<pre>public byte[] toArray()</pre>
<div class="block">Return a byte array representing this record id.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A byte array representing this record id.</dd></dl>
</li>
</ul>
<a name="toArray(java.nio.ByteOrder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toArray</h4>
<pre>public byte[] toArray(java.nio.ByteOrder order)</pre>
<div class="block">Return a byte array representing this record id.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>order</code> - The byte order to use when constructing the array.
<p></dd>
<dt><span class="strong">Returns:</span></dt><dd>A byte array representing this record id.</dd></dl>
</li>
</ul>
<a name="getPageNumber()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPageNumber</h4>
<pre>public int getPageNumber()</pre>
<div class="block">Get the database page number where the record is stored.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The database page number where the record is stored.</dd></dl>
</li>
</ul>
<a name="setPageNumber(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setPageNumber</h4>
<pre>public void setPageNumber(int pgno)</pre>
<div class="block">Set the database page number where the record is stored.</div>
</li>
</ul>
<a name="getIndex()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIndex</h4>
<pre>public short getIndex()</pre>
<div class="block">Get the index in the offset table where the record can be found.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The index in the offset table where the record can be found.</dd></dl>
</li>
</ul>
<a name="setIndex(short)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setIndex</h4>
<pre>public void setIndex(short indx)</pre>
<div class="block">Set the index in the offset table where the record can be found.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/HeapRecordId.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/db/HeapFullException.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/db/HeapStats.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/db/HeapRecordId.html" target="_top">Frames</a></li>
<li><a href="HeapRecordId.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2016 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>
