com.couchbase.client.protocol.views

Class Paginator

java.lang.Object

net.spy.memcached.compat.SpyObject

com.couchbase.client.protocol.views.Paginator

All Implemented Interfaces:

java.util.Iterator<ViewResponse>

public class Paginator
extends SpyObject
implements java.util.Iterator<ViewResponse>

The Paginator allows easy pagination over a ViewResult. It is recommended not to instantiate this object directly, but to obtain a reference through the CouchbaseClient object like this: View view = client.getView("design_doc", "viewname"); Query query = new Query(); int docsPerPage = 15; Paginator paginator = client.paginatedQuery(view, query, docsPerPage);

Constructor Summary

Constructors

Constructor and Description
Paginator(CouchbaseClient client, View view, Query query, int numDocs) Create a new Paginator.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext() Check if there is still a ViewResult left to fetch.
ViewResponse	next() Returns the next ViewResult object to iterate over.
void	remove() Remove is not supported while iterating over a ViewResult.

Methods inherited from class net.spy.memcached.compat.SpyObject

getLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

Paginator

public Paginator(CouchbaseClient client,
         View view,
         Query query,
         int numDocs)

Create a new Paginator.

Parameters:

client - the CouchbaseClient object to run the queries on.

view - the instance of the View to run the Queries against.

query - the instance of the Query object for the params.

numDocs - the number of the documents to return per page (must be greater than zero).

Method Detail

hasNext

public boolean hasNext()

Check if there is still a ViewResult left to fetch.

Specified by:

hasNext in interface java.util.Iterator<ViewResponse>

Returns:

true or false whether there is a ViewResult set to return or not.

next

public ViewResponse next()

Returns the next ViewResult object to iterate over.

Specified by:

next in interface java.util.Iterator<ViewResponse>

Returns:

the next ViewResult page.

remove

public void remove()

Remove is not supported while iterating over a ViewResult.

Specified by:

remove in interface java.util.Iterator<ViewResponse>