com.couchbase.lite

Class Query

java.lang.Object

com.couchbase.lite.Query

Direct Known Subclasses:

LiveQuery

public class Query
extends java.lang.Object

Represents a query of a CouchbaseLite 'view', or of a view-like resource like _all_documents.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Query.AllDocsMode Changes the behavior of a query created by queryAllDocuments.
static class	Query.IndexUpdateMode Determines whether or when the view index is updated.
static interface	Query.QueryCompleteListener A delegate that can be called to signal the completion of a Query.

Method Summary

Modifier and Type	Method and Description
protected void	finalize()
Query.AllDocsMode	getAllDocsMode()
Database	getDatabase() The database this query is associated with
java.lang.Object	getEndKey()
java.lang.String	getEndKeyDocId()
int	getGroupLevel()
Query.IndexUpdateMode	getIndexUpdateMode()
java.util.List<java.lang.Object>	getKeys()
int	getLimit()
Predicate<QueryRow>	getPostFilter()
int	getPrefixMatchLevel()
int	getSkip()
java.lang.Object	getStartKey()
java.lang.String	getStartKeyDocId()
View	getView()
boolean	isDescending()
boolean	isInclusiveEnd()
boolean	isInclusiveStart()
boolean	isMapOnly()
QueryEnumerator	run() Sends the query to the server and returns an enumerator over the result rows (Synchronous).
java.util.concurrent.Future	runAsync(Query.QueryCompleteListener onComplete) Starts an asynchronous query.
void	setAllDocsMode(Query.AllDocsMode allDocsMode)
void	setDescending(boolean descending)
void	setEndKey(java.lang.Object endKey)
void	setEndKeyDocId(java.lang.String endKeyDocId)
void	setGroupLevel(int groupLevel)
void	setIncludeDeleted(boolean includeDeletedParam)
void	setInclusiveEnd(boolean inclusiveEnd)
void	setInclusiveStart(boolean inclusiveStart)
void	setIndexUpdateMode(Query.IndexUpdateMode indexUpdateMode)
void	setKeys(java.util.List<java.lang.Object> keys)
void	setLimit(int limit)
void	setMapOnly(boolean mapOnly)
void	setPostFilter(Predicate<QueryRow> pf)
void	setPrefetch(boolean prefetch)
void	setPrefixMatchLevel(int prefixMatchLevel)
void	setSkip(int skip)
void	setStartKey(java.lang.Object startKey)
void	setStartKeyDocId(java.lang.String startKeyDocId)
boolean	shouldIncludeDeleted()
boolean	shouldPrefetch()
LiveQuery	toLiveQuery() Returns a live query with the same parameters.

Methods inherited from class java.lang.Object

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

Method Detail

getDatabase

public Database getDatabase()

The database this query is associated with

getLimit

public int getLimit()

setLimit

public void setLimit(int limit)

getSkip

public int getSkip()

setSkip

public void setSkip(int skip)

isDescending

public boolean isDescending()

setDescending

public void setDescending(boolean descending)

getStartKey

public java.lang.Object getStartKey()

setStartKey

public void setStartKey(java.lang.Object startKey)

getEndKey

public java.lang.Object getEndKey()

setEndKey

public void setEndKey(java.lang.Object endKey)

getStartKeyDocId

public java.lang.String getStartKeyDocId()

setStartKeyDocId

public void setStartKeyDocId(java.lang.String startKeyDocId)

getEndKeyDocId

public java.lang.String getEndKeyDocId()

setEndKeyDocId

public void setEndKeyDocId(java.lang.String endKeyDocId)

getIndexUpdateMode

public Query.IndexUpdateMode getIndexUpdateMode()

setIndexUpdateMode

public void setIndexUpdateMode(Query.IndexUpdateMode indexUpdateMode)

getAllDocsMode

public Query.AllDocsMode getAllDocsMode()

setAllDocsMode

public void setAllDocsMode(Query.AllDocsMode allDocsMode)

getKeys

public java.util.List<java.lang.Object> getKeys()

setKeys

public void setKeys(java.util.List<java.lang.Object> keys)

isMapOnly

public boolean isMapOnly()

setMapOnly

public void setMapOnly(boolean mapOnly)

getGroupLevel

public int getGroupLevel()

setGroupLevel

public void setGroupLevel(int groupLevel)

getPrefixMatchLevel

public int getPrefixMatchLevel()

setPrefixMatchLevel

public void setPrefixMatchLevel(int prefixMatchLevel)

isInclusiveStart

public boolean isInclusiveStart()

setInclusiveStart

public void setInclusiveStart(boolean inclusiveStart)

isInclusiveEnd

public boolean isInclusiveEnd()

setInclusiveEnd

public void setInclusiveEnd(boolean inclusiveEnd)

getPostFilter

public Predicate<QueryRow> getPostFilter()

setPostFilter

public void setPostFilter(Predicate<QueryRow> pf)

shouldPrefetch

public boolean shouldPrefetch()

setPrefetch

public void setPrefetch(boolean prefetch)

shouldIncludeDeleted

public boolean shouldIncludeDeleted()

setIncludeDeleted

public void setIncludeDeleted(boolean includeDeletedParam)

run

public QueryEnumerator run()
                    throws CouchbaseLiteException

Sends the query to the server and returns an enumerator over the result rows (Synchronous). If the query fails, this method returns nil and sets the query's .error property.

Throws:

CouchbaseLiteException

toLiveQuery

public LiveQuery toLiveQuery()

Returns a live query with the same parameters.

runAsync

public java.util.concurrent.Future runAsync(Query.QueryCompleteListener onComplete)

Starts an asynchronous query. Returns immediately, then calls the onLiveQueryChanged block when the query completes, passing it the row enumerator. If the query fails, the block will receive a non-nil enumerator but its .error property will be set to a value reflecting the error. The originating Query's .error property will NOT change.

getView

public View getView()

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable