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

Class SecondaryIndexQuery.Init<S,T extends SecondaryIndexQuery.Init<S,T>>

java.lang.Object

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

Direct Known Subclasses:

BigIntIndexQuery.Init, BinIndexQuery.Init, IntIndexQuery.Init, KeyIndexQuery.Builder, RawIndexQuery.Builder

Enclosing class:

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

public abstract static class SecondaryIndexQuery.Init<S,T extends SecondaryIndexQuery.Init<S,T>>
extends Object

Constructor Summary

Constructors

Constructor and Description
Init(Namespace namespace, String indexName, byte[] coverageContext) Build a cover query.
Init(Namespace namespace, String indexName, S match) Build a match query.
Init(Namespace namespace, String indexName, S start, S end) Build a range query.

Method Summary

Modifier and Type	Method and Description
protected abstract T	self()
T	withContinuation(BinaryValue continuation) Set the continuation for this query.
T	withCoverageContext(byte[] coverageContext) Set the cover context for the local read
T	withKeyAndIndex(boolean returnBoth) Set whether to return the index keys with the Riak object keys.
T	withMaxResults(Integer maxResults) Set the maximum number of results returned by the query.
T	withPaginationSort(boolean orderByKey) Set whether to sort the results of a non-paginated 2i query.
T	withRegexTermFilter(String filter) Set the regex to filter result terms by for this query.
protected T	withReturnBody(boolean returnBody) Set whether to return the object values with the Riak object keys.
T	withTimeout(int timeout) Set the Riak-side timeout value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Init

public Init(Namespace namespace,
            String indexName,
            S start,
            S end)

Build a range query.

Returns all objects in Riak that have an index value in the specified range.

Parameters:

namespace - the namespace for this query.

indexName - the indexname

start - the start index value

end - the end index value

Init

public Init(Namespace namespace,
            String indexName,
            S match)

Build a match query.

Returns all objects in Riak that have an index value matching the one supplied.

Parameters:

namespace - the namespace for this query

indexName - the index name

match - the index value.

Init

public Init(Namespace namespace,
            String indexName,
            byte[] coverageContext)

Build a cover query.

Returns all objects in Riak related to the provided coverageContext.

Parameters:

namespace - the namespace for this query

indexName - the index name

coverageContext - the cover context. An opaque binary received from coverage context entry to be sent back to Riak for receiving appropriate data.

Method Detail

self

protected abstract T self()

withContinuation

public T withContinuation(BinaryValue continuation)

Set the continuation for this query.

The continuation is returned by a previous paginated query.

Parameters:

continuation -

Returns:

a reference to this object.

withMaxResults

public T withMaxResults(Integer maxResults)

Set the maximum number of results returned by the query.

Parameters:

maxResults - the number of results.

Returns:

a reference to this object.

withKeyAndIndex

public T withKeyAndIndex(boolean returnBoth)

Set whether to return the index keys with the Riak object keys. Setting this to true will return both the index key and the Riak object's key. The default is false (only to return the Riak object keys).

Parameters:

returnBoth - true to return both index and object keys, false to return only object keys.

Returns:

a reference to this object.

withPaginationSort

public T withPaginationSort(boolean orderByKey)

Set whether to sort the results of a non-paginated 2i query.

Setting this to true will sort the results in Riak before returning them.

Note that this is not recommended for queries that could return a large result set; the overhead in Riak is substantial.

Parameters:

orderByKey - true to sort the results, false to return as-is.

Returns:

a reference to this object.

withRegexTermFilter

public T withRegexTermFilter(String filter)

Set the regex to filter result terms by for this query.

Parameters:

filter - the regex to filter terms by.

Returns:

a reference to this object.

withTimeout

public T withTimeout(int timeout)

Set the Riak-side timeout value.

By default, riak has a 60s timeout for operations. Setting this value will override that default for both the fetch and store operation.

Parameters:

timeout - the timeout in milliseconds

Returns:

a reference to this object.

withCoverageContext

public T withCoverageContext(byte[] coverageContext)

Set the cover context for the local read

Parameters:

coverageContext - the cover context. An opaque binary received from coverage context entry to be sent back to Riak for receiving appropriate data.

Returns:

a reference to this object.

withReturnBody

protected T withReturnBody(boolean returnBody)

Set whether to return the object values with the Riak object keys. It has protected access since, due to performance reasons, it might be used only for the Full Bucket Read

Parameters:

returnBody -

Returns:

a reference to this object.