org.springframework.jdbc.core.namedparam
Class NamedParameterUtils

java.lang.Object
  org.springframework.jdbc.core.namedparam.NamedParameterUtils

public abstract class NamedParameterUtils
extends Object

Helper methods for named parameter parsing. Only intended for internal use within Spring's JDBC framework.

Since:

2.0

Author:

Thomas Risberg, Juergen Hoeller

Constructor Summary

NamedParameterUtils()

Method Summary

(package private) static int[]	buildSqlTypeArray(ParsedSql parsedSql, SqlParameterSource paramSource) Convert a Map of parameter types to a corresponding int array.
(package private) static Object[]	buildValueArray(ParsedSql parsedSql, SqlParameterSource paramSource) Convert a Map of named parameter values to a corresponding array.
static Object[]	buildValueArray(String sql, Map paramMap) Convert a Map of named parameter values to a corresponding array.
(package private) static ParsedSql	parseSqlStatement(String sql) Parse the SQL statement and locate any placeholders or named parameters.
static String	parseSqlStatementIntoString(String sql) Parse the SQL statement and locate any placeholders or named parameters.
static String	substituteNamedParameters(String sql, SqlParameterSource paramSource) Parse the SQL statement and locate any placeholders or named parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

NamedParameterUtils

public NamedParameterUtils()

Method Detail

parseSqlStatementIntoString

public static String parseSqlStatementIntoString(String sql)

Parse the SQL statement and locate any placeholders or named parameters. Named parameters are substituted for a JDBC placeholder.

Parameters:

sql - the SQL statement

parseSqlStatement

static ParsedSql parseSqlStatement(String sql)

Parse the SQL statement and locate any placeholders or named parameters. Named parameters are substituted for a JDBC placeholder.

Parameters:

sql - the SQL statement

Returns:

the parsed statement, represented as ParsedSql instance

substituteNamedParameters

public static String substituteNamedParameters(String sql,
                                               SqlParameterSource paramSource)

Parse the SQL statement and locate any placeholders or named parameters. Named parameters are substituted for a JDBC placeholder and any select list is expanded to the required number of placeholders.

The parameter values passed in are used to determine the number of placeholder to be used for a select list. Select lists should be limited to 100 or fewer elements. A larger number of elements is not guaramteed to be supported by the database and is strictly vendor-dependent.

Parameters:

sql - the SQL statement

paramSource - the source for named parameters

Returns:

the SQL statement with substituted parameters

buildValueArray

public static Object[] buildValueArray(String sql,
                                       Map paramMap)

Convert a Map of named parameter values to a corresponding array.

This is necessary in order to reuse existing methods on JdbcTemplate. See below for additional info.

Parameters:

sql - the SQL statement

paramMap - the Map of parameters

buildValueArray

static Object[] buildValueArray(ParsedSql parsedSql,
                                SqlParameterSource paramSource)

Convert a Map of named parameter values to a corresponding array. This is necessary in order to reuse existing methods on JdbcTemplate. Any named parameters are placed in the correct position in the Object array based on the parsed SQL statement info.

Parameters:

parsedSql - the parsed SQL statement

paramSource - the source for named parameters

buildSqlTypeArray

static int[] buildSqlTypeArray(ParsedSql parsedSql,
                               SqlParameterSource paramSource)

Convert a Map of parameter types to a corresponding int array. This is necessary in order to reuse existing methods on JdbcTemplate. Any named parameter types are placed in the correct position in the Object array based on the parsed SQL statement info.

Parameters:

parsedSql - the parsed SQL statement

paramSource - the source for named parameters