Open Source Repository

Home /spring/spring-jdbc-3.0.5 | Repository Home


org/springframework/jdbc/object/SqlUpdate.java
/*
 * Copyright 2002-2008 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.jdbc.object;

import java.util.Map;
import javax.sql.DataSource;

import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.JdbcUpdateAffectedIncorrectNumberOfRowsException;
import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
import org.springframework.jdbc.core.namedparam.NamedParameterUtils;
import org.springframework.jdbc.core.namedparam.ParsedSql;
import org.springframework.jdbc.support.KeyHolder;

/**
 * Reusable operation object representing a SQL update.
 *
 <p>This class provides a number of <code>update</code> methods,
 * analogous to the <code>execute</code> methods of query objects.
 *
 <p>This class is concrete. Although it can be subclassed (for example
 * to add a custom update method) it can easily be parameterized by setting
 * SQL and declaring parameters.
 *
 <p>Like all <code>RdbmsOperation</code> classes that ship with the Spring
 * Framework, <code>SqlQuery</code> instances are thread-safe after their
 * initialization is complete. That is, after they are constructed and configured
 * via their setter methods, they can be used safely from multiple threads.
 *
 @author Rod Johnson
 @author Thomas Risberg
 @author Juergen Hoeller
 @see SqlQuery
 */
public class SqlUpdate extends SqlOperation {

  /**
   * Maximum number of rows the update may affect. If more are
   * affected, an exception will be thrown. Ignored if 0.
   */
  private int maxRowsAffected = 0;

  /**
   * An exact number of rows that must be affected.
   * Ignored if 0.
   */
  private int requiredRowsAffected = 0;


  /**
   * Constructor to allow use as a JavaBean. DataSource and SQL
   * must be supplied before compilation and use.
   @see #setDataSource
   @see #setSql
   */
  public SqlUpdate() {
  }

  /**
   * Constructs an update object with a given DataSource and SQL.
   @param ds DataSource to use to obtain connections
   @param sql SQL statement to execute
   */
  public SqlUpdate(DataSource ds, String sql) {
    setDataSource(ds);
    setSql(sql);
  }

  /**
   * Construct an update object with a given DataSource, SQL
   * and anonymous parameters.
   @param ds DataSource to use to obtain connections
   @param sql SQL statement to execute
   @param types SQL types of the parameters, as defined in the
   <code>java.sql.Types</code> class
   @see java.sql.Types
   */
  public SqlUpdate(DataSource ds, String sql, int[] types) {
    setDataSource(ds);
    setSql(sql);
    setTypes(types);
  }

  /**
   * Construct an update object with a given DataSource, SQL,
   * anonymous parameters and specifying the maximum number of rows
   * that may be affected.
   @param ds DataSource to use to obtain connections
   @param sql SQL statement to execute
   @param types SQL types of the parameters, as defined in the
   <code>java.sql.Types</code> class
   @param maxRowsAffected the maximum number of rows that may
   * be affected by the update
   @see java.sql.Types
   */
  public SqlUpdate(DataSource ds, String sql, int[] types, int maxRowsAffected) {
    setDataSource(ds);
    setSql(sql);
    setTypes(types);
    this.maxRowsAffected = maxRowsAffected;
  }


  /**
   * Set the maximum number of rows that may be affected by this update.
   * The default value is 0, which does not limit the number of rows affected.
   @param maxRowsAffected the maximum number of rows that can be affected by
   * this update without this class's update method considering it an error
   */
  public void setMaxRowsAffected(int maxRowsAffected) {
    this.maxRowsAffected = maxRowsAffected;
  }

  /**
   * Set the <i>exact</i> number of rows that must be affected by this update.
   * The default value is 0, which allows any number of rows to be affected.
   <p>This is an alternative to setting the <i>maximum</i> number of rows
   * that may be affected.
   @param requiredRowsAffected the exact number of rows that must be affected
   * by this update without this class's update method considering it an error
   */
  public void setRequiredRowsAffected(int requiredRowsAffected) {
    this.requiredRowsAffected = requiredRowsAffected;
  }

