org.lightcouch

Class View

java.lang.Object

org.lightcouch.View

public class View
extends Object

This class allows construction and sending of View query requests. The API supports view queries for various data type results, and for pagination.

Usage Example:

 List<Foo> list = dbClient.view("example/foo")
	.includeDocs(true).startKey("start-key").endKey("end-key").limit(10).query(Foo.class);
  
 int count = dbClient.view("example/by_tag").key("couchdb").queryForInt(); // query for scalar values
  
 // query for view entries
 View view = dbClient.view("example/by_date")
	.key(2011, 10, 15) // complex key example
	.reduce(false)
	.includeDocs(true);
 ViewResult<int[], String, Foo> result = 
	view.queryView(int[].class, String.class, Foo.class);
 
 // pagination
 Page<Foo> page = dbClient.view("example/foo").queryPage(15, param, Foo.class);
 // page.get*Param() contains the param to query subsequent pages, {@code null} param queries the first page
 
 

Author:

Ahmed Yehia

Method Summary

Methods

Modifier and Type	Method and Description
View	descending(Boolean descending) Reverses the reading direction, not the sort order.
View	endKey(Object... endKey)
View	endKeyDocId(String endKeyDocId)
View	group(Boolean group)
View	groupLevel(Integer groupLevel)
View	includeDocs(Boolean includeDocs)
View	inclusiveEnd(Boolean inclusiveEnd)
View	key(Object... key)
View	keys(List<String> keys)
View	limit(Integer limit)
<T> List<T>	query(Class<T> classOfT) Queries a view.
boolean	queryForBoolean()
int	queryForInt()
long	queryForLong()
InputStream	queryForStream() Queries a view as an InputStream
String	queryForString()
<T> Page<T>	queryPage(int rowsPerPage, String param, 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(Class<K> classOfK, Class<V> classOfV, Class<T> classOfT) Queries a view.
View	reduce(Boolean reduce)
View	skip(Integer skip)
View	stale(String stale)
View	startKey(Object... startKey)
View	startKeyDocId(String startKeyDocId)
View	tempView(DesignDocument.MapReduce mapReduce)
View	tempView(String id)
View	updateSeq(Boolean updateSeq)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

queryForStream

public 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> List<T> query(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(Class<K> classOfK,
                                  Class<V> classOfV,
                                  Class<T> classOfT)

Queries a view.

Type Parameters:

K - Object type K (key)

V - Object type V (value)

Parameters:

classOfK - The class of type K.

classOfV - The class of type V.

classOfT - The class of type T.

Returns:

The View result entries.

queryForString

public String queryForString()

Returns:

The result of the view as String.

queryForInt

public int queryForInt()

Returns:

The result of the view as int.

queryForLong

public long queryForLong()

Returns:

The result of the view as long.

queryForBoolean

public boolean queryForBoolean()

Returns:

The result of the view as boolean.

queryPage

public <T> Page<T> queryPage(int rowsPerPage,
                    String param,
                    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

key

public View key(Object... key)

Parameters:

key - The key value, accepts a single value or multiple values for complex keys.

startKey

public View startKey(Object... startKey)

Parameters:

startKey - The start key value, accepts a single value or multiple values for complex keys.

startKeyDocId

public View startKeyDocId(String startKeyDocId)

endKey

public View endKey(Object... endKey)

Parameters:

endKey - The end key value, accepts a single value or multiple values for complex keys.

endKeyDocId

public View endKeyDocId(String endKeyDocId)

limit

public View limit(Integer limit)

stale

public View stale(String stale)

Parameters:

stale - Accept values: ok | update_after (update_after as of CouchDB 1.1.0)

descending

public View descending(Boolean descending)

Reverses the reading direction, not the sort order.

skip

public View skip(Integer skip)

Parameters:

skip - Skips n number of documents.

group

public View group(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(Integer groupLevel)

reduce

public View reduce(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(Boolean includeDocs)

inclusiveEnd

public View inclusiveEnd(Boolean inclusiveEnd)

Parameters:

inclusiveEnd - Indicates whether the endkey is included in the result, defaults to true.

updateSeq

public View updateSeq(Boolean updateSeq)

keys

public View keys(List<String> keys)

tempView

public View tempView(String id)

tempView

public View tempView(DesignDocument.MapReduce mapReduce)