com.basho.riak.client.api.commands.search

Class Search.Builder

java.lang.Object

com.basho.riak.client.api.commands.search.Search.Builder

Enclosing class:

Search

public static class Search.Builder
extends Object

Builder for a Search command.

Constructor Summary

Constructors

Constructor and Description
Builder(String index, String query) Construct a Builder for a Search command.

Method Summary

Modifier and Type	Method and Description
Search	build() Construct the Search command.
Search.Builder	filter(String query) Set a filter to use for this search.
Search.Builder	returnFields(Iterable<String> fields) Set the list of fields that should be returned for each record in the result set.
Search.Builder	returnFields(String... fields) Set the list of fields that should be returned for each record in the result set.
Search.Builder	sort(String field) Set a field to sort the results on.
<T> Search.Builder	withOption(Search.Option<T> option, T value) Add an optional setting for this command.
Search.Builder	withPresort(Search.Presort presort) Set the presort option, you may presort the results by Key or Score.
Search.Builder	withRows(int rows) Set the maximum number of rows to return.
Search.Builder	withStart(int start) Set the starting row to return.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String index,
               String query)

Construct a Builder for a Search command.

Parameters:

index - The index to search.

query - The query to execute against the index.

Method Detail

withPresort

public Search.Builder withPresort(Search.Presort presort)

Set the presort option, you may presort the results by Key or Score.

Parameters:

presort - the Search.Presort option to set.

Returns:

a reference to this object.

withStart

public Search.Builder withStart(int start)

Set the starting row to return.

Parameters:

start - the first row to return out of the result set. Use in conjunction with withRows(int) to paginate the results.

Returns:

a reference to this object.

withRows

public Search.Builder withRows(int rows)

Set the maximum number of rows to return.

Parameters:

rows - The total number of rows to return. Use in conjunction with withStart(int) to paginate the results.

Returns:

a reference to this object.

withOption

public <T> Search.Builder withOption(Search.Option<T> option,
                                     T value)

Add an optional setting for this command. This will be passed along with the request to Riak to tell it how to behave when servicing the request.

Parameters:

option - the option.

value - the value for the option.

Returns:

a reference to this object.

filter

public Search.Builder filter(String query)

Set a filter to use for this search.

Parameters:

query - the query string to filter the search with.

Returns:

a reference to this object.

sort

public Search.Builder sort(String field)

Set a field to sort the results on.

Parameters:

field - the field to sort the results with.

Returns:

a reference to this object.

returnFields

public Search.Builder returnFields(Iterable<String> fields)

Set the list of fields that should be returned for each record in the result set.

Parameters:

fields - the collection of fields to return with each result.

Returns:

a reference to this object.

returnFields

public Search.Builder returnFields(String... fields)

Set the list of fields that should be returned for each record in the result set.

Parameters:

fields - the varargs list of fields to return with each result.

Returns:

a reference to this object.

build

public Search build()

Construct the Search command.

Returns:

the new Search command.