android.lib.database.query

Class Select

java.lang.Object

android.lib.database.query.QueryBuilder

android.lib.database.query.Select

public class Select
extends QueryBuilder

Provides methods for building SQLite SELECT queries.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Select()

Method Summary

Methods

Modifier and Type	Method and Description
Select	average(java.lang.String column, java.lang.String alias) Adds the average value of the given column to include in the query results and specifies a name for it in the query output.
Query	build() Builds a SQL statement and abstracts it in a Query object ready for execution.
Select	column(java.lang.String column, java.lang.String alias) Adds the given column to include in the query results and specifies a name for the column in the query output.
Select	columns() Adds all columns (*) to include in the query results.
Select	columns(java.lang.String... columns) Adds the given columns to include in the query results.
Select	count(java.lang.String alias) Adds the total number of rows to include in the query results and specifies a name for it in the query output.
Select	count(java.lang.String column, java.lang.String alias) Adds the count of the number of times the given column that is not NULL in a group to include in the query results and specifies a name for it in the query output.
Select	distinct() Excludes duplicates of any rows from the query results.
Select	from(java.lang.Class<?>... tables) Specifies one or more tables containing the data that the query retrieves from.
Select	from(java.lang.Class<?> table, java.lang.String alias) Specifies one or more tables containing the data that the query retrieves from.
Select	from(java.lang.String... tables) Specifies one or more tables containing the data that the query retrieves from.
Select	from(java.lang.String table, java.lang.String alias) Specifies one or more tables containing the data that the query retrieves from.
Select	groupBy(java.lang.String... columns) Specifies one or more columns used to group rows returned by the
Select	having(Predicate predicate) Specifies the conditions that determines the groups included in the query result set.
Select	join(java.lang.Class<?> table, Predicate predicate) Filters query results that contain only rows from the given table that match one ore more rows in other tables.
Select	join(java.lang.Class<?> table, java.lang.String alias, Predicate predicate) Filters query results that contain only rows from the given table that match one ore more rows in other tables.
Select	join(java.lang.String table, Predicate predicate) Filters query results that contain only rows from the given table that match one ore more rows in other tables.
Select	join(java.lang.String table, java.lang.String alias, Predicate predicate) Filters query results that contain only rows from the given table that match one ore more rows in other tables.
Select	leftJoin(java.lang.Class<?> table, Predicate predicate) Filters query results that contain all rows from the tables before and only matching rows from the given table.
Select	leftJoin(java.lang.Class<?> table, java.lang.String alias, Predicate predicate) Filters query results that contain all rows from the tables before and only matching rows from the given table.
Select	leftJoin(java.lang.String table, Predicate predicate) Filters query results that contain all rows from the tables before and only matching rows from the given table.
Select	leftJoin(java.lang.String table, java.lang.String alias, Predicate predicate) Filters query results that contain all rows from the tables before and only matching rows from the given table.
Select	limit(int limit) Specifies an upper bound on the number of rows returned by the
Select	max(java.lang.String column, java.lang.String alias) Adds the maximum value of the given column to include in the query results and specifies a name for it in the query output.
Select	min(java.lang.String column, java.lang.String alias) Adds the minimum value of the given column to include in the query results and specifies a name for it in the query output.
Select	offset(int offset) Omits the first offset rows from the query result set.
Select	orderBy(java.lang.String... columns) Specifies one or more items used to sort the final query result set and the order for sorting the results.
Select	orderBy(java.lang.String column, boolean descending) Specifies one or more items used to sort the final query result set and the order for sorting the results.
Select	rightJoin(java.lang.Class<?> table, Predicate predicate) Filters query results that contain only matching rows from the given table and all rows from the tables before.
Select	rightJoin(java.lang.Class<?> table, java.lang.String alias, Predicate predicate) Filters query results that contain only matching rows from the given table and all rows from the tables before.
Select	rightJoin(java.lang.String table, Predicate predicate) Filters query results that contain only matching rows from the given table and all rows from the tables before.
Select	rightJoin(java.lang.String table, java.lang.String alias, Predicate predicate) Filters query results that contain only matching rows from the given table and all rows from the tables before.
Select	sum(java.lang.String column, java.lang.String alias) Adds the total value of the given column to include in the query results and specifies a name for it in the query output.
Select	where(Predicate predicate) Specifies filter conditions that determine the rows that the query returns.

Methods inherited from class android.lib.database.query.QueryBuilder

