com.sleepycat.client

Class SMultiplePairs

java.lang.Object

com.sleepycat.client.SMultiplePairs

All Implemented Interfaces:

SDatabaseEntryBase

Direct Known Subclasses:

SMultipleKeyDataEntry, SMultipleRecnoDataEntry

public abstract class SMultiplePairs
extends java.lang.Object
implements SDatabaseEntryBase

An abstract class representing a container that holds multiple key/data SDatabaseEntry pairs. Use one of the concrete subclasses depending on whether you need:

• multiple key / data item pairs: SMultipleKeyDataEntry
• multiple record number / data item pairs: SMultipleRecnoDataEntry

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SMultiplePairs()

Method Summary

Modifier and Type	Method and Description
protected void	append(SDatabaseEntry key, SDatabaseEntry data)
int	getBatchSize() Return the amount of data to be returned in a single get() call.
boolean	next(SDatabaseEntry key, SDatabaseEntry data) Get the next key/data pair in the returned set.
void	setBatchSize(int batchSize) When used as an output argument to a database or cursor get() call, set the amount of data (in total bytes) to be returned.

Methods inherited from class java.lang.Object

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

Constructor Detail

SMultiplePairs

protected SMultiplePairs()

Method Detail

append

protected void append(SDatabaseEntry key,
                      SDatabaseEntry data)

getBatchSize

public int getBatchSize()

Return the amount of data to be returned in a single get() call.

Returns:

the amount of data to be returned in a single get() call.

setBatchSize

public void setBatchSize(int batchSize)

When used as an output argument to a database or cursor get() call, set the amount of data (in total bytes) to be returned.

This method is only advisory. The exact amount of data returned may be more or less than the amount specified.

Parameters:

batchSize - the amount of data to be returned in a single get() call

next

public boolean next(SDatabaseEntry key,
                    SDatabaseEntry data)

Get the next key/data pair in the returned set. This method may only be called after a successful call to a SDatabase or SCursor get method with this object as the data parameter.

When used with the Queue and Recno access methods, data.getData() will return null for deleted records

Parameters:

key - an entry that is set to refer to the next key element in the returned set

data - an entry that is set to refer to the next data element in the returned set

Returns:

indicates whether a value was found. A return of false indicates that the end of the set was reached.