com.basho.riak.client.query.indexes

Class FetchIndex<T>

java.lang.Object

com.basho.riak.client.query.indexes.FetchIndex<T>

Type Parameters:

T -

All Implemented Interfaces:

RiakOperation<List<String>>

public class FetchIndex<T>
extends Object
implements RiakOperation<List<String>>

Author:

russell

Field Summary

Fields

Modifier and Type	Field and Description
protected String	continuation
protected T	from
protected RiakIndex<T>	index
protected Integer	maxResults
protected boolean	returnTerms
protected T	to
protected T	value

Constructor Summary

Constructors

Constructor and Description
FetchIndex(RawClient client, String bucket, RiakIndex<T> index, Retrier retrier)

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	execute()
StreamingOperation<IndexEntry>	executeStreaming() Performs an index query as a streaming operation from Riak Note that you must call StreamingOperation.cancel() on the returned StreamingOperation if you do not iterate through the entire result set.
FetchIndex<T>	from(T from)
FetchIndex<T>	maxResults(int maxResults) Pagination support for 2i queries.
FetchIndex<T>	returnKeyAndIndexValue(boolean returnBoth) Return both the object keys and the index values * This is only available in v1.4+ of Riak and only via streaming
FetchIndex<T>	to(T to)
FetchIndex<T>	withContinuation(String continuation) Sets the continuation received with a previous call * * This is only available in v1.4+ of Riak and only via streaming
FetchIndex<T>	withValue(T value)

Methods inherited from class java.lang.Object

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

Field Detail

index

protected final RiakIndex<T> index

value

protected T value

from

protected T from

to

protected T to

returnTerms

protected boolean returnTerms

maxResults

protected Integer maxResults

continuation

protected String continuation

Constructor Detail

FetchIndex

public FetchIndex(RawClient client,
          String bucket,
          RiakIndex<T> index,
          Retrier retrier)

Parameters:

index -

Method Detail

execute

public List<String> execute()
                     throws RiakException

Specified by:

execute in interface RiakOperation<List<String>>

Throws:

RiakException

executeStreaming

public StreamingOperation<IndexEntry> executeStreaming()
                                                throws RiakException

Performs an index query as a streaming operation from Riak Note that you must call StreamingOperation.cancel() on the returned StreamingOperation if you do not iterate through the entire result set. Note this is only available using Riak 1.4

Returns:

A StreamingOperation

Throws:

RiakException

withValue

public FetchIndex<T> withValue(T value)

from

public FetchIndex<T> from(T from)

to

public FetchIndex<T> to(T to)

maxResults

public FetchIndex<T> maxResults(int maxResults)

Pagination support for 2i queries. Will return maxResults entries starting at the lower range or the continuation returned from a previous query This is only available in v1.4+ of Riak and only via streaming

Parameters:

maxResults -

Returns:

this

See Also:

executeStreaming()

returnKeyAndIndexValue

public FetchIndex<T> returnKeyAndIndexValue(boolean returnBoth)

Return both the object keys and the index values * This is only available in v1.4+ of Riak and only via streaming

Parameters:

returnBoth -

Returns:

this

See Also:

executeStreaming()

withContinuation

public FetchIndex<T> withContinuation(String continuation)

Sets the continuation received with a previous call * * This is only available in v1.4+ of Riak and only via streaming

Parameters:

continuation -

Returns:

this

See Also:

executeStreaming(), StreamingOperation.getContinuation()