  /**
   * Check the given number of affected rows against the
   * specified maximum number or required number.
   @param rowsAffected the number of affected rows
   @throws JdbcUpdateAffectedIncorrectNumberOfRowsException
   * if the actually affected rows are out of bounds
   @see #setMaxRowsAffected
   @see #setRequiredRowsAffected
   */
  protected void checkRowsAffected(int rowsAffectedthrows JdbcUpdateAffectedIncorrectNumberOfRowsException {
    if (this.maxRowsAffected > && rowsAffected > this.maxRowsAffected) {
      throw new JdbcUpdateAffectedIncorrectNumberOfRowsException(getSql()this.maxRowsAffected, rowsAffected);
    }
    if (this.requiredRowsAffected > && rowsAffected != this.requiredRowsAffected) {
      throw new JdbcUpdateAffectedIncorrectNumberOfRowsException(getSql()this.requiredRowsAffected, rowsAffected);
    }
  }


  /**
   * Generic method to execute the update given parameters.
   * All other update methods invoke this method.
   @param params array of parameters objects
   @return the number of rows affected by the update
   */
  public int update(Object... paramsthrows DataAccessException {
    validateParameters(params);
    int rowsAffected = getJdbcTemplate().update(newPreparedStatementCreator(params));
    checkRowsAffected(rowsAffected);
    return rowsAffected;
  }

  /**
   * Method to execute the update given arguments and 
   * retrieve the generated keys using a KeyHolder.
   @param params array of parameter objects
   @param generatedKeyHolder KeyHolder that will hold the generated keys
   @return the number of rows affected by the update
   */
  public int update(Object[] params, KeyHolder generatedKeyHolderthrows DataAccessException {
    validateParameters(params);
    int rowsAffected = getJdbcTemplate().update(newPreparedStatementCreator(params), generatedKeyHolder);
    checkRowsAffected(rowsAffected);
    return rowsAffected;
  }

  /**
   * Convenience method to execute an update with no parameters.
   */
  public int update() throws DataAccessException {
    return update((Object[]) null);
  }

  /**
   * Convenient method to execute an update given one int arg.
   */
  public int update(int p1throws DataAccessException {
    return update(new Object[] {p1});
  }

  /**
   * Convenient method to execute an update given two int args.
   */
  public int update(int p1, int p2throws DataAccessException {
    return update(new Object[] {p1, p2});
  }

  /**
   * Convenient method to execute an update given one long arg.
   */
  public int update(long p1throws DataAccessException {
    return update(new Object[] {p1});
  }

  /**
   * Convenient method to execute an update given two long args.
   */
  public int update(long p1, long p2throws DataAccessException {
    return update(new Object[] {p1, p2});
  }

  /**
   * Convenient method to execute an update given one String arg.
   */
  public int update(String pthrows DataAccessException {
    return update(new Object[] {p});
  }

  /**
   * Convenient method to execute an update given two String args.
   */
  public int update(String p1, String p2throws DataAccessException {
    return update(new Object[] {p1, p2});
  }

  /**
   * Generic method to execute the update given named parameters.
   * All other update methods invoke this method.
   @param paramMap Map of parameter name to parameter object,
   * matching named parameters specified in the SQL statement
   @return the number of rows affected by the update
   */
  public int updateByNamedParam(Map<String, ?> paramMapthrows DataAccessException {
    validateNamedParameters(paramMap);
    ParsedSql parsedSql = getParsedSql();
    MapSqlParameterSource paramSource = new MapSqlParameterSource(paramMap);
    String sqlToUse = NamedParameterUtils.substituteNamedParameters(parsedSql, paramSource);
    Object[] params = NamedParameterUtils.buildValueArray(parsedSql, paramSource, getDeclaredParameters());
    int rowsAffected = getJdbcTemplate().update(newPreparedStatementCreator(sqlToUse, params));
    checkRowsAffected(rowsAffected);
    return rowsAffected;
  }

  /**
   * Method to execute the update given arguments and
   * retrieve the generated keys using a KeyHolder.
   @param paramMap Map of parameter name to parameter object,
   * matching named parameters specified in the SQL statement
   @param generatedKeyHolder KeyHolder that will hold the generated keys
   @return the number of rows affected by the update
   */
  public int updateByNamedParam(Map<String, ?> paramMap, KeyHolder generatedKeyHolderthrows DataAccessException {
    validateNamedParameters(paramMap);
    ParsedSql parsedSql = getParsedSql();
    MapSqlParameterSource paramSource = new MapSqlParameterSource(paramMap);
    String sqlToUse = NamedParameterUtils.substituteNamedParameters(parsedSql, paramSource);
    Object[] params = NamedParameterUtils.buildValueArray(parsedSql, paramSource, getDeclaredParameters());
    int rowsAffected = getJdbcTemplate().update(newPreparedStatementCreator(sqlToUse, params), generatedKeyHolder);
    checkRowsAffected(rowsAffected);
    return rowsAffected;
  }

}