Sophie

Sophie

distrib > Mandriva > cooker > x86_64 > by-pkgid > d1d568934909030644561e00a0d5581d > files > 140

db4.2-javadoc-4.2.52-30mdv2011.0.x86_64.rpm

<!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_18) on Thu Dec 02 16:59:42 UTC 2010 -->
<TITLE>
DbMultipleKeyDataIterator
</TITLE>

<META NAME="date" CONTENT="2010-12-02">

<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="DbMultipleKeyDataIterator";
    }
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">
<HR>


<!-- ========= 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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../com/sleepycat/db/DbMultipleDataIterator.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../com/sleepycat/db/DbMultipleRecnoDataIterator.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/DbMultipleKeyDataIterator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="DbMultipleKeyDataIterator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sleepycat.db</FONT>
<BR>
Class DbMultipleKeyDataIterator</H2>
<PRE>
java.lang.Object
  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.DbMultipleKeyDataIterator</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>DbMultipleKeyDataIterator</B><DT>extends java.lang.Object</DL>
</PRE>

<P>
The DbMultipleKeyDataIterator class is used to iterate through
  data returned using the <A HREF="../../../com/sleepycat/db/Db.html#DB_MULTIPLE_KEY"><CODE>Db.DB_MULTIPLE_KEY</CODE></A> flag from a database belonging to the Btree or
  Hash access methods.</p>
<P>

<P>
<HR>

<P>

<!-- ======== 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/DbMultipleKeyDataIterator.html#DbMultipleKeyDataIterator(com.sleepycat.db.Dbt)">DbMultipleKeyDataIterator</A></B>(<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A>&nbsp;dbt)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The constructor takes the data <A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db"><CODE>Dbt</CODE></A> returned by the call to <A HREF="../../../com/sleepycat/db/Db.html#get(com.sleepycat.db.DbTxn, com.sleepycat.db.Dbt, com.sleepycat.db.Dbt, int)"><CODE>Db.get</CODE></A> or <A HREF="../../../com/sleepycat/db/Dbc.html#get(com.sleepycat.db.Dbt, com.sleepycat.db.Dbt, int)"><CODE>Dbc.get</CODE></A> that used
  the <A HREF="../../../com/sleepycat/db/Db.html#DB_MULTIPLE_KEY"><CODE>Db.DB_MULTIPLE_KEY</CODE></A> flag.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/DbMultipleKeyDataIterator.html#next(com.sleepycat.db.Dbt, com.sleepycat.db.Dbt)">next</A></B>(<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A>&nbsp;key,
     <A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A>&nbsp;data)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The DbMultipleKeyDataIterator.next method takes two <A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db"><CODE>Dbt</CODE></A>s, one for a key and one for a data
  item, that will each be filled in with a reference to a
  buffer, a size, and an offset that together yield the next key
  and data item in the original bulk retrieval buffer.</TD>
</TR>
</TABLE>
&nbsp;<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.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ========= 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="DbMultipleKeyDataIterator(com.sleepycat.db.Dbt)"><!-- --></A><H3>
DbMultipleKeyDataIterator</H3>
<PRE>
public <B>DbMultipleKeyDataIterator</B>(<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A>&nbsp;dbt)</PRE>
<DL>
<DD>The constructor takes the data <A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db"><CODE>Dbt</CODE></A> returned by the call to <A HREF="../../../com/sleepycat/db/Db.html#get(com.sleepycat.db.DbTxn, com.sleepycat.db.Dbt, com.sleepycat.db.Dbt, int)"><CODE>Db.get</CODE></A> or <A HREF="../../../com/sleepycat/db/Dbc.html#get(com.sleepycat.db.Dbt, com.sleepycat.db.Dbt, int)"><CODE>Dbc.get</CODE></A> that used
  the <A HREF="../../../com/sleepycat/db/Db.html#DB_MULTIPLE_KEY"><CODE>Db.DB_MULTIPLE_KEY</CODE></A> flag.</p>
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>dbt</CODE> - a data <A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db"><CODE>Dbt</CODE></A> returned
      by the call to <A HREF="../../../com/sleepycat/db/Db.html#get(com.sleepycat.db.DbTxn, com.sleepycat.db.Dbt, com.sleepycat.db.Dbt, int)"><CODE>Db.get</CODE></A> or
      <A HREF="../../../com/sleepycat/db/Dbc.html#get(com.sleepycat.db.Dbt, com.sleepycat.db.Dbt, int)"><CODE>Dbc.get</CODE></A> that used the
      <A HREF="../../../com/sleepycat/db/Db.html#DB_MULTIPLE_KEY"><CODE>Db.DB_MULTIPLE_KEY</CODE></A> flag.</DL>
</DL>

<!-- ============ 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="next(com.sleepycat.db.Dbt, com.sleepycat.db.Dbt)"><!-- --></A><H3>
next</H3>
<PRE>
public boolean <B>next</B>(<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A>&nbsp;key,
                    <A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A>&nbsp;data)</PRE>
<DL>
<DD>The DbMultipleKeyDataIterator.next method takes two <A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db"><CODE>Dbt</CODE></A>s, one for a key and one for a data
  item, that will each be filled in with a reference to a
  buffer, a size, and an offset that together yield the next key
  and data item in the original bulk retrieval buffer. The
  DbMultipleKeyDataIterator.next method returns false if no more
  data are available, and true otherwise.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - The <b>key</b> parameter will be filled in with a
      reference to a buffer, a size, and an offset that yields
      the next key item in the original bulk retrieval buffer.<DD><CODE>data</CODE> - The <b>data</b> parameter will be filled in with
      a reference to a buffer, a size, and an offset that yields
      the next data item in the original bulk retrieval buffer.
<DT><B>Returns:</B><DD>The DbMultipleKeyDataIterator.next method returns
      false if no more data are available, and true otherwise.
      </p></DL>
</DD>
</DL>
<!-- ========= 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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../com/sleepycat/db/DbMultipleDataIterator.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../com/sleepycat/db/DbMultipleRecnoDataIterator.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/DbMultipleKeyDataIterator.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="DbMultipleKeyDataIterator.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>