getTableName

Methods inherited from class java.lang.Object

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

Constructor Detail

Select

protected Select()

Method Detail

columns

public Select columns()

Adds all columns (*) to include in the query results.

Returns:

a Select object for further query construction.

columns

public Select columns(java.lang.String... columns)

Adds the given columns to include in the query results.

Each item in the list generates one column in the query results.

Parameters:

columns - the columns to include in the query results.

Returns:

a Select object for further query construction.

column

public Select column(java.lang.String column,
            java.lang.String alias)

Adds the given column to include in the query results and specifies a name for the column in the query output.

Parameters:

column - the column to include in the query results.

alias - the name for the column in the query output.

Returns:

a Select object for further query construction.

count

public Select count(java.lang.String column,
           java.lang.String alias)

Adds the count of the number of times the given column that is not NULL in a group to include in the query results and specifies a name for it in the query output.

Parameters:

column - the column to include in the query results.

alias - the name for the column in the query output.

Returns:

a Select object for further query construction.

count

public Select count(java.lang.String alias)

Adds the total number of rows to include in the query results and specifies a name for it in the query output.

Parameters:

alias - the name for the column in the query output.

Returns:

a Select object for further query construction.

average

public Select average(java.lang.String column,
             java.lang.String alias)

Adds the average value of the given column to include in the query results and specifies a name for it in the query output.

The result of SQLite AVG() is always a double value.

Parameters:

column - the column to include in the query results.

alias - the name for the column in the query output.

Returns:

a Select object for further query construction.

min

public Select min(java.lang.String column,
         java.lang.String alias)

Adds the minimum value of the given column to include in the query results and specifies a name for it in the query output.

Parameters:

column - the column to include in the query results.

alias - the name for the column in the query output.

Returns:

a Select object for further query construction.

max

public Select max(java.lang.String column,
         java.lang.String alias)

Adds the maximum value of the given column to include in the query results and specifies a name for it in the query output.

Parameters:

column - the column to include in the query results.

alias - the name for the column in the query output.

Returns:

a Select object for further query construction.

sum

public Select sum(java.lang.String column,
         java.lang.String alias)

Adds the total value of the given column to include in the query results and specifies a name for it in the query output.

Parameters:

column - the column to include in the query results.

alias - the name for the column in the query output.

Returns:

a Select object for further query construction.

distinct

public Select distinct()

Excludes duplicates of any rows from the query results.

Returns:

a Select object for further query construction.

from

public Select from(java.lang.Class<?>... tables)

Specifies one or more tables containing the data that the query retrieves from.

Parameters:

tables - the names of tables containing the data that the query retrieves from.

Returns:

a Select object for further query construction.

from

public Select from(java.lang.String... tables)

Specifies one or more tables containing the data that the query retrieves from.

Parameters:

tables - the names of tables containing the data that the query retrieves from.

Returns:

a Select object for further query construction.

from

public Select from(java.lang.Class<?> table,
          java.lang.String alias)

Specifies one or more tables containing the data that the query retrieves from.

Parameters:

table - the name of table containing the data that the query retrieves from.

alias - an alias for the table specified.

Returns:

a Select object for further query construction.

from

public Select from(java.lang.String table,
          java.lang.String alias)

Specifies one or more tables containing the data that the query retrieves from.

Parameters:

table - the name of table containing the data that the query retrieves from.

alias - an alias for the table specified.

Returns:

a Select object for further query construction.

join

public Select join(java.lang.Class<?> table,
          Predicate predicate)

Filters query results that contain only rows from the given table that match one ore more rows in other tables.

Parameters:

table - the table to join.

predicate - the condition on which tables are joined.

Returns:

a Select object for further query construction.

join

public Select join(java.lang.String table,
          Predicate predicate)

Filters query results that contain only rows from the given table that match one ore more rows in other tables.

Parameters:

table - the table to join.

predicate - the condition on which tables are joined.

Returns:

a Select object for further query construction.

join

public Select join(java.lang.Class<?> table,
          java.lang.String alias,
          Predicate predicate)

Filters query results that contain only rows from the given table that match one ore more rows in other tables.

Parameters:

table - the table to join.

alias - the alias of the given table.

predicate - the condition on which tables are joined.

Returns:

a Select object for further query construction.

join

public Select join(java.lang.String table,
          java.lang.String alias,
          Predicate predicate)

Filters query results that contain only rows from the given table that match one ore more rows in other tables.

