com.cloudant.client.api.views

Interface ViewResponse<K,V>

Type Parameters:

K - the type of key emitted by the view

V - the type of value emitted by the view

All Superinterfaces:

java.lang.Iterable<ViewResponse<K,V>>

public interface ViewResponse<K,V>
extends java.lang.Iterable<ViewResponse<K,V>>

Encapsulates a response from a view request.

Provides methods to facilitate processing of the response.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ViewResponse.Row<K,V> Encapsulates a single row from the response results array.

Method Summary

Modifier and Type	Method and Description
java.util.List<Document>	getDocs()
<D> java.util.List<D>	getDocsAs(java.lang.Class<D> docType) Deserializes the included full content of result documents to a list of the specified type.
java.lang.Long	getFirstRowCount()
java.util.List<K>	getKeys()
java.lang.Long	getLastRowCount()
java.lang.String	getNextPageToken() Returns an opaque pagination token for the next page of results, which can be used with ViewRequest.getResponse(String) to retrieve the next page without keeping ViewResponse state.
java.lang.Long	getPageNumber() Get the page number of this response.
java.lang.String	getPreviousPageToken() Returns an opaque pagination token for the previous page of results, which can be used with ViewRequest.getResponse(String) to retrieve the previous page without keeping ViewResponse state.
java.util.List<ViewResponse.Row<K,V>>	getRows()
java.lang.Long	getTotalRowCount()
java.util.List<V>	getValues()
boolean	hasNextPage()
boolean	hasPreviousPage()
ViewResponse<K,V>	nextPage()
ViewResponse<K,V>	previousPage()

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getRows

java.util.List<ViewResponse.Row<K,V>> getRows()

Returns:

list of the result rows on this page

Since:

2.0.0

getKeys

java.util.List<K> getKeys()

Returns:

list of the keys from all of the result rows on this page

Since:

2.0.0

getValues

java.util.List<V> getValues()

Returns:

the values from all of the result rows on this page

Since:

2.0.0

getDocs

java.util.List<Document> getDocs()

Returns:

the documents from all of the result rows on this page

Throws:

java.lang.IllegalStateException - if include_docs was false

Since:

2.0.0

getDocsAs

<D> java.util.List<D> getDocsAs(java.lang.Class<D> docType)

Deserializes the included full content of result documents to a list of the specified type.

Type Parameters:

D - the type of the document

Parameters:

docType - the class type to deserialize the JSON document to

Returns:

the deserialized document

Throws:

java.lang.IllegalStateException - if include_docs was false

Since:

2.0.0

hasNextPage

boolean hasNextPage()

Returns:

true if there is a next page

Since:

2.0.0

hasPreviousPage

boolean hasPreviousPage()

Returns:

true if there is a previous page

Since:

2.0.0

nextPage

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

Returns:

the next page of results from this view query

Throws:

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

Since:

2.0.0

previousPage

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

Returns:

the previous page of results from this view query

Throws:

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

Since:

2.0.0

getNextPageToken

java.lang.String getNextPageToken()

Returns an opaque pagination token for the next page of results, which can be used with ViewRequest.getResponse(String) to retrieve the next page without keeping ViewResponse state.

Returns:

opaque pagination token for the next page, or null if there is no next page

Since:

2.1.0

See Also:

ViewRequest.getResponse(String)

getPreviousPageToken

java.lang.String getPreviousPageToken()

Returns an opaque pagination token for the previous page of results, which can be used with ViewRequest.getResponse(String) to retrieve the previous page without keeping ViewResponse state.

Returns:

opaque pagination token for the previous page, or null if there is no previous page

Since:

2.1.0

See Also:

ViewRequest.getResponse(String)

getPageNumber

java.lang.Long getPageNumber()

Get the page number of this response.

Useful for displaying a page number when using ViewRequestBuilder.newPaginatedRequest(Key.Type, Class)

Will always be 1 for an unpaginated request using ViewRequestBuilder.newRequest(Key.Type, Class)

Returns:

the page number

Since:

2.0.0

getFirstRowCount

java.lang.Long getFirstRowCount()

Returns:

the count of the first row on this page

Since:

2.0.0

getLastRowCount

java.lang.Long getLastRowCount()

Returns:

the count of the last row on this page

Since:

2.0.0

getTotalRowCount

java.lang.Long getTotalRowCount()

Returns:

the total number of rows in the view, before any filtering has taken place

Since:

2.0.0