com.cloudant.client.api.views

Interface ViewRequest<K,V>

Type Parameters:

K - the type of key emitted by the view

V - the type of value emitted by the view

public interface ViewRequest<K,V>

Enables retrieving view responses.

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
ViewResponse<K,V>	getResponse() Performs the request and returns the response.
ViewResponse<K,V>	getResponse(java.lang.String paginationToken) Performs view request for the page represented by a pagination token obtained from a previous request.
V	getSingleValue() Performs the request and returns a single value.

Method Detail

getResponse

ViewResponse<K,V> getResponse()
                       throws java.io.IOException

Performs the request and returns the response.

Example usage:

 
 ViewResponse<String, String> response = db.getViewRequestBuilder("designDoc","viewName")
                   .newRequest(Key.Type.STRING, String.class)
                   .build()
                   .getResponse();
 
 

Returns:

the response object

Throws:

java.io.IOException - if there is an error communicating with the server

Since:

2.0.0

getResponse

ViewResponse<K,V> getResponse(java.lang.String paginationToken)
                       throws java.io.IOException

Performs view request for the page represented by a pagination token obtained from a previous request.

Example usage for stateless pagination:

 
 ViewResponse<String, String> responsePage1 = db.getViewRequestBuilder("designDoc","viewName")
                   .newRequest(Key.Type.STRING, String.class)
                   .build()
                   .getResponse();
 String tokenForPage2 = responsePage1.getNextPageToken();

 // To request the next page:
 // 1. Recreate the view request by supplying the same parameters to the builder.
 // 2. Execute the request using the pagination token retrieved above.
 ViewResponse<String, String> responsePage2 = db.getViewRequestBuilder("designDoc","viewName")
                   .newRequest(Key.Type.STRING, String.class)
                   .build()
                   .getResponse(tokenForPage2);
 
 

Parameters:

paginationToken - obtained from a previous ViewResponse, null is equivalent to getResponse()

Returns:

the response object

Throws:

java.io.IOException - if there is an error communicating with the server

Since:

2.1.0

See Also:

ViewResponse.getNextPageToken(), ViewResponse.getPreviousPageToken()

getSingleValue

V getSingleValue()
          throws java.io.IOException

Performs the request and returns a single value.

This is primarily intended for retrieving a single result (e.g. count) from a reduced view.

Example usage for a view with a "_count" reduce function:

 
 Integer count = db.getViewRequestBuilder("designDoc","viewWithCount")
                   .newRequest(Key.Type.STRING, Integer.class)
                   .reduce(true) //this is the default, but shown for clarity
                   .build()
                   .getSingleValue();
 
 

Returns:

value from the first result row or null if there were no rows

Throws:

java.io.IOException - if there is an error communicating with the server

Since:

2.0.0