diff options
Diffstat (limited to 'docs/java/com/sleepycat/db/HeapRecordId.html')
| -rw-r--r-- | docs/java/com/sleepycat/db/HeapRecordId.html | 817 |
1 files changed, 395 insertions, 422 deletions
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 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<!-- Generated by javadoc (build 1.6.0_23) on Fri May 11 14:10:05 EDT 2012 --> -<TITLE> -HeapRecordId (Oracle - Berkeley DB Java API) -</TITLE> - -<META NAME="date" CONTENT="2012-05-11"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Tue Feb 17 12:25:53 EST 2015 --> +<title>HeapRecordId (Oracle - Berkeley DB Java API)</title> +<meta name="date" content="2015-02-17"> +<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> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> -<HR> - - +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<A NAME="navbar_top"><!-- --></A> -<A HREF="#skip-navbar_top" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_top_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/HeapRecordId.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/db/HeapFullException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/HeapStats.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/db/HeapRecordId.html" target="_top"><B>FRAMES</B></A> - <A HREF="HeapRecordId.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<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.23</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) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> +</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 ========= --> - -<HR> <!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -com.sleepycat.db</FONT> -<BR> -Class HeapRecordId</H2> -<PRE> -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.HeapRecordId</B> -</PRE> -<HR> -<DL> -<DT><PRE>public class <B>HeapRecordId</B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> -</PRE> - -<P> -Content used for the key in a Heap database record. Berkeley DB creates +<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. -<P> - -<P> -<HR> - -<P> - + 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 ======== --> - -<A NAME="constructor_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Constructor Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/HeapRecordId.html#HeapRecordId(int, short)">HeapRecordId</A></B>(int pgno, - short indx)</CODE> - -<BR> - Construct a new record id, given a page number and index.</TD> -</TR> -</TABLE> - +<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 =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="../../../com/sleepycat/db/HeapRecordId.html" title="class in com.sleepycat.db">HeapRecordId</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/HeapRecordId.html#fromArray(byte[])">fromArray</A></B>(byte[] data)</CODE> - -<BR> - 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>.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="../../../com/sleepycat/db/HeapRecordId.html" title="class in com.sleepycat.db">HeapRecordId</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/HeapRecordId.html#fromArray(byte[], java.nio.ByteOrder)">fromArray</A></B>(byte[] data, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteOrder.html?is-external=true" title="class or interface in java.nio">ByteOrder</A> order)</CODE> - -<BR> - 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>.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> short</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/HeapRecordId.html#getIndex()">getIndex</A></B>()</CODE> - -<BR> - Get the index in the offset table where the record can be found.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/HeapRecordId.html#getPageNumber()">getPageNumber</A></B>()</CODE> - -<BR> - Get the database page number where the record is stored.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/HeapRecordId.html#setIndex(short)">setIndex</A></B>(short indx)</CODE> - -<BR> - Set the index in the offset table where the record can be found.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/HeapRecordId.html#setPageNumber(int)">setPageNumber</A></B>(int pgno)</CODE> - -<BR> - Set the database page number where the record is stored.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> byte[]</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/HeapRecordId.html#toArray()">toArray</A></B>()</CODE> - -<BR> - Return a byte array representing this record id.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> byte[]</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/HeapRecordId.html#toArray(java.nio.ByteOrder)">toArray</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteOrder.html?is-external=true" title="class or interface in java.nio">ByteOrder</A> order)</CODE> - -<BR> - Return a byte array representing this record id.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</TR> -</TABLE> - -<P> - +<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 ======== --> - -<A NAME="constructor_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Constructor Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="HeapRecordId(int, short)"><!-- --></A><H3> -HeapRecordId</H3> -<PRE> -public <B>HeapRecordId</B>(int pgno, - short indx)</PRE> -<DL> -<DD>Construct a new record id, given a page number and index. - <p> -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>pgno</CODE> - The database page number where the record is stored. - <p><DD><CODE>indx</CODE> - Index in the offset table where the record can be found.</DL> -</DL> - +<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 ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="fromArray(byte[])"><!-- --></A><H3> -fromArray</H3> -<PRE> -public static <A HREF="../../../com/sleepycat/db/HeapRecordId.html" title="class in com.sleepycat.db">HeapRecordId</A> <B>fromArray</B>(byte[] data) - throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE> -<DL> -<DD>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> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>data</CODE> - The array representing the record id. - <p> -<DT><B>Returns:</B><DD>A new HeapRecordId -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="fromArray(byte[], java.nio.ByteOrder)"><!-- --></A><H3> -fromArray</H3> -<PRE> -public static <A HREF="../../../com/sleepycat/db/HeapRecordId.html" title="class in com.sleepycat.db">HeapRecordId</A> <B>fromArray</B>(byte[] data, - <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteOrder.html?is-external=true" title="class or interface in java.nio">ByteOrder</A> order) - throws <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></PRE> -<DL> -<DD>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> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>data</CODE> - The array representing the record id. - <p><DD><CODE>order</CODE> - The byte order of data stored in the array. - <p> -<DT><B>Returns:</B><DD>A new HeapRecordId -<DT><B>Throws:</B> -<DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE></DL> -</DD> -</DL> -<HR> - -<A NAME="toArray()"><!-- --></A><H3> -toArray</H3> -<PRE> -public byte[] <B>toArray</B>()</PRE> -<DL> -<DD>Return a byte array representing this record id. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>A byte array representing this record id.</DL> -</DD> -</DL> -<HR> - -<A NAME="toArray(java.nio.ByteOrder)"><!-- --></A><H3> -toArray</H3> -<PRE> -public byte[] <B>toArray</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteOrder.html?is-external=true" title="class or interface in java.nio">ByteOrder</A> order)</PRE> -<DL> -<DD>Return a byte array representing this record id. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>order</CODE> - The byte order to use when constructing the array. - <p> -<DT><B>Returns:</B><DD>A byte array representing this record id.</DL> -</DD> -</DL> -<HR> - -<A NAME="getPageNumber()"><!-- --></A><H3> -getPageNumber</H3> -<PRE> -public int <B>getPageNumber</B>()</PRE> -<DL> -<DD>Get the database page number where the record is stored. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The database page number where the record is stored.</DL> -</DD> -</DL> -<HR> - -<A NAME="setPageNumber(int)"><!-- --></A><H3> -setPageNumber</H3> -<PRE> -public void <B>setPageNumber</B>(int pgno)</PRE> -<DL> -<DD>Set the database page number where the record is stored. -<P> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getIndex()"><!-- --></A><H3> -getIndex</H3> -<PRE> -public short <B>getIndex</B>()</PRE> -<DL> -<DD>Get the index in the offset table where the record can be found. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The index in the offset table where the record can be found.</DL> -</DD> -</DL> -<HR> - -<A NAME="setIndex(short)"><!-- --></A><H3> -setIndex</H3> -<PRE> -public void <B>setIndex</B>(short indx)</PRE> -<DL> -<DD>Set the index in the offset table where the record can be found. -<P> -<DD><DL> -</DL> -</DD> -</DL> +<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 ========= --> -<HR> - - <!-- ======= START OF BOTTOM NAVBAR ====== --> -<A NAME="navbar_bottom"><!-- --></A> -<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_bottom_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/HeapRecordId.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/db/HeapFullException.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/HeapStats.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/db/HeapRecordId.html" target="_top"><B>FRAMES</B></A> - <A HREF="HeapRecordId.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<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.23</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) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> +</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 ======= --> - -<HR> -<font size=1>Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved.</font> -</BODY> -</HTML> +<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.</font></small></p> +</body> +</html> |