Parameters:

table - the table to join.

alias - the alias of the given table.

predicate - the condition on which tables are joined.

Returns:

a Select object for further query construction.

leftJoin

public Select leftJoin(java.lang.Class<?> table,
              Predicate predicate)

Filters query results that contain all rows from the tables before and only matching rows from the given table.

Parameters:

table - the table to join.

predicate - the condition on which tables are joined.

Returns:

a Select object for further query construction.

leftJoin

public Select leftJoin(java.lang.String table,
              Predicate predicate)

Filters query results that contain all rows from the tables before and only matching rows from the given table.

Parameters:

table - the table to join.

predicate - the condition on which tables are joined.

Returns:

a Select object for further query construction.

leftJoin

public Select leftJoin(java.lang.Class<?> table,
              java.lang.String alias,
              Predicate predicate)

Filters query results that contain all rows from the tables before and only matching rows from the given table.

Parameters:

table - the table to join.

alias - the alias of the given table.

predicate - the condition on which tables are joined.

Returns:

a Select object for further query construction.

leftJoin

public Select leftJoin(java.lang.String table,
              java.lang.String alias,
              Predicate predicate)

Filters query results that contain all rows from the tables before and only matching rows from the given table.

Parameters:

table - the table to join.

alias - the alias of the given table.

predicate - the condition on which tables are joined.

Returns:

a Select object for further query construction.

rightJoin

public Select rightJoin(java.lang.Class<?> table,
               Predicate predicate)

Filters query results that contain only matching rows from the given table and all rows from the tables before.

Parameters:

table - the table to join.

predicate - the condition on which tables are joined.

Returns:

a Select object for further query construction.

rightJoin

public Select rightJoin(java.lang.String table,
               Predicate predicate)

Filters query results that contain only matching rows from the given table and all rows from the tables before.

Parameters:

table - the table to join.

predicate - the condition on which tables are joined.

Returns:

a Select object for further query construction.

rightJoin

public Select rightJoin(java.lang.Class<?> table,
               java.lang.String alias,
               Predicate predicate)

Filters query results that contain only matching rows from the given table and all rows from the tables before.

Parameters:

table - the table to join.

alias - the alias of the given table.

predicate - the condition on which tables are joined.

Returns:

a Select object for further query construction.

rightJoin

public Select rightJoin(java.lang.String table,
               java.lang.String alias,
               Predicate predicate)

Filters query results that contain only matching rows from the given table and all rows from the tables before.

Parameters:

table - the table to join.

alias - the alias of the given table.

predicate - the condition on which tables are joined.

Returns:

a Select object for further query construction.

where

public Select where(Predicate predicate)

Specifies filter conditions that determine the rows that the query returns.

where(Predicate) must not be called after calling having(Predicate).

Parameters:

predicate - the conditions on which the tables are joined.

Returns:

a Select object for further query construction.

groupBy

public Select groupBy(java.lang.String... columns)

Specifies one or more columns used to group rows returned by the

Parameters:

columns - one or more columns used to group rows returned by the

Returns:

a Select object for further query construction.

having

public Select having(Predicate predicate)

Specifies the conditions that determines the groups included in the query result set.

where(Predicate) must not be called after calling having(Predicate).

Parameters:

predicate - the conditions that determines the groups included in the

Returns:

a Select object for further query construction.

orderBy

public Select orderBy(java.lang.String... columns)

Specifies one or more items used to sort the final query result set and the order for sorting the results.

Parameters:

columns - the items used to sort the final query result set.

Returns:

a Select object for further query construction.

orderBy

public Select orderBy(java.lang.String column,
             boolean descending)

Specifies one or more items used to sort the final query result set and the order for sorting the results.

Parameters:

column - the item used to sort the final query result set.

descending - true if the item is to be sorted in descending order; otherwise, false.

Returns:

a Select object for further query construction.

limit

public Select limit(int limit)

Specifies an upper bound on the number of rows returned by the

Parameters:

limit - an upper bound on the number of rows returned by the

Returns:

a Select object for further query construction.

offset

public Select offset(int offset)

Omits the first offset rows from the query result set.

Parameters:

offset - the number of rows to omit from the start of the query result set.

Returns:

a Select object for further query construction.

build

public Query build()

Builds a SQL statement and abstracts it in a Query object ready for execution.

Specified by:

build in class QueryBuilder

Returns:

a Query object ready for execution.