Open Source Repository

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


org/springframework/jdbc/core/simple/SimpleJdbcTemplate.java
/*
 * Copyright 2002-2009 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.core.simple;

import java.util.List;
import java.util.Map;

import javax.sql.DataSource;

import org.springframework.dao.DataAccessException;
import org.springframework.jdbc.core.JdbcOperations;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.jdbc.core.BatchUpdateUtils;
import org.springframework.jdbc.core.namedparam.NamedParameterJdbcOperations;
import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
import org.springframework.jdbc.core.namedparam.SqlParameterSource;
import org.springframework.util.ObjectUtils;

/**
 * Java-5-based convenience wrapper for the classic Spring
 {@link org.springframework.jdbc.core.JdbcTemplate},
 * taking advantage of varargs and autoboxing, and exposing only the most
 * commonly required operations in order to simplify JdbcTemplate usage.
 *
 <p>Use the {@link #getJdbcOperations()} method (or a straight JdbcTemplate)
 * if you need to invoke less commonly used template methods. This includes
 * any methods specifying SQL types, methods using less commonly used callbacks
 * such as RowCallbackHandler, updates with PreparedStatementSetters rather than
 * argument arrays, and stored procedures as well as batch operations.
 
 @author Rod Johnson
 @author Rob Harrop
 @author Juergen Hoeller
 @author Thomas Risberg
 @since 2.0
 @see ParameterizedRowMapper
 @see SimpleJdbcDaoSupport
 @see org.springframework.jdbc.core.JdbcTemplate
 */
public class SimpleJdbcTemplate implements SimpleJdbcOperations {
  
  /** The NamedParameterJdbcTemplate that we are wrapping */
  private final NamedParameterJdbcOperations namedParameterJdbcOperations;


  /**
   * Create a new SimpleJdbcTemplate for the given DataSource.
   <p>Creates a classic Spring JdbcTemplate and wraps it.
   @param dataSource the JDBC DataSource to access
   */
  public SimpleJdbcTemplate(DataSource dataSource) {
    this.namedParameterJdbcOperations = new NamedParameterJdbcTemplate(dataSource);
  }

  /**
   * Create a new SimpleJdbcTemplate for the given classic Spring JdbcTemplate.
   @param classicJdbcTemplate the classic Spring JdbcTemplate to wrap
   */
  public SimpleJdbcTemplate(JdbcOperations classicJdbcTemplate) {
    this.namedParameterJdbcOperations = new NamedParameterJdbcTemplate(classicJdbcTemplate);
  }

  /**
   * Create a new SimpleJdbcTemplate for the given Spring NamedParameterJdbcTemplate.
   @param namedParameterJdbcTemplate the Spring NamedParameterJdbcTemplate to wrap
   */
  public SimpleJdbcTemplate(NamedParameterJdbcOperations namedParameterJdbcTemplate) {
    this.namedParameterJdbcOperations = namedParameterJdbcTemplate;
  }


  /**
   * Expose the classic Spring JdbcTemplate to allow invocation of
   * less commonly used methods.
   */
  public JdbcOperations getJdbcOperations() {
    return this.namedParameterJdbcOperations.getJdbcOperations();
  }

  /**
   * Expose the Spring NamedParameterJdbcTemplate to allow invocation of
   * less commonly used methods.
   */
  public NamedParameterJdbcOperations getNamedParameterJdbcOperations() {
    return this.namedParameterJdbcOperations;
  }


