View (cloudant-client 1.2.1 API)

java.lang.Object
- com.cloudant.client.api.View

public class View
extends java.lang.Object

This class provides access to the View APIs.

Usage Example:

 
  List<Foo> list = db.view("example/foo")
 	.startKey("start-key")
 	.endKey("end-key")
 	.limit(10)
 	.includeDocs(true)
 	.query(Foo.class);

  // scalar values
  int count = db.view("example/by_tag")
 	.key("couchdb")
 	.queryForInt();

 // pagination
 Page<Foo> page = db.view("example/foo").queryPage(...);

Since:: 0.0.1
See Also:: CouchDatabaseBase.view(String), ViewResult

Constructor Summary

Constructors
Constructor and Description

View()

Constructors
Constructor and Description
`View()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`View`	`descending(java.lang.Boolean descending)` Reverses the reading direction, not the sort order.
`View`	`endKey(java.lang.Object... endKey)`
`View`	`endKeyDocId(java.lang.String endKeyDocId)`
`View`	`group(java.lang.Boolean group)`
`View`	`groupLevel(java.lang.Integer groupLevel)`
`View`	`includeDocs(java.lang.Boolean includeDocs)`
`View`	`inclusiveEnd(java.lang.Boolean inclusiveEnd)`
`View`	`key(java.lang.Object... key)`
`View`	`keys(java.lang.Object... keys)` Supplies a key list when calling `_all_docs` View.
`View`	`limit(java.lang.Integer limit)`
`<T> java.util.List<T>`	`query(java.lang.Class<T> classOfT)` Queries a view.
`boolean`	`queryForBoolean()`
`int`	`queryForInt()`
`long`	`queryForLong()`
`java.io.InputStream`	`queryForStream()` Queries a view as an `InputStream`
`java.lang.String`	`queryForString()`
`<T> Page<T>`	`queryPage(int rowsPerPage, java.lang.String param, java.lang.Class<T> classOfT)` Queries a view for pagination, returns a next or a previous page, this method figures out which page to return based on the given param that is generated by an earlier call to this method, quering the first page is done by passing a `null` param.
`<K,V,T> ViewResult<K,V,T>`	`queryView(java.lang.Class<K> classOfK, java.lang.Class<V> classOfV, java.lang.Class<T> classOfT)` Returns the queried view's results containing JSON entries.
`View`	`reduce(java.lang.Boolean reduce)`
`View`	`skip(java.lang.Integer skip)`
`View`	`stale(java.lang.String stale)`
`View`	`startKey(java.lang.Object... startKey)`
`View`	`startKeyDocId(java.lang.String startKeyDocId)`
`View`	`updateSeq(java.lang.Boolean updateSeq)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - View
```
public View()
```
- Method Detail
  - queryForStream
```
public java.io.InputStream queryForStream()
```
    Queries a view as an InputStream
    The stream should be properly closed after usage, as to avoid connection leaks.
    
    Returns:
    
    The result as an InputStream.
  - query
```
public <T> java.util.List<T> query(java.lang.Class<T> classOfT)
```
    Queries a view.
    
    Type Parameters:
    
    T - Object type T
    
    Parameters:
    
    classOfT - The class of type T
    
    Returns:
    
    The result of the view query as a List<T>
  - queryView
```
public <K,V,T> ViewResult<K,V,T> queryView(java.lang.Class<K> classOfK,
                                           java.lang.Class<V> classOfV,
                                           java.lang.Class<T> classOfT)
```
    Returns the queried view's results containing JSON entries.
    Example:
    
    A view with a map function of emitted key-value pairs.
    Sample view:
```
 function(doc) {
     emit(doc.shape, doc.sides);
 }
 
```
    A sample document that could be queried by this view is:
```
 { "_id" : docId,
   "_rev" : 1-23456
   "shape" : "triangle"
   "sides" : 3
 }
 
```
    The results of a query using this view are JSON object of key-value pairs:
```
 {"total_rows":1,"offset":0,"rows":[
 {"id":"docId","key":"triangle","value":3},
 ]}
 
```
    Sample use of this method to get this ViewResult:
```
 ViewResult<String, Integer, Foo> viewResult = database.view("example/foo")
                              .queryView(String.class, Integer.class, Foo.class);

 
```
    Example ViewResult entries:
