com.cloudant.client.api.views

Interface AllDocsResponse

public interface AllDocsResponse

Encapsulates a response from an _all_docs request.

Provides methods to facilitate processing of the response.

Since:

2.0.0

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getDocIds()
java.util.List<Document>	getDocs() Get the document information from an _all_docs request.
<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.util.Map<java.lang.String,java.lang.String>	getErrors() Gets a map of the document id and error message if an error exists for any result in the _all_docs request.
java.util.Map<java.lang.String,java.lang.String>	getIdsAndRevs() Gets a map of the document id and revision for each result in the _all_docs request.

Method Detail

getDocs

java.util.List<Document> getDocs()

Get the document information from an _all_docs request.

Note that if requesting docs using SettableViewParameters.Common.keys(Object[]) the list of documents may include deleted documents that have one of the specified ids.

Note if SettableViewParameters.Common.includeDocs(boolean) is false then attachment metadata will not be present.

Returns:

a list of Document objects from the _all_docs request

Since:

2.0.0

getIdsAndRevs

java.util.Map<java.lang.String,java.lang.String> getIdsAndRevs()

Gets a map of the document id and revision for each result in the _all_docs request.

Note that if requesting docs using SettableViewParameters.Common.keys(Object[]) the ids and revs may include deleted documents that have one of the specified ids.

Returns:

a map with an entry for each document, key of _id and value of _rev

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.

Note that if requesting docs using SettableViewParameters.Common.keys(Object[]) the list of documents may include deleted documents that have one of the specified ids. You may want to ensure that your document type can support checking of the deleted flag.

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

getDocIds

java.util.List<java.lang.String> getDocIds()

Returns:

a list of the document ids

getErrors

java.util.Map<java.lang.String,java.lang.String> getErrors()

Gets a map of the document id and error message if an error exists for any result in the _all_docs request. For example, if a doc id does not exist the error message will show "not_found".

Returns:

a map with an entry for key of the doc id and value of error

Since:

2.10.0