com.sleepycat.db
Class DbMultipleKeyDataIterator

java.lang.Object
  |
  +--com.sleepycat.db.DbMultipleIterator
        |
        +--com.sleepycat.db.DbMultipleKeyDataIterator

public class DbMultipleKeyDataIterator

extends com.sleepycat.db.DbMultipleIterator

The DbMultipleKeyDataIterator class is used to iterate through data returned using the Db.DB_MULTIPLE_KEY flag from a database belonging to the Btree or Hash access methods.

Constructor Summary

DbMultipleKeyDataIterator(Dbt dbt)
The constructor takes the data Dbt returned by the call to Db.get or Dbc.get that used the Db.DB_MULTIPLE_KEY flag.

Method Summary

boolean

next(Dbt key, Dbt data) The DbMultipleKeyDataIterator.next method takes two Dbts, 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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DbMultipleKeyDataIterator

public DbMultipleKeyDataIterator(Dbt dbt)

The constructor takes the data Dbt returned by the call to Db.get or Dbc.get that used the Db.DB_MULTIPLE_KEY flag.

Parameters:

dbt - a data Dbt returned by the call to Db.get or Dbc.get that used the Db.DB_MULTIPLE_KEY flag.

Method Detail

next

public boolean next(Dbt key,
                    Dbt data)

The DbMultipleKeyDataIterator.next method takes two Dbts, 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.

Parameters:

key - The key 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.

data - The data 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.

Returns:

The DbMultipleKeyDataIterator.next method returns false if no more data are available, and true otherwise.