com.j256.ormlite.stmt

Class UpdateBuilder<T,ID>

java.lang.Object

com.j256.ormlite.stmt.StatementBuilder<T,ID>

com.j256.ormlite.stmt.UpdateBuilder<T,ID>

Type Parameters:

T - The class that the code will be operating on.

ID - The class of the ID column associated with the class. The T class does not require an ID field. The class needs an ID parameter however so you can use Void or Object to satisfy the compiler.

public class UpdateBuilder<T,ID>
extends StatementBuilder<T,ID>

Assists in building sql UPDATE statements for a particular table in a particular database.

Author:

graywatson

Nested Class Summary

Nested classes/interfaces inherited from class com.j256.ormlite.stmt.StatementBuilder

StatementBuilder.StatementInfo, StatementBuilder.StatementType, StatementBuilder.WhereOperation

Field Summary

Fields inherited from class com.j256.ormlite.stmt.StatementBuilder

addTableName, dao, databaseType, tableInfo, tableName, type, where

Constructor Summary

Constructors

Constructor and Description
UpdateBuilder(DatabaseType databaseType, TableInfo<T,ID> tableInfo, Dao<T,ID> dao)

Method Summary

Modifier and Type	Method and Description
protected void	appendStatementEnd(StringBuilder sb, List<ArgumentHolder> argList) Append the end of our statement string to the StringBuilder.
protected void	appendStatementStart(StringBuilder sb, List<ArgumentHolder> argList) Append the start of our statement string to the StringBuilder.
String	escapeColumnName(String columnName) Same as escapeColumnName(StringBuilder, String) but it will return the escaped string.
void	escapeColumnName(StringBuilder sb, String columnName) When you are building the expression for updateColumnExpression(String, String), you may need to escape column names since they may be reserved words to the database.
String	escapeValue(String value) Same as escapeValue(StringBuilder, String) but it will return the escaped string.
void	escapeValue(StringBuilder sb, String value) When you are building the expression for updateColumnExpression(String, String), you may need to escape values since they may be reserved words to the database.
UpdateBuilder<T,ID>	limit(Long maxRows) Limit the rows affected to maxRows maximum number of rows.
PreparedUpdate<T>	prepare() Build and return a prepared update that can be used by Dao.update(PreparedUpdate) method.
void	reset() Clear out all of the statement settings so we can reuse the builder.
int	update() A short cut to Dao.update(PreparedUpdate).
UpdateBuilder<T,ID>	updateColumnExpression(String columnName, String expression) Add a column to be set to a value for UPDATE statements.
UpdateBuilder<T,ID>	updateColumnValue(String columnName, Object value) Add a column to be set to a value for UPDATE statements.

Methods inherited from class com.j256.ormlite.stmt.StatementBuilder

appendStatementString, appendWhereStatement, buildStatementString, getResultFieldTypes, getTableName, prepareStatement, prepareStatementInfo, prepareStatementString, setWhere, shouldPrependTableNameToColumns, verifyColumnName, where

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateBuilder

public UpdateBuilder(DatabaseType databaseType,
                     TableInfo<T,ID> tableInfo,
                     Dao<T,ID> dao)

Method Detail

prepare

public PreparedUpdate<T> prepare()
                          throws SQLException

Build and return a prepared update that can be used by Dao.update(PreparedUpdate) method. If you change the where or make other calls you will need to re-call this method to re-prepare the statement for execution.

Throws:

SQLException

updateColumnValue

public UpdateBuilder<T,ID> updateColumnValue(String columnName,
                                             Object value)
                                      throws SQLException

Add a column to be set to a value for UPDATE statements. This will generate something like columnName = 'value' with the value escaped if necessary.

Throws:

SQLException

updateColumnExpression

public UpdateBuilder<T,ID> updateColumnExpression(String columnName,
                                                  String expression)
                                           throws SQLException

Add a column to be set to a value for UPDATE statements. This will generate something like 'columnName = expression' where the expression is built by the caller.

The expression should have any strings escaped using the escapeValue(String) or escapeValue(StringBuilder, String) methods and should have any column names escaped using the escapeColumnName(String) or escapeColumnName(StringBuilder, String) methods.

Throws:

SQLException

escapeColumnName

public void escapeColumnName(StringBuilder sb,
                             String columnName)

When you are building the expression for updateColumnExpression(String, String), you may need to escape column names since they may be reserved words to the database. This will help you by adding escape characters around the word.

escapeColumnName

public String escapeColumnName(String columnName)

Same as escapeColumnName(StringBuilder, String) but it will return the escaped string. The StringBuilder method is more efficient since this method creates a StringBuilder internally.

escapeValue

public void escapeValue(StringBuilder sb,
                        String value)

When you are building the expression for updateColumnExpression(String, String), you may need to escape values since they may be reserved words to the database. Numbers should not be escaped. This will help you by adding escape characters around the word.

escapeValue

public String escapeValue(String value)

Same as escapeValue(StringBuilder, String) but it will return the escaped string. Numbers should not be escaped. The StringBuilder method is more efficient since this method creates a StringBuilder internally.

update

public int update()
           throws SQLException

A short cut to Dao.update(PreparedUpdate).

Throws:

SQLException

limit

public UpdateBuilder<T,ID> limit(Long maxRows)

Limit the rows affected to maxRows maximum number of rows. Set to null for no limit (the default).

reset

public void reset()

Description copied from class: StatementBuilder

Clear out all of the statement settings so we can reuse the builder.

Overrides:

reset in class StatementBuilder<T,ID>

appendStatementStart

protected void appendStatementStart(StringBuilder sb,
                                    List<ArgumentHolder> argList)
                             throws SQLException

Description copied from class: StatementBuilder

Append the start of our statement string to the StringBuilder.

Specified by:

appendStatementStart in class StatementBuilder<T,ID>

Throws:

SQLException

appendStatementEnd

protected void appendStatementEnd(StringBuilder sb,
                                  List<ArgumentHolder> argList)

Description copied from class: StatementBuilder

Append the end of our statement string to the StringBuilder.

Specified by:

appendStatementEnd in class StatementBuilder<T,ID>