nl.qbusict.cupboard

Class DatabaseCompartment.QueryBuilder<T>

java.lang.Object

nl.qbusict.cupboard.DatabaseCompartment.QueryBuilder<T>

Enclosing class:

DatabaseCompartment

public static class DatabaseCompartment.QueryBuilder<T>
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
DatabaseCompartment.QueryBuilder<T>	byId(long id) Perform a query by id.
DatabaseCompartment.QueryBuilder<T>	distinct() Make this query distinct e.g.
T	get() Convenience for calling query().get()
android.database.Cursor	getCursor() Convenience for calling query().getCursor()
DatabaseCompartment.QueryBuilder<T>	groupBy(java.lang.String group) Set the group by clause
DatabaseCompartment.QueryBuilder<T>	having(java.lang.String having) Set the having clause
DatabaseCompartment.QueryBuilder<T>	limit(int limit) Set a limit on the number of rows returned.
java.util.List<T>	list() Convenience for calling query().list()
DatabaseCompartment.QueryBuilder<T>	offset(int offset) Set an offset of rows returned.
DatabaseCompartment.QueryBuilder<T>	orderBy(java.lang.String order) Set the order by clause.
QueryResultIterable<T>	query() Execute the query
DatabaseCompartment.QueryBuilder<T>	withProjection(java.lang.String... projection) Set a projection, the columns returned, for this query.
DatabaseCompartment.QueryBuilder<T>	withSelection(java.lang.String selection, java.lang.String... args) Set the selection (where clause) and selection arguments.

Methods inherited from class java.lang.Object

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

Method Detail

withSelection

public DatabaseCompartment.QueryBuilder<T> withSelection(java.lang.String selection,
                                                         java.lang.String... args)

Set the selection (where clause) and selection arguments. You can (and should) use a ? as a parameter placeholder for query parameters. Each place holder will be replaced by an argument you pass in, in the specified order.

Parameters:

selection - The selection, optionally containing ? as parameter placeholders

args - The arguments matching the number of placeholders in the selection string.

Returns:

this builder

orderBy

public DatabaseCompartment.QueryBuilder<T> orderBy(java.lang.String order)

Set the order by clause. This is a SQL styled list of fields, optionally with "asc" or "desc" appended for specifying the order. For example, to sort by the entity "name" field, in descending order pass the value

name desc

Parameters:

order - the required order

Returns:

this builder

groupBy

public DatabaseCompartment.QueryBuilder<T> groupBy(java.lang.String group)

Set the group by clause

Parameters:

group - the group by clause

Returns:

this builder

having

public DatabaseCompartment.QueryBuilder<T> having(java.lang.String having)

Set the having clause

Parameters:

having - the having clause

Returns:

this builder

withProjection

public DatabaseCompartment.QueryBuilder<T> withProjection(java.lang.String... projection)

Set a projection, the columns returned, for this query. Setting a projection can be more performant, but will result in "incomplete" objects.

Parameters:

projection - the columns (entity fields) to return

Returns:

this builder

byId

public DatabaseCompartment.QueryBuilder<T> byId(long id)

Perform a query by id. This will also limit the number of results to 1 so that a query by id will return either zero or one results.

Parameters:

id - the id to query for

Returns:

this builder

limit

public DatabaseCompartment.QueryBuilder<T> limit(int limit)

Set a limit on the number of rows returned. Must be greater or equal to 1.

Parameters:

limit - the maximum rows to return when the query is executed

Returns:

the builder

offset

public DatabaseCompartment.QueryBuilder<T> offset(int offset)

Set an offset of rows returned. Must be greater or equal to 1. In case there is offset but no limit defined, Long.MAX_VALUE will be used as limit.

Parameters:

offset - the offset of rows to return when the query is executed

Returns:

the builder

distinct

public DatabaseCompartment.QueryBuilder<T> distinct()

Make this query distinct e.g. removing duplicate rows. This will most likely require that you pass in a projection as well.

Returns:

this builder.

query

public QueryResultIterable<T> query()

Execute the query

Returns:

The query result

getCursor

public android.database.Cursor getCursor()

Convenience for calling query().getCursor()

Returns:

the cursor

get

public T get()

Convenience for calling query().get()

Returns:

the entity or null if the query didn't return any results

list

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

Convenience for calling query().list()

Returns:

the result set as a list.