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

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

java.lang.Object

com.basho.riak.client.api.RiakCommand<R,I>

com.basho.riak.client.api.GenericRiakCommand<R,I,CoreR,CoreI>

com.basho.riak.client.api.StreamableRiakCommand<S,U,SecondaryIndexQueryOperation.Response,SecondaryIndexQueryOperation.Query>

com.basho.riak.client.api.commands.indexes.SecondaryIndexQuery<T,S,U>

Type Parameters:

S - the type being used for the query.

Direct Known Subclasses:

BigIntIndexQuery, BinIndexQuery, FullBucketRead, IntIndexQuery, RawIndexQuery

public abstract class SecondaryIndexQuery<T,S extends SecondaryIndexQuery.Response<T,?>,U extends SecondaryIndexQuery>
extends StreamableRiakCommand<S,U,SecondaryIndexQueryOperation.Response,SecondaryIndexQueryOperation.Query>

A Secondary Index Query.

Serves as a base class for all 2i queries.

Since:

2.0

Author:

Brian Roach , Alex Moore , Sergey Galkin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SecondaryIndexQuery.GatherableResponseCreator<T,R extends SecondaryIndexQuery.Response<T,?>>
protected static interface	SecondaryIndexQuery.IndexConverter<T>
static class	SecondaryIndexQuery.Init<S,T extends SecondaryIndexQuery.Init<S,T>>
static class	SecondaryIndexQuery.Response<T,E extends SecondaryIndexQuery.Response.Entry<T>> Base class for all 2i responses.
static interface	SecondaryIndexQuery.StreamableResponseCreator<T,R extends SecondaryIndexQuery.Response<T,?>>
static class	SecondaryIndexQuery.Type

Nested classes/interfaces inherited from class com.basho.riak.client.api.StreamableRiakCommand

StreamableRiakCommand.StreamableResponse<T,S>, StreamableRiakCommand.StreamableRiakCommandWithSameInfo<R extends StreamableRiakCommand.StreamableResponse,I,CoreR>

Nested classes/interfaces inherited from class com.basho.riak.client.api.GenericRiakCommand

GenericRiakCommand.GenericRiakCommandWithSameInfo<R,I,CoreR>

Field Summary

Fields

Modifier and Type	Field and Description
protected BinaryValue	continuation
protected byte[]	coverageContext
protected T	end
protected String	indexName
protected T	match
protected Integer	maxResults
protected Namespace	namespace
protected boolean	paginationSort
protected boolean	returnBody
protected boolean	returnTerms
protected T	start
protected String	termFilter
protected Integer	timeout

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SecondaryIndexQuery(SecondaryIndexQuery.Init<T,?> builder, SecondaryIndexQuery.StreamableResponseCreator<T,S> streamableCreator, SecondaryIndexQuery.GatherableResponseCreator<T,S> gatherableResponseCreator)

Method Summary

Modifier and Type	Method and Description
protected SecondaryIndexQueryOperation	buildCoreOperation(boolean streamResults)
protected U	convertInfo(SecondaryIndexQueryOperation.Query coreInfo)
protected S	convertResponse(FutureOperation<SecondaryIndexQueryOperation.Response,?,SecondaryIndexQueryOperation.Query> request, SecondaryIndexQueryOperation.Response coreResponse)
protected S	createResponse(int timeout, StreamingRiakFuture<SecondaryIndexQueryOperation.Response,SecondaryIndexQueryOperation.Query> coreFuture)
boolean	equals(Object o)
BinaryValue	getContinuation() Get the continuation supplied for this query.
protected abstract SecondaryIndexQuery.IndexConverter<T>	getConverter()
String	getIndexName() Get the full index name for this query.
T	getMatchValue() Get the match value supplied for this query.
Integer	getMaxResults() Get the max number of results for this query.
Namespace	getNamespace() Get the location for this query.
boolean	getPaginationSort() Get the pagination sort setting.
T	getRangeEnd() Get the range end value for this query.
T	getRangeStart() Get the range start value for this query.
boolean	getReturnKeyAndIndex() Get whether this query will return both index keys and object keys.
String	getTermFilter() Get the regex term filter for this query.
Integer	getTimeout() Get the timeout value for this query.
int	hashCode()
String	toString()

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

