com.cloudant.client.api.model

Class FindByIndexOptions

java.lang.Object

com.cloudant.client.api.model.FindByIndexOptions

public class FindByIndexOptions
extends java.lang.Object

Options to set on findByIndex() request.

Example:

 database.findByIndex(
           " \"selector\": { \"Movie_year\": {\"$gt\": 1960}, \"Person_name\": \"Alec Guinness\" }"
                Movie.class,
                new FindByIndexOptions()
 .sort(new IndexField("Movie_year", SortOrder.desc))
 .fields("Movie_name").fields("Movie_year")
 .limit(1)
 .skip(1)
 .readQuorum(2));
 

Since:

0.0.1

See Also:

Database.findByIndex(String, Class, FindByIndexOptions)

Constructor Summary

Constructors

Constructor and Description
FindByIndexOptions()

Method Summary

Modifier and Type	Method and Description
FindByIndexOptions	fields(java.lang.String field) Can be called multiple times to set the list of return fields
java.util.List<java.lang.String>	getFields()
java.lang.Integer	getLimit()
java.lang.Integer	getReadQuorum()
java.lang.Integer	getSkip()
java.util.List<IndexField>	getSort()
java.lang.String	getUseIndex()
FindByIndexOptions	limit(java.lang.Integer limit)
FindByIndexOptions	readQuorum(java.lang.Integer readQuorum)
FindByIndexOptions	skip(java.lang.Integer skip)
FindByIndexOptions	sort(IndexField sort) Can be called multiple times to set the sort syntax
FindByIndexOptions	useIndex(java.lang.String designDocument) Specify a specific index to run the query against
FindByIndexOptions	useIndex(java.lang.String designDocument, java.lang.String indexName) Specify a specific index to run the query against

Methods inherited from class java.lang.Object

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

Constructor Detail

FindByIndexOptions

public FindByIndexOptions()

Method Detail

limit

public FindByIndexOptions limit(java.lang.Integer limit)

Parameters:

limit - limit the number of results return

Returns:

this to set additional options

skip

public FindByIndexOptions skip(java.lang.Integer skip)

Parameters:

skip - Skips n number of results.

Returns:

this to set additional options

readQuorum

public FindByIndexOptions readQuorum(java.lang.Integer readQuorum)

Parameters:

readQuorum - set the readQuorum

Returns:

this to set additional options

sort

public FindByIndexOptions sort(IndexField sort)

Can be called multiple times to set the sort syntax

Parameters:

sort - add a sort syntax field

Returns:

this to set additional options

fields

public FindByIndexOptions fields(java.lang.String field)

Can be called multiple times to set the list of return fields

Parameters:

field - set the return fields

Returns:

this to set additional options

useIndex

public FindByIndexOptions useIndex(java.lang.String designDocument)

Specify a specific index to run the query against

Parameters:

designDocument - set the design document to use

Returns:

this to set additional options

useIndex

public FindByIndexOptions useIndex(java.lang.String designDocument,
                                   java.lang.String indexName)

Specify a specific index to run the query against

Parameters:

designDocument - set the design document to use

indexName - set the index name to use

Returns:

this to set additional options

getFields

public java.util.List<java.lang.String> getFields()

getSort

public java.util.List<IndexField> getSort()

getLimit

public java.lang.Integer getLimit()

getSkip

public java.lang.Integer getSkip()

getReadQuorum

public java.lang.Integer getReadQuorum()

getUseIndex

public java.lang.String getUseIndex()