com.couchbase.mock.views

Class QueryResult

java.lang.Object

com.couchbase.mock.views.QueryResult

public class QueryResult
extends Object

Query result object. This is returned from View.execute(Iterable, Configuration), and is primarily used for tests. To actually return a view result to the user, it is recommended to use the View.executeRaw(Iterable, Configuration) method instead

Method Summary

Modifier and Type	Method and Description
int	getFilteredRowCount()
int	getTotalRowCount()
String	idAt(int ix) Returns the ID (document ID) of the row in the given index
Object	keyAt(int ix) Returns the key for a row at a given index
int	numKeyAt(int ix) Like keyAt(int) but casts the key as an integer
int	numValAt(int ix) Returns the value of a given row as a number.
Map<String,Object>	rowAt(int ix) Get the raw JSON row at a given index
Object	valueAt(int ix) Returns the raw value for the row

Methods inherited from class java.lang.Object

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

Method Detail

getTotalRowCount

public int getTotalRowCount()

Returns:

The total_rows field showing how many total items were indexed

getFilteredRowCount

public int getFilteredRowCount()

Returns:

The number of rows actually returned for the query

rowAt

public Map<String,Object> rowAt(int ix)

Get the raw JSON row at a given index

Parameters:

ix - The index of the row to fetch

Returns:

The row

keyAt

public Object keyAt(int ix)

Returns the key for a row at a given index

Parameters:

ix - The index of the row

Returns:

A key. The user should cast this to the appropriate type as needed

numKeyAt

public int numKeyAt(int ix)

Like keyAt(int) but casts the key as an integer

Parameters:

ix - index of the row

Returns:

key as int

numValAt

public int numValAt(int ix)

Returns the value of a given row as a number.

Parameters:

ix - The index of the row. The row must have a value and it must be numeric

Returns:

The numeric value

idAt

public String idAt(int ix)

Returns the ID (document ID) of the row in the given index

Parameters:

ix - The index of the row. The row must be a result of a non-reduce query

Returns:

the document ID

valueAt

public Object valueAt(int ix)

Returns the raw value for the row

Parameters:

ix - The index of the row

Returns:

The rae value