buildCoreOperation, executeAsyncStreaming

Methods inherited from class com.basho.riak.client.api.GenericRiakCommand

executeAsync

Methods inherited from class com.basho.riak.client.api.RiakCommand

execute, execute

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

namespace

protected final Namespace namespace

indexName

protected final String indexName

continuation

protected final BinaryValue continuation

match

protected final T match

start

protected final T start

end

protected final T end

maxResults

protected final Integer maxResults

returnTerms

protected final boolean returnTerms

paginationSort

protected final boolean paginationSort

termFilter

protected final String termFilter

timeout

protected Integer timeout

coverageContext

protected final byte[] coverageContext

returnBody

protected final boolean returnBody

Constructor Detail

SecondaryIndexQuery

protected SecondaryIndexQuery(SecondaryIndexQuery.Init<T,?> builder,
                              SecondaryIndexQuery.StreamableResponseCreator<T,S> streamableCreator,
                              SecondaryIndexQuery.GatherableResponseCreator<T,S> gatherableResponseCreator)

Method Detail

getConverter

protected abstract SecondaryIndexQuery.IndexConverter<T> getConverter()

getNamespace

public Namespace getNamespace()

Get the location for this query.

Returns:

the location encompassing a bucket and bucket type.

getIndexName

public String getIndexName()

Get the full index name for this query.

Returns:

the index name including Riak suffix.

getMatchValue

public T getMatchValue()

Get the match value supplied for this query.

Returns:

the single index key to match, or null if not present

getRangeStart

public T getRangeStart()

Get the range start value for this query.

Returns:

the range start, or null if not present.

getRangeEnd

public T getRangeEnd()

Get the range end value for this query.

Returns:

the range end value, or null if not present

getMaxResults

public Integer getMaxResults()

Get the max number of results for this query.

Returns:

the max number of results, or null if not present.

getReturnKeyAndIndex

public boolean getReturnKeyAndIndex()

Get whether this query will return both index keys and object keys.

Returns:

true if specified, false otherwise.

getPaginationSort

public boolean getPaginationSort()

Get the pagination sort setting.

Returns:

true if set, false otherwise.

getTermFilter

public String getTermFilter()

Get the regex term filter for this query.

Returns:

the filter, or null if not set.

getContinuation

public BinaryValue getContinuation()

Get the continuation supplied for this query.

Returns:

the continuation, or null if not set.

getTimeout

public Integer getTimeout()

Get the timeout value for this query.

Returns:

the timeout value, or null if not set.

buildCoreOperation

protected SecondaryIndexQueryOperation buildCoreOperation(boolean streamResults)

Specified by:

buildCoreOperation in class StreamableRiakCommand<S extends SecondaryIndexQuery.Response<T,?>,U extends SecondaryIndexQuery,SecondaryIndexQueryOperation.Response,SecondaryIndexQueryOperation.Query>

convertResponse

protected S convertResponse(FutureOperation<SecondaryIndexQueryOperation.Response,?,SecondaryIndexQueryOperation.Query> request,
                            SecondaryIndexQueryOperation.Response coreResponse)

Specified by:

convertResponse in class GenericRiakCommand<S extends SecondaryIndexQuery.Response<T,?>,U extends SecondaryIndexQuery,SecondaryIndexQueryOperation.Response,SecondaryIndexQueryOperation.Query>

convertInfo

protected U convertInfo(SecondaryIndexQueryOperation.Query coreInfo)

Specified by:

convertInfo in class GenericRiakCommand<S extends SecondaryIndexQuery.Response<T,?>,U extends SecondaryIndexQuery,SecondaryIndexQueryOperation.Response,SecondaryIndexQueryOperation.Query>

createResponse

protected S createResponse(int timeout,
                           StreamingRiakFuture<SecondaryIndexQueryOperation.Response,SecondaryIndexQueryOperation.Query> coreFuture)

Specified by:

createResponse in class StreamableRiakCommand<S extends SecondaryIndexQuery.Response<T,?>,U extends SecondaryIndexQuery,SecondaryIndexQueryOperation.Response,SecondaryIndexQueryOperation.Query>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object