net.zer0bandwidth.android.lib.content.querybuilder

Class DeletionBuilder

java.lang.Object

net.zer0bandwidth.android.lib.content.querybuilder.QueryBuilder<DeletionBuilder,java.lang.Integer>

net.zer0bandwidth.android.lib.content.querybuilder.DeletionBuilder

public class DeletionBuilder
extends QueryBuilder<DeletionBuilder,java.lang.Integer>

Builds a deletion query against a given ContentResolver and Uri.

Examples

Delete all records in the data context:

     int nDeleted = QueryBuilder.deleteFrom( rslv, uri )
             .deleteAll()
             .execute()
             ;
 

Delete selected records from a data context:

     int nDeleted = QueryBuilder.deleteFrom( rslv, uri )
             .where( "reasons_to_delete>?", Integer.toString(0) )
             .execute()
             ;
 

Since:

zer0bandwidth-net/android 0.1.7 (#39)

Nested Class Summary

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

QueryBuilder.ExecutionException, QueryBuilder.UnboundException

Field Summary

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
DeletionBuilder()
DeletionBuilder(android.content.ContentResolver rslv, android.net.Uri uri)
DeletionBuilder(android.content.Context ctx, android.net.Uri uri)

Method Summary

Modifier and Type	Method and Description
DeletionBuilder	deleteAll() Convenience grammar specifying that all rows should be deleted from the data context.
java.lang.Integer	executeQuery(android.content.ContentResolver rslv, android.net.Uri uri) Deletes rows from the data context based on the builder's current state.

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

Constructor Detail

DeletionBuilder

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

DeletionBuilder

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

DeletionBuilder

public DeletionBuilder()

Method Detail

deleteAll

public DeletionBuilder deleteAll()

Convenience grammar specifying that all rows should be deleted from the data context.

Returns:

(fluid)

executeQuery

public java.lang.Integer executeQuery(android.content.ContentResolver rslv,
                                      android.net.Uri uri)
                               throws java.lang.Exception

Deletes rows from the data context based on the builder's current state.

Specified by:

executeQuery in class QueryBuilder<DeletionBuilder,java.lang.Integer>

Parameters:

rslv - the resolver through which the query should be executed

uri - the URI at which the query should be executed

Returns:

the number of rows deleted

Throws:

java.lang.Exception - if anything goes wrong