com.basho.riak.client.api.commands.indexes

Class SecondaryIndexQuery.Response<T,E extends SecondaryIndexQuery.Response.Entry<T>>

java.lang.Object

com.basho.riak.client.api.StreamableRiakCommand.StreamableResponse<E,SecondaryIndexQueryOperation.Response.Entry>

com.basho.riak.client.api.commands.indexes.SecondaryIndexQuery.Response<T,E>

Type Parameters:

T - The type contained in the resposne.

All Implemented Interfaces:

Iterable<E>

Direct Known Subclasses:

BigIntIndexQuery.Response, BinIndexQuery.Response, FullBucketRead.Response, IntIndexQuery.Response, RawIndexQuery.Response

Enclosing class:

SecondaryIndexQuery<T,S extends SecondaryIndexQuery.Response<T,?>,U extends SecondaryIndexQuery>

public static class SecondaryIndexQuery.Response<T,E extends SecondaryIndexQuery.Response.Entry<T>>
extends StreamableRiakCommand.StreamableResponse<E,SecondaryIndexQueryOperation.Response.Entry>

Base class for all 2i responses.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecondaryIndexQuery.Response.Entry<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected SecondaryIndexQuery.IndexConverter<T>	converter
protected SecondaryIndexQueryOperation.Response	coreResponse
protected Namespace	queryLocation

Fields inherited from class com.basho.riak.client.api.StreamableRiakCommand.StreamableResponse

chunkedResponseIterator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Response(Namespace queryLocation, SecondaryIndexQuery.IndexConverter<T> converter, int timeout, StreamingRiakFuture<SecondaryIndexQueryOperation.Response,SecondaryIndexQueryOperation.Query> coreFuture)
protected	Response(Namespace queryLocation, SecondaryIndexQueryOperation.Response coreResponse, SecondaryIndexQuery.IndexConverter<T> converter)

Method Summary

Modifier and Type	Method and Description
protected E	createEntry(Location location, SecondaryIndexQueryOperation.Response.Entry coreEntry, SecondaryIndexQuery.IndexConverter<T> converter)
protected E	createEntry(Namespace namespace, SecondaryIndexQueryOperation.Response.Entry coreEntry, SecondaryIndexQuery.IndexConverter<T> converter)
BinaryValue	getContinuation() Get the continuation from this response.
List<E>	getEntries() Get a list of the result entries for this response.
boolean	hasContinuation() Check if this response has a continuation.
boolean	hasEntries() Check is this response contains any entries.
Iterator<E>	iterator() Get an iterator over the result data.

Methods inherited from class com.basho.riak.client.api.StreamableRiakCommand.StreamableResponse

isStreaming

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

converter

protected final SecondaryIndexQuery.IndexConverter<T> converter

coreResponse

protected final SecondaryIndexQueryOperation.Response coreResponse

queryLocation

protected final Namespace queryLocation

Constructor Detail

Response

protected Response(Namespace queryLocation,
                   SecondaryIndexQuery.IndexConverter<T> converter,
                   int timeout,
                   StreamingRiakFuture<SecondaryIndexQueryOperation.Response,SecondaryIndexQueryOperation.Query> coreFuture)

Response

protected Response(Namespace queryLocation,
                   SecondaryIndexQueryOperation.Response coreResponse,
                   SecondaryIndexQuery.IndexConverter<T> converter)

Method Detail

iterator

public Iterator<E> iterator()

Get an iterator over the result data. If using the streaming API, this method will block and wait for more data if none is immediately available. It is also advisable to check Thread.isInterrupted() in environments where thread interrupts must be obeyed.

Specified by:

iterator in interface Iterable<E extends SecondaryIndexQuery.Response.Entry<T>>

Overrides:

iterator in class StreamableRiakCommand.StreamableResponse<E extends SecondaryIndexQuery.Response.Entry<T>,SecondaryIndexQueryOperation.Response.Entry>

Returns:

an iterator over the result data.

hasContinuation

public boolean hasContinuation()

Check if this response has a continuation. If using the streaming API, this property's value may change while data is being received, therefore it is best to call it after the operation is complete.

Returns:

true if the response contains a continuation.

getContinuation

public BinaryValue getContinuation()

Get the continuation from this response. If using the streaming API, this property's value may change while data is being received, therefore it is best to call it after the operation is complete.

Returns:

the continuation, or null if none is present.

hasEntries

public boolean hasEntries()

Check is this response contains any entries. If using the streaming API, this method will block and wait for more data if none is immediately available. It is also advisable to check Thread.isInterrupted() in environments where thread interrupts must be obeyed.

Returns:

true if entries are present, false otherwise.

getEntries

public final List<E> getEntries()

Get a list of the result entries for this response.

Returns:

A list of result entries.

Throws:

IllegalStateException - when called while using the streaming API.

createEntry

protected E createEntry(Location location,
                        SecondaryIndexQueryOperation.Response.Entry coreEntry,
                        SecondaryIndexQuery.IndexConverter<T> converter)

createEntry

protected final E createEntry(Namespace namespace,
                              SecondaryIndexQueryOperation.Response.Entry coreEntry,
                              SecondaryIndexQuery.IndexConverter<T> converter)