com.cloudant.sync.query

Class QueryResult

java.lang.Object

com.cloudant.sync.query.QueryResult

All Implemented Interfaces:

java.lang.Iterable<DocumentRevision>

public class QueryResult
extends java.lang.Object
implements java.lang.Iterable<DocumentRevision>

Iterable result of a query executed with IndexManager.

See Also:

IndexManager

API Status: Public

Constructor Summary

Constructors

Constructor and Description
QueryResult(java.util.List<java.lang.String> originalDocIds, Datastore datastore, java.util.List<java.lang.String> fields, long skip, long limit, com.cloudant.sync.query.UnindexedMatcher matcher)

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	documentIds() Returns a list of the document ids in this query result.
java.util.Iterator<DocumentRevision>	iterator()
int	size() Returns the number of documents in this query result.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

QueryResult

public QueryResult(java.util.List<java.lang.String> originalDocIds,
                   Datastore datastore,
                   java.util.List<java.lang.String> fields,
                   long skip,
                   long limit,
                   com.cloudant.sync.query.UnindexedMatcher matcher)

Method Detail

size

public int size()

Returns the number of documents in this query result.

Returns:

the number of documents DocumentRevision in this query result.

Throws:

QueryException - if the document ids for this query cannot be retrieved

documentIds

public java.util.List<java.lang.String> documentIds()

Returns a list of the document ids in this query result. This method is implemented this way to ensure that the list of document ids is consistent with the iterator results.

Returns:

list of the document ids

Throws:

QueryException - if the document ids for this query cannot be retrieved

iterator

public java.util.Iterator<DocumentRevision> iterator()

Specified by:

iterator in interface java.lang.Iterable<DocumentRevision>

Returns:

a newly created Iterator over the query results

Throws:

QueryException - if the document ids for this query cannot be retrieved