com.aerospike.client.query

Class RecordSet

java.lang.Object

com.aerospike.client.query.RecordSet

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<com.aerospike.client.query.KeyRecord>

public final class RecordSet
extends Object
implements Iterable<com.aerospike.client.query.KeyRecord>, Closeable

This class manages record retrieval from queries. Multiple threads will retrieve records from the server nodes and put these records on the queue. The single user thread consumes these records from the queue.

Field Summary

Fields

Modifier and Type	Field and Description
static com.aerospike.client.query.KeyRecord	END

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close query.
Key	getKey() Get record's unique identifier.
Record	getRecord() Get record's header and bin data.
Iterator<com.aerospike.client.query.KeyRecord>	iterator() Provide Iterator for RecordSet.
boolean	next() Retrieve next record.

Methods inherited from class java.lang.Object

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

Field Detail

END

public static final com.aerospike.client.query.KeyRecord END

Method Detail

next

public final boolean next()
                   throws AerospikeException

Retrieve next record. This method will block until a record is retrieved or the query is cancelled.

Returns:

whether record exists - if false, no more records are available

Throws:

AerospikeException

close

public final void close()

Close query.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

iterator

public Iterator<com.aerospike.client.query.KeyRecord> iterator()

Provide Iterator for RecordSet.

Specified by:

iterator in interface Iterable<com.aerospike.client.query.KeyRecord>

getKey

public final Key getKey()

Get record's unique identifier.

getRecord

public final Record getRecord()

Get record's header and bin data.