com.cloudant.client.api.views

Interface PaginatedRequestBuilder<K,V>

Type Parameters:

K - the type of key emitted by the view,fixed by the Key.Typesupplied to the ViewRequestBuilder

V - the type of value emitted by the view,specified when supplied to the ViewRequestBuilder

All Superinterfaces:

RequestBuilder<PaginatedRequestBuilder<K,V>>, SettableViewParameters.Common<K,PaginatedRequestBuilder<K,V>>, SettableViewParameters.Paginated<K,PaginatedRequestBuilder<K,V>>, SettableViewParameters.Reduceable<K,PaginatedRequestBuilder<K,V>>, SingleRequestBuilder<K,V,PaginatedRequestBuilder<K,V>>

public interface PaginatedRequestBuilder<K,V>
extends SingleRequestBuilder<K,V,PaginatedRequestBuilder<K,V>>, SettableViewParameters.Paginated<K,PaginatedRequestBuilder<K,V>>, SettableViewParameters.Reduceable<K,PaginatedRequestBuilder<K,V>>

Interface for building a paginated ViewRequest.

Example usage:

 

 ViewRequest<String, String> paginatedRequest =
 //get a builder for the "foo" view of the "example" design doc
 db.getViewRequestBuilder("example","foo")

      //create a new paginated request expecting String keys and values
      .newPaginatedRequest(Key.Type.STRING, String.class)

      //set the number of rows for each page
      .rowsPerPage(12)

      //set any other required parameters
      .startKey("bar")

      //build the paginated request
      .build();
 
 

Since:

2.0.0

Method Summary

Methods inherited from interface com.cloudant.client.api.views.SingleRequestBuilder

build

Methods inherited from interface com.cloudant.client.api.views.RequestBuilder

returnThis

Methods inherited from interface com.cloudant.client.api.views.SettableViewParameters.Paginated

rowsPerPage

Methods inherited from interface com.cloudant.client.api.views.SettableViewParameters.Common

descending, endKey, endKeyDocId, includeDocs, inclusiveEnd, keys, stale, startKey, startKeyDocId

Methods inherited from interface com.cloudant.client.api.views.SettableViewParameters.Reduceable

group, groupLevel, reduce