com.cloudant.client.api.views

Class ViewRequestBuilder

java.lang.Object

com.cloudant.client.api.views.ViewRequestBuilder

public class ViewRequestBuilder
extends java.lang.Object

Provides methods for obtaining builders for view requests.

The database, design document and view are specified when this class is instantiated.

A view request builder instance should be obtained from a call to Database.getViewRequestBuilder(String, String).

Constructor Summary

Constructors

Constructor and Description
ViewRequestBuilder(CloudantClient client, Database database, java.lang.String designDoc, java.lang.String viewName) Create a new ViewRequestBuilder for the specified database, design document and view name.

Method Summary

Modifier and Type	Method and Description
<K,V> MultipleRequestBuilder<K,V>	newMultipleRequest(Key.Type<K> keyType, java.lang.Class<V> valueType) Create a new builder for multiple unpaginated requests on the view.
<K,V> PaginatedRequestBuilder<K,V>	newPaginatedRequest(Key.Type<K> keyType, java.lang.Class<V> valueType) Create a new builder for a paginated request on the view.
<K,V> UnpaginatedRequestBuilder<K,V>	newRequest(Key.Type<K> keyType, java.lang.Class<V> valueType) Create a new builder for an unpaginated request on the view.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewRequestBuilder

public ViewRequestBuilder(CloudantClient client,
                          Database database,
                          java.lang.String designDoc,
                          java.lang.String viewName)

Create a new ViewRequestBuilder for the specified database, design document and view name.

Rather than calling this constructor directly a view request builder instance should be obtained from a call to Database.getViewRequestBuilder(String, String).

Parameters:

client - the cloudant client

database - the database

designDoc - the design doc containing the view (optionally prefixed with "_design/")

viewName - the view to build a query request for

Method Detail

newRequest

public <K,V> UnpaginatedRequestBuilder<K,V> newRequest(Key.Type<K> keyType,
                                                       java.lang.Class<V> valueType)

Create a new builder for an unpaginated request on the view.

Note that the maximum number of rows returnable in an unpaginated request is Integer.MAX_VALUE. If you need to return more results than this then use newPaginatedRequest(Key.Type, Class) to spread the rows across multiple pages.

Type Parameters:

K - type of key emitted by the view

V - type of value emitted by the view

Parameters:

keyType - Key.Type of the key emitted by the view

valueType - class of the type of value emitted by the view

Returns:

a new UnpaginatedRequestBuilder for the database view specified by this ViewRequestBuilder

newPaginatedRequest

public <K,V> PaginatedRequestBuilder<K,V> newPaginatedRequest(Key.Type<K> keyType,
                                                              java.lang.Class<V> valueType)

Create a new builder for a paginated request on the view.

Defaults to 20 rows per page if not specified by SettableViewParameters.Paginated.rowsPerPage(int)

Type Parameters:

K - type of key emitted by the view

V - type of value emitted by the view

Parameters:

keyType - Key.Type of the key emitted by the view

valueType - class of the type of value emitted by the view

Returns:

a new PaginatedRequestBuilder for the database view specified by this ViewRequestBuilder

newMultipleRequest

public <K,V> MultipleRequestBuilder<K,V> newMultipleRequest(Key.Type<K> keyType,
                                                            java.lang.Class<V> valueType)

Create a new builder for multiple unpaginated requests on the view.

Type Parameters:

K - type of key emitted by the view

V - type of value emitted by the view

Parameters:

keyType - Key.Type of the key emitted by the view

valueType - class of the type of value emitted by the view

Returns:

a new MultipleRequestBuilder for the database view specified by this ViewRequestBuilder