```
 ViewResult [totalRows=1, updateSeq=0, rows=[Rows[id=docId]]]
 
```
    Type Parameters:
    
    K - The type of key emitted by the view.
    
    V - The type of value emitted by the view.
    
    T - The type of class for the view's doc.
    
    Parameters:
    
    classOfK - The class type of the key emitted by the view.
    
    classOfV - The class type of value emitted by the view.
    
    classOfT - The class type of the view's doc included by the view.
    
    Returns:
    
    The view's result entries which contains the doc's id, key, and value. Will also contain the doc if include_doc equals true.
  - queryForInt
```
public int queryForInt()
```
    Returns:
    
    The result of the view as int.
  - queryForBoolean
```
public boolean queryForBoolean()
```
    Returns:
    
    The result of the view as boolean.
  - key
```
public View key(java.lang.Object... key)
```
    Parameters:
    
    key - The key value, accepts a single value or multiple values for complex keys.
  - startKey
```
public View startKey(java.lang.Object... startKey)
```
    Parameters:
    
    startKey - The start key value, accepts a single value or multiple values for complex keys.
  - startKeyDocId
```
public View startKeyDocId(java.lang.String startKeyDocId)
```
    Parameters:
    
    startKeyDocId -
    
    Returns:
  - endKey
```
public View endKey(java.lang.Object... endKey)
```
    Parameters:
    
    endKey - The end key value, accepts a single value or multiple values for complex keys.
  - endKeyDocId
```
public View endKeyDocId(java.lang.String endKeyDocId)
```
    Parameters:
    
    endKeyDocId -
    
    Returns:
  - descending
```
public View descending(java.lang.Boolean descending)
```
    Reverses the reading direction, not the sort order.
  - queryForString
```
public java.lang.String queryForString()
```
    Returns:
    
    The result of the view as String.
  - limit
```
public View limit(java.lang.Integer limit)
```
    Parameters:
    
    limit -
    
    Returns:
  - group
```
public View group(java.lang.Boolean group)
```
    Parameters:
    
    group - Specifies whether the reduce function reduces the result to a set of keys, or to a single result. Defaults to false (single result).
  - groupLevel
```
public View groupLevel(java.lang.Integer groupLevel)
```
    Parameters:
    
    groupLevel -
    
    Returns:
  - queryForLong
```
public long queryForLong()
```
    Returns:
    
    The result of the view as long.
  - queryPage
```
public <T> Page<T> queryPage(int rowsPerPage,
                             java.lang.String param,
                             java.lang.Class<T> classOfT)
```
    Queries a view for pagination, returns a next or a previous page, this method figures out which page to return based on the given param that is generated by an earlier call to this method, quering the first page is done by passing a null param.
    
    Type Parameters:
    
    T - Object type T
    
    Parameters:
    
    rowsPerPage - The number of rows per page.
    
    param - The request parameter to use to query a page, or null to return the first page.
    
    classOfT - The class of type T.
    
    Returns:
    
    Page
  - stale
```
public View stale(java.lang.String stale)
```
    Parameters:
    
    stale - Accept values: ok | update_after (update_after as of CouchDB 1.1.0)
  - skip
```
public View skip(java.lang.Integer skip)
```
    Parameters:
    
    skip - Skips n number of documents.
  - reduce
```
public View reduce(java.lang.Boolean reduce)
```
    Parameters:
    
    reduce - Indicates whether to use the reduce function of the view, defaults to true if the reduce function is defined.
  - includeDocs
```
public View includeDocs(java.lang.Boolean includeDocs)
```
    Parameters:
    
    includeDocs -
    
    Returns:
  - inclusiveEnd
```
public View inclusiveEnd(java.lang.Boolean inclusiveEnd)
```
    Parameters:
    
    inclusiveEnd - Indicates whether the endkey is included in the result, defaults to true.
  - updateSeq
```
public View updateSeq(java.lang.Boolean updateSeq)
```
    Parameters:
    
    updateSeq -
    
    Returns:
  - keys
```
public View keys(java.lang.Object... keys)
```
    Supplies a key list when calling _all_docs View.
    
    Parameters:
    
    keys -
    
    Returns:

Class View

Usage Example:

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

View

Method Detail

queryForStream

query

queryView

queryForInt

queryForBoolean

key

startKey

startKeyDocId

endKey

endKeyDocId

descending

queryForString

limit

group

groupLevel

queryForLong

queryPage

stale

skip

reduce

includeDocs

inclusiveEnd

updateSeq

keys