net.zer0bandwidth.android.lib.content.querybuilder

Class SelectionBuilder

java.lang.Object

net.zer0bandwidth.android.lib.content.querybuilder.QueryBuilder<SelectionBuilder,android.database.Cursor>

net.zer0bandwidth.android.lib.content.querybuilder.SelectionBuilder

public class SelectionBuilder
extends QueryBuilder<SelectionBuilder,android.database.Cursor>

Builds an insertion query against a given ContentResolver and Uri.

Examples

     Cursor crs = QueryBuilder.selectFrom( rslv, uri )
             .allColumns()
             .where( "entity_id=?", sID )
             .execute()
             ;
 

     Cursor crs = QueryBuilder.selectFrom( rslv, uri )
             .columns( "entity_id", "name", "start_ts", "stop_ts" )
             .where( "start_ts>?", TimeUtils.now() )
             .orderBy( "name", ContentUtils.QUERY_ORDER_ASCENDING )
             .execute()
             ;
 

Since:

zer0bandwidth-net/android 0.1.7 (#39)

See Also:

ContentUtils.QUERY_ORDER_ASCENDING, ContentUtils.QUERY_ORDER_DESCENDING

Nested Class Summary

Nested classes/interfaces inherited from class net.zer0bandwidth.android.lib.content.querybuilder.QueryBuilder

QueryBuilder.ExecutionException, QueryBuilder.UnboundException

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	LOG_TAG
protected java.util.LinkedHashMap<java.lang.String,java.lang.String>	m_mapSortSpec The mapping of sortable columns to sorting directions, if any.
protected java.util.Vector<java.lang.String>	m_vColumns The columns to be included in the result set.

Fields inherited from class net.zer0bandwidth.android.lib.content.querybuilder.QueryBuilder

m_asExplicitWhereParams, m_rslv, m_sExplicitWhereFormat, m_uri, m_valsToWrite

Constructor Summary

Constructors

Constructor and Description
SelectionBuilder()
SelectionBuilder(android.content.ContentResolver rslv, android.net.Uri uri)
SelectionBuilder(android.content.Context ctx, android.net.Uri uri)

Method Summary

Modifier and Type	Method and Description
SelectionBuilder	allColumns() Specifies that all columns should be included in the result set.
SelectionBuilder	columns(java.util.Collection<java.lang.String> asColumns) Sets the columns that should be included in the result set.
SelectionBuilder	columns(java.lang.String... asColumns) Sets the columns that should be included in the result set.
android.database.Cursor	executeOrCancel(android.os.CancellationSignal sig) (API 16+) Selects results from the data context, while allowing the query to be cancelled in response to the specified signal.
android.database.Cursor	executeOrCancel(android.content.ContentResolver rslv, android.net.Uri uri, android.os.CancellationSignal sig) (API 16+) Selects results from the data context, while allowing the query to be cancelled in response to the specified signal.
android.database.Cursor	executeQuery(android.content.ContentResolver rslv, android.net.Uri uri) Selects results from the data context.
protected java.lang.String[]	getColumns() Generates the list of columns to be included in the result set, as an array of strings to be passed to ContentResolver.query(android.net.Uri, java.lang.String[], java.lang.String, java.lang.String[], java.lang.String).
protected java.lang.String	getSortSpecString() Generates the selection's sort criteria as a string, to be supplied to ContentResolver.query(android.net.Uri, java.lang.String[], java.lang.String, java.lang.String[], java.lang.String).
protected SelectionBuilder	initColumns() Initializes the vector of columns to be included in the result set.
protected SelectionBuilder	initSortSpec() Initializes the map of sortable columns to sorting directions.
SelectionBuilder	orderBy(java.lang.String sColumn) Adds a sorting specification to the query.
SelectionBuilder	orderBy(java.lang.String sColumn, java.lang.String sDirection) Adds a sorting specification to the query.
android.os.Bundle	toBundle() Creates a bundle that describes the query itself, not the result set that it would select.

Methods inherited from class net.zer0bandwidth.android.lib.content.querybuilder.QueryBuilder

delete, deleteFrom, deleteFrom, execute, executeOn, executeOn, getContentResolver, getWhereFormat, getWhereParams, insert, insertInto, insertInto, onDataSource, onDataSource, select, selectFrom, selectFrom, setValues, update, update, update, validateDataContextBinding, where, where, where

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

protected static final java.lang.String LOG_TAG

m_vColumns

protected java.util.Vector<java.lang.String> m_vColumns

The columns to be included in the result set.

m_mapSortSpec

protected java.util.LinkedHashMap<java.lang.String,java.lang.String> m_mapSortSpec

The mapping of sortable columns to sorting directions, if any. This is a LinkedHashMap because we want to preserve the order in which sort keys were added to the order spec. (#52)

Constructor Detail

SelectionBuilder

public SelectionBuilder(android.content.ContentResolver rslv,
                        android.net.Uri uri)

SelectionBuilder

public SelectionBuilder(android.content.Context ctx,
                        android.net.Uri uri)

SelectionBuilder

public SelectionBuilder()

Method Detail

initColumns

protected SelectionBuilder initColumns()

Initializes the vector of columns to be included in the result set.

Returns:

(fluid)

initSortSpec

protected SelectionBuilder initSortSpec()

Initializes the map of sortable columns to sorting directions.

Returns:

(fluid)

allColumns

public SelectionBuilder allColumns()

Specifies that all columns should be included in the result set. This is the default behavior if left unspecified.

Returns:

(fluid)

columns

public SelectionBuilder columns(java.lang.String... asColumns)

Sets the columns that should be included in the result set. If selecting all columns, then do not pass null to this method; use allColumns() instead.

Parameters:

asColumns - the names of the columns to be included

Returns:

(fluid)

columns

public SelectionBuilder columns(java.util.Collection<java.lang.String> asColumns)

Sets the columns that should be included in the result set. If selecting all columns, then do not pass null to this method; use allColumns() instead.

Parameters:

asColumns - the names of the columns to be included

Returns:

(fluid)

getColumns

protected java.lang.String[] getColumns()

Generates the list of columns to be included in the result set, as an array of strings to be passed to ContentResolver.query(android.net.Uri, java.lang.String[], java.lang.String, java.lang.String[], java.lang.String).

Returns:

a list of column names, or null if all columns are to be included

orderBy

public SelectionBuilder orderBy(java.lang.String sColumn,
                                java.lang.String sDirection)

Adds a sorting specification to the query.

Parameters:

sColumn - the column to be added to the sort specification

sDirection - the direction

Returns:

(fluid)

See Also:

ContentUtils.QUERY_ORDER_ASCENDING, ContentUtils.QUERY_ORDER_DESCENDING

orderBy

public SelectionBuilder orderBy(java.lang.String sColumn)

Adds a sorting specification to the query. This column will be sorted in ascending order.

Parameters:

sColumn - the column to be added to the sort specification

Returns:

(fluid)

getSortSpecString

protected java.lang.String getSortSpecString()

Generates the selection's sort criteria as a string, to be supplied to ContentResolver.query(android.net.Uri, java.lang.String[], java.lang.String, java.lang.String[], java.lang.String).

Returns:

a sort specification

executeQuery

public android.database.Cursor executeQuery(android.content.ContentResolver rslv,
                                            android.net.Uri uri)

Selects results from the data context.

Specified by:

executeQuery in class QueryBuilder<SelectionBuilder,android.database.Cursor>

Parameters:

rslv - the resolver through which the query should be executed

uri - the URI at which the query should be executed

Returns:

a set of results from the data context

executeOrCancel

public android.database.Cursor executeOrCancel(android.os.CancellationSignal sig)
                                        throws QueryBuilder.UnboundException,
                                               QueryBuilder.ExecutionException

(API 16+) Selects results from the data context, while allowing the query to be cancelled in response to the specified signal.

Parameters:

sig - the signal which would cancel the query

Returns:

a set of results from the data context

Throws:

QueryBuilder.UnboundException

QueryBuilder.ExecutionException

executeOrCancel

public android.database.Cursor executeOrCancel(android.content.ContentResolver rslv,
                                               android.net.Uri uri,
                                               android.os.CancellationSignal sig)
                                        throws QueryBuilder.UnboundException,
                                               QueryBuilder.ExecutionException

(API 16+) Selects results from the data context, while allowing the query to be cancelled in response to the specified signal. Usually, this is not invoked directly, but is instead consumed by executeOrCancel(CancellationSignal).

Parameters:

rslv - the resolver through which the query should be executed

uri - the URI at which the query should be executed

sig - the signal which would cancel the query

Returns:

a set of results from the data context

Throws:

UnboundException - if the data context binding is inadequate

ExecutionException - if the underlying query fails

QueryBuilder.UnboundException

QueryBuilder.ExecutionException

toBundle

public android.os.Bundle toBundle()

Creates a bundle that describes the query itself, not the result set that it would select. Used to pass the query specification across an intent broadcast, in a provider/resolver model. The schema for this bundle is consistent and is defined as follows:

String uri

The URI at which the query is aimed.

String[] columns

The list of selection columns. Null implies all columns.

String where_format

The format string for the query's WHERE clause.

String[] where_params

The list of parameters to be substituted in the query's WHERE clause format string.

String[] order_by_cols (optional)

The list of columns on which the query is to be sorted.

String[] order_by_dirs (optional)

The list of sort directions (ascending/descending) for each column mentioned in order_by_cols.

Returns:

a bundle describing the selection query itself

Since:

zer0bandwidth-net/android 0.1.7 (#50)