de.greenrobot.dao.query

Class Query<T>

java.lang.Object

de.greenrobot.dao.query.Query<T>

Type Parameters:

T - The entity class the query will return results for.

public class Query<T>
extends java.lang.Object

A repeatable query returning entities.

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractDao<T,?>	dao
protected de.greenrobot.dao.InternalQueryDaoAccess<T>	daoAccess
protected int	limitPosition
protected int	offsetPosition
protected java.lang.Thread	ownerThread
protected java.lang.String[]	parameters
protected java.lang.String	sql

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkThread()
Query<T>	forCurrentThread()
static <T2> Query<T2>	internalCreate(AbstractDao<T2,?> dao, java.lang.String sql, java.lang.Object[] initialValues) For internal use by greenDAO only.
java.util.List<T>	list() Executes the query and returns the result as a list containing all entities loaded into memory.
CloseableListIterator<T>	listIterator() Executes the query and returns the result as a list iterator; make sure to close it to close the underlying cursor.
LazyList<T>	listLazy() Executes the query and returns the result as a list that lazy loads the entities on first access.
LazyList<T>	listLazyUncached() Executes the query and returns the result as a list that lazy loads the entities on every access (uncached).
void	setLimit(int limit) Sets the limit of the maximum number of results returned by this Query.
void	setOffset(int offset) Sets the offset for results returned by this Query.
void	setParameter(int index, java.lang.Boolean parameter)
void	setParameter(int index, java.util.Date parameter)
void	setParameter(int index, java.lang.Object parameter) Sets the parameter (0 based) using the position in which it was added during building the query.
protected static java.lang.String[]	toStringArray(java.lang.Object[] values)
T	unique() Executes the query and returns the unique result or null.
T	uniqueOrThrow() Executes the query and returns the unique result (never null).

Methods inherited from class java.lang.Object

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

Field Detail

limitPosition

protected final int limitPosition

offsetPosition

protected final int offsetPosition

dao

protected final AbstractDao<T,?> dao

daoAccess

protected final de.greenrobot.dao.InternalQueryDaoAccess<T> daoAccess

sql

protected final java.lang.String sql

parameters

protected final java.lang.String[] parameters

ownerThread

protected final java.lang.Thread ownerThread

Method Detail

internalCreate

public static <T2> Query<T2> internalCreate(AbstractDao<T2,?> dao,
                            java.lang.String sql,
                            java.lang.Object[] initialValues)

For internal use by greenDAO only.

forCurrentThread

public Query<T> forCurrentThread()

list

public java.util.List<T> list()

Executes the query and returns the result as a list containing all entities loaded into memory.

listLazy

public LazyList<T> listLazy()

Executes the query and returns the result as a list that lazy loads the entities on first access. Entities are cached, so accessing the same entity more than once will not result in loading an entity from the underlying cursor again.Make sure to close it to close the underlying cursor.

listLazyUncached

public LazyList<T> listLazyUncached()

Executes the query and returns the result as a list that lazy loads the entities on every access (uncached). Make sure to close the list to close the underlying cursor.

listIterator

public CloseableListIterator<T> listIterator()

Executes the query and returns the result as a list iterator; make sure to close it to close the underlying cursor. The cursor is closed once the iterator is fully iterated through.

unique

public T unique()

Executes the query and returns the unique result or null.

Returns:

Entity or null if no matching entity was found

Throws:

DaoException - if the result is not unique

uniqueOrThrow

public T uniqueOrThrow()

Executes the query and returns the unique result (never null).

Returns:

Entity

Throws:

DaoException - if the result is not unique or no entity was found

setParameter

public void setParameter(int index,
                java.lang.Object parameter)

Sets the parameter (0 based) using the position in which it was added during building the query. Note: all standard WHERE parameters come first. After that come the WHERE parameters of joins (if any).

setParameter

public void setParameter(int index,
                java.util.Date parameter)

setParameter

public void setParameter(int index,
                java.lang.Boolean parameter)

setLimit

public void setLimit(int limit)

Sets the limit of the maximum number of results returned by this Query. QueryBuilder.limit(int) must have been called on the QueryBuilder that created this Query object.

setOffset

public void setOffset(int offset)

Sets the offset for results returned by this Query. QueryBuilder.offset(int) must have been called on the QueryBuilder that created this Query object.

toStringArray

protected static java.lang.String[] toStringArray(java.lang.Object[] values)

checkThread

protected void checkThread()