Package com.couchbase.lite
Class Limit
- java.lang.Object
-
- com.couchbase.lite.Limit
-
- All Implemented Interfaces:
com.couchbase.lite.internal.Listenable<QueryChange,QueryChangeListener>
,Query
public class Limit extends Object
A Limit component represents the LIMIT clause of the query statement.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ListenerToken
addChangeListener(QueryChangeListener listener)
Adds a query change listener.ListenerToken
addChangeListener(Executor executor, QueryChangeListener listener)
Adds a query change listener with the dispatch queue on which changes will be posted.ResultSet
execute()
Executes the query returning a result set that enumerates result rows one at a time.String
explain()
Returns a string describing the implementation of the compiled query.protected com.couchbase.lite.AbstractDatabase
getDatabase()
Get the database to which this query will be applied.Parameters
getParameters()
Returns a copy of the current parameters.protected com.couchbase.lite.internal.core.C4Query
prepQueryLocked(com.couchbase.lite.AbstractDatabase db)
void
removeChangeListener(ListenerToken token)
Deprecated.use ListenerToken.remove()void
setParameters(Parameters parameters)
Set query parameters.String
toString()
-
-
-
Field Detail
-
DOMAIN
protected static final LogDomain DOMAIN
-
-
Method Detail
-
getDatabase
@NonNull protected final com.couchbase.lite.AbstractDatabase getDatabase()
Get the database to which this query will be applied.- Returns:
- the query database.
-
prepQueryLocked
@NonNull protected final com.couchbase.lite.internal.core.C4Query prepQueryLocked(@NonNull com.couchbase.lite.AbstractDatabase db) throws CouchbaseLiteException
- Throws:
CouchbaseLiteException
-
getParameters
@Nullable public Parameters getParameters()
Returns a copy of the current parameters.- Specified by:
getParameters
in interfaceQuery
-
setParameters
public void setParameters(@Nullable Parameters parameters)
Set query parameters. Setting new parameters will re-execute a query if there is at least one listener listening for changes.- Specified by:
setParameters
in interfaceQuery
- Throws:
IllegalStateException
- on failure to create the query (e.g., database closed)IllegalArgumentException
- on failure to encode the parameters (e.g., parameter value not supported)
-
execute
@NonNull public ResultSet execute() throws CouchbaseLiteException
Executes the query returning a result set that enumerates result rows one at a time. You can run the query any number of times and you can even have multiple ResultSet active at once.The results come from a snapshot of the database taken at the moment the run() method is called, so they will not reflect any changes made to the database afterwards.
- Specified by:
execute
in interfaceQuery
- Returns:
- the ResultSet for the query result.
- Throws:
CouchbaseLiteException
- if there is an error when running the query.
-
explain
@NonNull public String explain() throws CouchbaseLiteException
Returns a string describing the implementation of the compiled query. This is intended to be read by a developer for purposes of optimizing the query, especially to add database indexes. It's not machine-readable and its format may change. As currently implemented, the result is two or more lines separated by newline characters:- The first line is the SQLite SELECT statement.
- The subsequent lines are the output of SQLite's "EXPLAIN QUERY PLAN" command applied to that statement.
- Specified by:
explain
in interfaceQuery
- Returns:
- a string describing the implementation of the compiled query.
- Throws:
CouchbaseLiteException
- if an error occurs
-
addChangeListener
@NonNull public ListenerToken addChangeListener(@NonNull QueryChangeListener listener)
Adds a query change listener. Changes will be posted on the main queue.- Specified by:
addChangeListener
in interfacecom.couchbase.lite.internal.Listenable<QueryChange,QueryChangeListener>
- Specified by:
addChangeListener
in interfaceQuery
- Parameters:
listener
- The listener to post changes.- Returns:
- An opaque listener token object for removing the listener.
-
addChangeListener
@NonNull public ListenerToken addChangeListener(@Nullable Executor executor, @NonNull QueryChangeListener listener)
Adds a query change listener with the dispatch queue on which changes will be posted. If the dispatch queue is not specified, the changes will be posted on the main queue.- Specified by:
addChangeListener
in interfacecom.couchbase.lite.internal.Listenable<QueryChange,QueryChangeListener>
- Specified by:
addChangeListener
in interfaceQuery
- Parameters:
executor
- The executor object that calls listener. If null, use default executor.listener
- The listener to post changes.- Returns:
- An opaque listener token object for removing the listener.
- Throws:
IllegalStateException
- on failure to create the query (e.g., database closed)
-
removeChangeListener
@Deprecated public void removeChangeListener(@NonNull ListenerToken token)
Deprecated.use ListenerToken.remove()Removes a change listener wih the given listener token.- Specified by:
removeChangeListener
in interfaceQuery
- Parameters:
token
- The listener token.
-
-