net.zer0bandwidth.android.lib.database.querybuilder

Class UpdateBuilder

java.lang.Object

net.zer0bandwidth.android.lib.database.querybuilder.QueryBuilder<UpdateBuilder,java.lang.Integer>

net.zer0bandwidth.android.lib.database.querybuilder.UpdateBuilder

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

Builds a SQLite UPDATE query.

Examples

Update all rows.

 int nUpdated = QueryBuilder.update( sTableName )
     .setValues( vals )
     .updateAll()
     .executeOn( db )
     ;
 

Update specific rows, specifying that conflicts should be ignored.

 int nUpdated = QueryBuilder.update( sTableName )
     .setValues( vals )
     .where( "some_column=?", sBogusValue )
     .onConflict( SQLiteDatabase.CONFLICT_IGNORE )
     .executeOn( db )
     ;
 

Since:

zer0bandwidth-net/android 0.1.1 (#20)

See Also:

SQLiteDatabase.updateWithOnConflict(String, ContentValues, String, String[], int)

Nested Class Summary

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

QueryBuilder.UnboundException

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	LOG_TAG
protected int	m_zConflictAlgorithmID The numeric ID of the conflict resolution algorithm provided by Android.

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

m_asExplicitWhereParams, m_dbTarget, m_sExplicitWhereFormat, m_sTableName, m_valsToWrite

Constructor Summary

Constructors

Constructor and Description
UpdateBuilder(java.lang.String sTableName)

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	executeOn(android.database.sqlite.SQLiteDatabase db) Executes an update query on the value that has been appended to the builder.
UpdateBuilder	onConflict(int zAlgorithmID) Selects, by its numeric ID, the conflict resolution algorithm provided by Android.
java.lang.String	toString()
UpdateBuilder	updateAll() Convenience grammar specifying that all rows should be updated.

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

deleteFrom, deleteFrom, execute, getWhereClause, getWhereFormat, getWhereParams, insertInto, insertInto, onDatabase, selectFrom, selectFrom, setTableName, setValues, toSQLInputParams, update, update, where, where, where

Methods inherited from class java.lang.Object

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

Field Detail

LOG_TAG

protected static final java.lang.String LOG_TAG

m_zConflictAlgorithmID

protected int m_zConflictAlgorithmID

The numeric ID of the conflict resolution algorithm provided by Android. By default, no conflict resolution algorithm is requested.

See Also:

SQLiteDatabase.CONFLICT_ABORT, SQLiteDatabase.CONFLICT_FAIL, SQLiteDatabase.CONFLICT_IGNORE, SQLiteDatabase.CONFLICT_NONE, SQLiteDatabase.CONFLICT_REPLACE, SQLiteDatabase.CONFLICT_ROLLBACK

Constructor Detail

UpdateBuilder

public UpdateBuilder(java.lang.String sTableName)

Method Detail

updateAll

public UpdateBuilder updateAll()

Convenience grammar specifying that all rows should be updated.

Returns:

(fluid)

onConflict

public UpdateBuilder onConflict(int zAlgorithmID)

Selects, by its numeric ID, the conflict resolution algorithm provided by Android.

Parameters:

zAlgorithmID - the ID of the algorithm to use

Returns:

(fluid)

executeOn

public java.lang.Integer executeOn(android.database.sqlite.SQLiteDatabase db)

Executes an update query on the value that has been appended to the builder.

Specified by:

executeOn in class QueryBuilder<UpdateBuilder,java.lang.Integer>

Parameters:

db - the database instance on which the query should be executed

Returns:

the number of rows that were modified, or SQLiteSyntax.UPDATE_FAILED if the update operation could not proceed

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object