org.apache.xindice.core.data
Interface RecordSet

All Known Implementing Classes:

EmptyRecordSet

public interface RecordSet

RecordSet is an interface for iterating over a set of Records. It is almost always returned by Filers.

Version:

$Revision: 511426 $, $Date: 2007-02-24 22:25:02 -0500 (Sat, 24 Feb 2007) $

Method Summary

Key	getNextKey() getNextKey returns the next Record's Key, and skips the RecordSet ahead to the next Record.
Record	getNextRecord() getNextRecord returns the next Record in the set.
Value	getNextValue() getNextValue returns the next Record's Value, and skips the RecordSet ahead to the next Record.
boolean	hasMoreRecords() hasMoreRecords returns whether or not there are any Records left in the set.

Method Detail

hasMoreRecords

public boolean hasMoreRecords()
                       throws DBException

hasMoreRecords returns whether or not there are any Records left in the set.

Returns:

Whether there are any more Records

getNextRecord

public Record getNextRecord()
                     throws DBException

getNextRecord returns the next Record in the set.

Returns:

The next Record

getNextKey

public Key getNextKey()
               throws DBException

getNextKey returns the next Record's Key, and skips the RecordSet ahead to the next Record.

Returns:

The next Key

getNextValue

public Value getNextValue()
                   throws DBException

getNextValue returns the next Record's Value, and skips the RecordSet ahead to the next Record.

Returns:

The next Value