1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.5.0) on Thu May 15 17:17:31 EDT 2008 --> 6<TITLE> 7MultipleEntry (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="keywords" CONTENT="com.sleepycat.db.MultipleEntry class"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 parent.document.title="MultipleEntry (Oracle - Berkeley DB Java API)"; 18} 19</SCRIPT> 20<NOSCRIPT> 21</NOSCRIPT> 22 23</HEAD> 24 25<BODY BGCOLOR="white" onload="windowTitle();"> 26 27 28<!-- ========= START OF TOP NAVBAR ======= --> 29<A NAME="navbar_top"><!-- --></A> 30<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 32<TR> 33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 34<A NAME="navbar_top_firstrow"><!-- --></A> 35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 36 <TR ALIGN="center" VALIGN="top"> 37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MultipleEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 45 </TR> 46</TABLE> 47</TD> 48<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 49<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 50</TD> 51</TR> 52 53<TR> 54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 55 <A HREF="../../../com/sleepycat/db/MultipleDataEntry.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 56 <A HREF="../../../com/sleepycat/db/MultipleKeyDataEntry.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../index.html?com/sleepycat/db/MultipleEntry.html" target="_top"><B>FRAMES</B></A> 59 <A HREF="MultipleEntry.html" target="_top"><B>NO FRAMES</B></A> 60 <SCRIPT type="text/javascript"> 61 <!-- 62 if(window==top) { 63 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 64 } 65 //--> 66</SCRIPT> 67<NOSCRIPT> 68 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 69</NOSCRIPT> 70 71 72</FONT></TD> 73</TR> 74<TR> 75<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 76 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 78DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 79</TR> 80</TABLE> 81<A NAME="skip-navbar_top"></A> 82<!-- ========= END OF TOP NAVBAR ========= --> 83 84<HR> 85<!-- ======== START OF CLASS DATA ======== --> 86<H2> 87<FONT SIZE="-1"> 88com.sleepycat.db</FONT> 89<BR> 90Class MultipleEntry</H2> 91<PRE> 92<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> 93 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">com.sleepycat.db.DatabaseEntry</A> 94 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.MultipleEntry</B> 95</PRE> 96<DL> 97<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/sleepycat/db/MultipleDataEntry.html" title="class in com.sleepycat.db">MultipleDataEntry</A>, <A HREF="../../../com/sleepycat/db/MultipleKeyDataEntry.html" title="class in com.sleepycat.db">MultipleKeyDataEntry</A>, <A HREF="../../../com/sleepycat/db/MultipleKeyNIODataEntry.html" title="class in com.sleepycat.db">MultipleKeyNIODataEntry</A>, <A HREF="../../../com/sleepycat/db/MultipleNIODataEntry.html" title="class in com.sleepycat.db">MultipleNIODataEntry</A>, <A HREF="../../../com/sleepycat/db/MultipleRecnoDataEntry.html" title="class in com.sleepycat.db">MultipleRecnoDataEntry</A>, <A HREF="../../../com/sleepycat/db/MultipleRecnoNIODataEntry.html" title="class in com.sleepycat.db">MultipleRecnoNIODataEntry</A></DD> 98</DL> 99<HR> 100<DL> 101<DT><PRE>public abstract class <B>MultipleEntry</B><DT>extends <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A></DL> 102</PRE> 103 104<P> 105An abstract class representing a DatabaseEntry that holds multiple results 106returned by a single <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><CODE>Cursor</CODE></A> get method. Use one of the concrete 107subclasses depending on whether you need: 108<ul> 109<li>multiple data items only: <A HREF="../../../com/sleepycat/db/MultipleDataEntry.html" title="class in com.sleepycat.db"><CODE>MultipleDataEntry</CODE></A></li> 110<li>multiple key / data item pairs: <A HREF="../../../com/sleepycat/db/MultipleKeyDataEntry.html" title="class in com.sleepycat.db"><CODE>MultipleKeyDataEntry</CODE></A></li> 111<li>multiple record number / data item pairs: 112<A HREF="../../../com/sleepycat/db/MultipleRecnoDataEntry.html" title="class in com.sleepycat.db"><CODE>MultipleRecnoDataEntry</CODE></A></li> 113</ul> 114<P> 115 116<P> 117<HR> 118 119<P> 120 121<!-- ========== METHOD SUMMARY =========== --> 122 123<A NAME="method_summary"><!-- --></A> 124<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 125<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 126<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 127<B>Method Summary</B></FONT></TH> 128</TR> 129<TR BGCOLOR="white" CLASS="TableRowColor"> 130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 131<CODE> void</CODE></FONT></TD> 132<TD><CODE><B><A HREF="../../../com/sleepycat/db/MultipleEntry.html#setUserBuffer(int, boolean)">setUserBuffer</A></B>(int length, 133 boolean usermem)</CODE> 134 135<BR> 136 Configures the entry with an application-owned buffer.</TD> 137</TR> 138</TABLE> 139 <A NAME="methods_inherited_from_class_com.sleepycat.db.DatabaseEntry"><!-- --></A> 140<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 141<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 142<TH ALIGN="left"><B>Methods inherited from class com.sleepycat.db.<A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A></B></TH> 143</TR> 144<TR BGCOLOR="white" CLASS="TableRowColor"> 145<TD><CODE><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#equals(java.lang.Object)">equals</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getData()">getData</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getDataNIO()">getDataNIO</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getOffset()">getOffset</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getPartial()">getPartial</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getPartialLength()">getPartialLength</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getPartialOffset()">getPartialOffset</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getRecordNumber()">getRecordNumber</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getReuseBuffer()">getReuseBuffer</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getSize()">getSize</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getUserBuffer()">getUserBuffer</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getUserBufferLength()">getUserBufferLength</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#hashCode()">hashCode</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setData(byte[])">setData</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setData(byte[], int, int)">setData</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setDataNIO(java.nio.ByteBuffer)">setDataNIO</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setDataNIO(java.nio.ByteBuffer, int, int)">setDataNIO</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setOffset(int)">setOffset</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(boolean)">setPartial</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int, int, boolean)">setPartial</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartialLength(int)">setPartialLength</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartialOffset(int)">setPartialOffset</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setRecordNumber(int)">setRecordNumber</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setReuseBuffer(boolean)">setReuseBuffer</A>, <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setSize(int)">setSize</A></CODE></TD> 146</TR> 147</TABLE> 148 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 149<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 150<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 151<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> 152</TR> 153<TR BGCOLOR="white" CLASS="TableRowColor"> 154<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 155</TR> 156</TABLE> 157 158<P> 159 160<!-- ============ METHOD DETAIL ========== --> 161 162<A NAME="method_detail"><!-- --></A> 163<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 164<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 165<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 166<B>Method Detail</B></FONT></TH> 167</TR> 168</TABLE> 169 170<A NAME="setUserBuffer(int, boolean)"><!-- --></A><H3> 171setUserBuffer</H3> 172<PRE> 173public void <B>setUserBuffer</B>(int length, 174 boolean usermem)</PRE> 175<DL> 176<DD><B>Description copied from class: <CODE><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setUserBuffer(int, boolean)">DatabaseEntry</A></CODE></B></DD> 177<DD>Configures the entry with an application-owned buffer. 178 <p> 179 The <code>data</code> field of the entry must refer to a buffer that is 180 at least <code>length</code> bytes in length. 181 <p> 182 If the length of the requested item is less than or equal to that number 183 of bytes, the item is copied into the memory to which the 184 <code>data</code> field refers. Otherwise, the <code>size</code> field 185 is set to the length needed for the requested item, and a 186 <A HREF="../../../com/sleepycat/db/MemoryException.html" title="class in com.sleepycat.db"><CODE>MemoryException</CODE></A> is thrown. 187 <p> 188 Applications can determine the length of a record by setting 189 <code>length</code> to 0 and calling <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getSize()"><CODE>DatabaseEntry.getSize</CODE></A> 190 on the return value. 191 <p> 192<P> 193<DD><DL> 194<DT><B>Overrides:</B><DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setUserBuffer(int, boolean)">setUserBuffer</A></CODE> in class <CODE><A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A></CODE></DL> 195</DD> 196<DD><DL> 197<DT><B>Parameters:</B><DD><CODE>length</CODE> - the length of the buffer 198 <p><DD><CODE>usermem</CODE> - whether the buffer is owned by the application</DL> 199</DD> 200</DL> 201<!-- ========= END OF CLASS DATA ========= --> 202<HR> 203 204 205<!-- ======= START OF BOTTOM NAVBAR ====== --> 206<A NAME="navbar_bottom"><!-- --></A> 207<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 208<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 209<TR> 210<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 211<A NAME="navbar_bottom_firstrow"><!-- --></A> 212<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 213 <TR ALIGN="center" VALIGN="top"> 214 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 215 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 216 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 217 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MultipleEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 218 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 219 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 220 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 221 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 222 </TR> 223</TABLE> 224</TD> 225<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 226<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 227</TD> 228</TR> 229 230<TR> 231<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 232 <A HREF="../../../com/sleepycat/db/MultipleDataEntry.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 233 <A HREF="../../../com/sleepycat/db/MultipleKeyDataEntry.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 234<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 235 <A HREF="../../../index.html?com/sleepycat/db/MultipleEntry.html" target="_top"><B>FRAMES</B></A> 236 <A HREF="MultipleEntry.html" target="_top"><B>NO FRAMES</B></A> 237 <SCRIPT type="text/javascript"> 238 <!-- 239 if(window==top) { 240 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 241 } 242 //--> 243</SCRIPT> 244<NOSCRIPT> 245 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 246</NOSCRIPT> 247 248 249</FONT></TD> 250</TR> 251<TR> 252<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 253 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 254<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 255DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 256</TR> 257</TABLE> 258<A NAME="skip-navbar_bottom"></A> 259<!-- ======== END OF BOTTOM NAVBAR ======= --> 260 261<HR> 262<font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 263</BODY> 264</HTML> 265
