com.basho.riak.client.core.operations

Class SearchOperation.Builder

java.lang.Object

com.basho.riak.client.core.operations.SearchOperation.Builder

Enclosing class:

SearchOperation

public static class SearchOperation.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
SearchOperation.Builder(BinaryValue indexName, String queryString)

Method Summary

Methods

Modifier and Type	Method and Description
SearchOperation	build()
SearchOperation.Builder	withDefaultField(String fieldName) Use the provided field as the default.
SearchOperation.Builder	withDefaultOperation(String op) Set the default operation.
SearchOperation.Builder	withFilterQuery(String filterQuery) Filters the search by an additional query scoped to inline fields.
SearchOperation.Builder	withNumRows(int rows) Specify the maximum number of results to return.
SearchOperation.Builder	withPresort(String presort) Sorts all of the results by bucket key, or the search score, before the given rows are chosen.
SearchOperation.Builder	withReturnFields(List<String> fields) Only return the provided fields.
SearchOperation.Builder	withSortField(String fieldName) Sort the results on the specified field name.
SearchOperation.Builder	withStart(int start) Specify the starting result of the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchOperation.Builder

public SearchOperation.Builder(BinaryValue indexName,
                       String queryString)

Method Detail

withNumRows

public SearchOperation.Builder withNumRows(int rows)

Specify the maximum number of results to return. Riak defaults to 10 if this is not asSet.

Parameters:

rows - the maximum number of results to return.

Returns:

a reference to this object.

withStart

public SearchOperation.Builder withStart(int start)

Specify the starting result of the query. Useful for pagination. The default is 0.

Parameters:

start - the index of the starting result.

Returns:

a reference to this object.

withSortField

public SearchOperation.Builder withSortField(String fieldName)

Sort the results on the specified field name. Default is “none”, which causes the results to be sorted in descending order by score.

Parameters:

fieldName - the fieldname to sort the results on.

Returns:

a reference to this object.

withFilterQuery

public SearchOperation.Builder withFilterQuery(String filterQuery)

Filters the search by an additional query scoped to inline fields.

Parameters:

filterQuery - the filter query.

Returns:

a reference to this object.

withDefaultField

public SearchOperation.Builder withDefaultField(String fieldName)

Use the provided field as the default. Overrides the “default_field” setting in the schema file.

Parameters:

fieldName - the name of the field.

Returns:

a reference to this object.

withDefaultOperation

public SearchOperation.Builder withDefaultOperation(String op)

Set the default operation. Allowed settings are either “and” or “or”. Overrides the “default_op” setting in the schema file.

Parameters:

op - A string containing either "and" or "or".

Returns:

a reference to this object.

withReturnFields

public SearchOperation.Builder withReturnFields(List<String> fields)

Only return the provided fields. Filters the results to only contain the provided fields.

Parameters:

fields - a list of field names.

Returns:

a reference to this object.

withPresort

public SearchOperation.Builder withPresort(String presort)

Sorts all of the results by bucket key, or the search score, before the given rows are chosen. This is useful when paginating to ensure the results are returned in a consistent order.

Parameters:

presort - a String containing either "key" or "score".

Returns:

a reference to this object.

build

public SearchOperation build()