  public int queryForInt(String sql, Map<String, ?> argsthrows DataAccessException {
    return getNamedParameterJdbcOperations().queryForInt(sql, args);
  }

  public int queryForInt(String sql, SqlParameterSource argsthrows DataAccessException {
    return getNamedParameterJdbcOperations().queryForInt(sql, args);
  }

  public int queryForInt(String sql, Object... argsthrows DataAccessException {
    return (ObjectUtils.isEmpty(args?
          getJdbcOperations().queryForInt(sql:
          getJdbcOperations().queryForInt(sql, getArguments(args)));
  }

  public long queryForLong(String sql, Map<String, ?> argsthrows DataAccessException {
    return getNamedParameterJdbcOperations().queryForLong(sql, args);
  }

  public long queryForLong(String sql, SqlParameterSource argsthrows DataAccessException {
    return getNamedParameterJdbcOperations().queryForLong(sql, args);
  }

  public long queryForLong(String sql, Object... argsthrows DataAccessException {
    return (ObjectUtils.isEmpty(args?
          getJdbcOperations().queryForLong(sql:
          getJdbcOperations().queryForLong(sql, getArguments(args)));
  }

  public <T> T queryForObject(String sql, Class<T> requiredType, Map<String, ?> argsthrows DataAccessException {
    return getNamedParameterJdbcOperations().queryForObject(sql, args, requiredType);
  }

  public <T> T queryForObject(String sql, Class<T> requiredType, SqlParameterSource args)
      throws DataAccessException {
    return getNamedParameterJdbcOperations().queryForObject(sql, args, requiredType);
  }

  public <T> T queryForObject(String sql, Class<T> requiredType, Object... argsthrows DataAccessException {
    return (ObjectUtils.isEmpty(args?
        getJdbcOperations().queryForObject(sql, requiredType:
        getJdbcOperations().queryForObject(sql, getArguments(args), requiredType));
  }

  public <T> T queryForObject(String sql, RowMapper<T> rm, Map<String, ?> argsthrows DataAccessException {
    return getNamedParameterJdbcOperations().queryForObject(sql, args, rm);
  }

  @Deprecated
  public <T> T queryForObject(String sql, ParameterizedRowMapper<T> rm, Map<String, ?> argsthrows DataAccessException {
    return queryForObject(sql, (RowMapper<T>rm, args);
  }

  public <T> T queryForObject(String sql, RowMapper<T> rm, SqlParameterSource args)
      throws DataAccessException {
    return getNamedParameterJdbcOperations().queryForObject(sql, args, rm);
  }

  @Deprecated
  public <T> T queryForObject(String sql, ParameterizedRowMapper<T> rm, SqlParameterSource args)
      throws DataAccessException {
    return queryForObject(sql, (RowMapper<T>rm, args);
  }

  public <T> T queryForObject(String sql, RowMapper<T> rm, Object... argsthrows DataAccessException {
    return (ObjectUtils.isEmpty(args?
        getJdbcOperations().queryForObject(sql, rm):
        getJdbcOperations().queryForObject(sql, getArguments(args), rm));
  }

  @Deprecated
  public <T> T queryForObject(String sql, ParameterizedRowMapper<T> rm, Object... argsthrows DataAccessException {
    return queryForObject(sql, (RowMapper<T>rm, args);
  }

  public <T> List<T> query(String sql, RowMapper<T> rm, Map<String, ?> argsthrows DataAccessException {
    return getNamedParameterJdbcOperations().query(sql, args, rm);
  }

  @Deprecated
  public <T> List<T> query(String sql, ParameterizedRowMapper<T> rm, Map<String, ?> argsthrows DataAccessException {
    return query(sql, (RowMapper<T>rm, args);
  }

  public <T> List<T> query(String sql, RowMapper<T> rm, SqlParameterSource args)
      throws DataAccessException {
    return getNamedParameterJdbcOperations().query(sql, args, rm);
  }

  @Deprecated
  public <T> List<T> query(String sql, ParameterizedRowMapper<T> rm, SqlParameterSource args)
      throws DataAccessException {
    return query(sql, (RowMapper<T>rm, args);
  }

  public <T> List<T> query(String sql, RowMapper<T> rm, Object... argsthrows DataAccessException {
    return (ObjectUtils.isEmpty(args?
        getJdbcOperations().query(sql, rm:
        getJdbcOperations().query(sql, getArguments(args), rm));
  }

  @Deprecated
  public <T> List<T> query(String sql, ParameterizedRowMapper<T> rm, Object... argsthrows DataAccessException {
    return query(sql, (RowMapper<T>rm, args);
  }

  public Map<String, Object> queryForMap(String sql, Map<String, ?> argsthrows DataAccessException {
    return getNamedParameterJdbcOperations().queryForMap(sql, args);
  }

  public Map<String, Object> queryForMap(String sql, SqlParameterSource args)
      throws DataAccessException {
    return getNamedParameterJdbcOperations().queryForMap(sql, args);
  }

  public Map<String, Object> queryForMap(String sql, Object... argsthrows DataAccessException {
    return (ObjectUtils.isEmpty(args?
        getJdbcOperations().queryForMap(sql:
        getJdbcOperations().queryForMap(sql, getArguments(args)));
  }

  public List<Map<String, Object>> queryForList(String sql, Map<String, ?> argsthrows DataAccessException {
    return getNamedParameterJdbcOperations().queryForList(sql, args);
  }

  public List<Map<String, Object>> queryForList(String sql, SqlParameterSource args)
      throws DataAccessException {
    return getNamedParameterJdbcOperations().queryForList(sql, args);
  }

  public List<Map<String, Object>> queryForList(String sql, Object... argsthrows DataAccessException {
    return (ObjectUtils.isEmpty(args?
        getJdbcOperations().queryForList(sql:
        getJdbcOperations().queryForList(sql, getArguments(args)));
  }

  public int update(String sql, Map<String, ?> argsthrows DataAccessException {
    return getNamedParameterJdbcOperations().update(sql, args);
  }

  public int update(String sql, SqlParameterSource argsthrows DataAccessException {
    return getNamedParameterJdbcOperations().update(sql, args);
  }

  public int update(String sql, Object ... argsthrows DataAccessException {
    return (ObjectUtils.isEmpty(args?
        getJdbcOperations().update(sql:
        getJdbcOperations().update(sql, getArguments(args)));
  }

  public int[] batchUpdate(String sql, List<Object[]> batchArgs) {
    return batchUpdate(sql, batchArgs, new int[0]);
  }

  public int[] batchUpdate(String sql, List<Object[]> batchArgs, int[] argTypes) {
    return BatchUpdateUtils.executeBatchUpdate(sql, batchArgs, argTypes, getJdbcOperations());
  }

  public int[] batchUpdate(String sql, Map<String, ?>[] batchValues) {
    return getNamedParameterJdbcOperations().batchUpdate(sql, batchValues);
  }

  public int[] batchUpdate(String sql, SqlParameterSource[] batchArgs) {
    return getNamedParameterJdbcOperations().batchUpdate(sql, batchArgs);
  }


  /*
   * Considers an Object array passed into a varargs parameter as
   * collection of arguments rather than as single argument.
   */
  private Object[] getArguments(Object[] varArgs) {
    if (varArgs.length == && varArgs[0instanceof Object[]) {
      return (Object[]) varArgs[0];
    }
    else {
      return varArgs;
    }
  }

}