com.cloudant.client.api.views

Interface MultipleRequestBuilder<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<MultipleRequestBuilder<K,V>>, SettableViewParameters.Common<K,MultipleRequestBuilder<K,V>>, SettableViewParameters.Unpaginated<K,MultipleRequestBuilder<K,V>>

public interface MultipleRequestBuilder<K,V>
extends RequestBuilder<MultipleRequestBuilder<K,V>>, SettableViewParameters.Unpaginated<K,MultipleRequestBuilder<K,V>>

Interface for building ViewMultipleRequests.

Example usage:

 

 ViewMultipleRequest<String,String> multiRequest =

 //get a builder for the"alpha"view of the"directory"design doc
 db.getViewRequestBuilder("directory","alpha")
     //create a new multi request expecting String keys and values
     .newMultipleRequest(Key.Type.STRING,String.class)

     //add three request queries
     .startKey("A").endKey("B").add() //add a request from A to B
     .startKey("H").endKey("I").add() //add a request from H to I
     .startKey("N").endKey("O").add() //add a request from N to O

     //build the request
     .build()
 
 

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
MultipleRequestBuilder<K,V>	add() Adds a query request to this MultipleRequestBuilder.
ViewMultipleRequest<K,V>	build() Called after composing the multiple requests to build the ViewMultipleRequest.

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

returnThis

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

limit, skip

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

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

Method Detail

add

MultipleRequestBuilder<K,V> add()

Adds a query request to this MultipleRequestBuilder.

Returns:

the request builder ready to compose the next request

Since:

2.0.0

build

ViewMultipleRequest<K,V> build()

Called after composing the multiple requests to build the ViewMultipleRequest.

It is only valid to call build() after adding one or more requests. If parameters have been set but the request has not been added then an IllegalStateException will be thrown.

Returns:

the built ViewMultipleRequest that can perform the request

Throws:

java.lang.IllegalStateException - if add() was not the last call before build

Since:

2.0.0