The Spring Framework

## org.springframework.jdbc.core.simple
Class AbstractJdbcInsert

    java.lang.Object
      org.springframework.jdbc.core.simple.AbstractJdbcInsert

Direct Known Subclasses:
  SimpleJdbcInsert

    public abstract class AbstractJdbcInsert

extends Object

Abstract class to provide base functionality for easy inserts based on configuration options and database metadata. This class provides the base SPI for `SimpleJdbcInsert`.

Since:
  2.5
Author:
  Thomas Risberg

Field Summary
`protected Log` `logger` Logger available to subclasses

Constructor Summary
`protected` `AbstractJdbcInsert(DataSource dataSource)` Constructor for sublasses to delegate to for setting the DataSource.
`protected` `AbstractJdbcInsert(JdbcTemplate jdbcTemplate)` Constructor for sublasses to delegate to for setting the JdbcTemplate.

Method Summary
`protected void` `checkCompiled()` Check whether this operation has been compiled already; lazily compile it if not already compiled.
`protected void` `checkIfConfigurationModificationIsAllowed()` Method to check whether we are allowd to make any configuration changes at this time.
`void` `compile()` Compile this JdbcInsert using provided parameters and meta data plus other settings.
`protected void` `compileInternal()` Method to perform the actual compilation.
`protected int` `doExecute(Map<String,Object> args)` Method that provides execution of the insert using the passed in Map of parameters
`protected int` `doExecute(SqlParameterSource parameterSource)` Method that provides execution of the insert using the passed in `SqlParameterSource`
`protected Number` `doExecuteAndReturnKey(Map<String,Object> args)` Method that provides execution of the insert using the passed in Map of parameters and returning a generated key
`protected Number` `doExecuteAndReturnKey(SqlParameterSource parameterSource)` Method that provides execution of the insert using the passed in `SqlParameterSource` and returning a generated key
`protected KeyHolder` `doExecuteAndReturnKeyHolder(Map<String,Object> args)` Method that provides execution of the insert using the passed in Map of parameters and returning all generated keys
`protected KeyHolder` `doExecuteAndReturnKeyHolder(SqlParameterSource parameterSource)` Method that provides execution of the insert using the passed in `SqlParameterSource` and returning all generated keys
`protected int[]` `doExecuteBatch(Map<String,Object>[] batch)` Method that provides execution of a batch insert using the passed in Maps of parameters
`protected int[]` `doExecuteBatch(SqlParameterSource[] batch)` Method that provides execution of a batch insert using the passed in array of `SqlParameterSource`
`String` `getCatalogName()` Get the name of the catalog for this insert
`List<String>` `getColumnNames()` Get the names of the columns used
`String[]` `getGeneratedKeyNames()` Get the names of any generated keys
`String` `getInsertString()` Get the insert string to be used
`int[]` `getInsertTypes()` Get the array of `Types` to be used for insert
`protected JdbcTemplate` `getJdbcTemplate()` Get the `JdbcTemplate` that is configured to be used
`String` `getSchemaName()` Get the name of the schema for this insert
`String` `getTableName()` Get the name of the table for this insert
`boolean` `isCompiled()` Is this operation "compiled"?
`protected List<Object>` `matchInParameterValuesWithInsertColumns(Map<String,Object> args)` Match the provided in parameter values with regitered parameters and parameters defined via metedata processing.
`protected List<Object>` `matchInParameterValuesWithInsertColumns(SqlParameterSource parameterSource)` Match the provided in parameter values with regitered parameters and parameters defined via metedata processing.
`protected void` `onCompileInternal()` Hook method that subclasses may override to react to compilation.
`void` `setCatalogName(String catalogName)` Set the name of the catalog for this insert
`void` `setColumnNames(List<String> columnNames)` Set the names of the columns to be used
`void` `setGeneratedKeyName(String generatedKeyName)` Specify the name of a single generated key column
`void` `setGeneratedKeyNames(String[] generatedKeyNames)` Set the names of any generated keys
`void` `setSchemaName(String schemaName)` Set the name of the schema for this insert
`void` `setTableName(String tableName)` Set the name of the table for this insert

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### logger

    protected final Log logger

  Logger available to subclasses

Constructor Detail

### AbstractJdbcInsert

    protected AbstractJdbcInsert(DataSource dataSource)

  Constructor for sublasses to delegate to for setting the DataSource.

### AbstractJdbcInsert

    protected AbstractJdbcInsert(JdbcTemplate jdbcTemplate)

  Constructor for sublasses to delegate to for setting the JdbcTemplate.

Method Detail

### getTableName

    public String getTableName()

  Get the name of the table for this insert

### setTableName

    public void setTableName(String tableName)

  Set the name of the table for this insert

### getSchemaName

    public String getSchemaName()

  Get the name of the schema for this insert

### setSchemaName

    public void setSchemaName(String schemaName)

  Set the name of the schema for this insert

### getCatalogName

    public String getCatalogName()

  Get the name of the catalog for this insert

### setCatalogName

    public void setCatalogName(String catalogName)

  Set the name of the catalog for this insert

### setColumnNames

    public void setColumnNames(List<String> columnNames)

  Set the names of the columns to be used

### getColumnNames

    public List<String> getColumnNames()

  Get the names of the columns used

### getGeneratedKeyNames

    public String[] getGeneratedKeyNames()

  Get the names of any generated keys

### setGeneratedKeyNames

    public void setGeneratedKeyNames(String[] generatedKeyNames)

  Set the names of any generated keys

### setGeneratedKeyName

    public void setGeneratedKeyName(String generatedKeyName)

  Specify the name of a single generated key column

### getInsertString

    public String getInsertString()

  Get the insert string to be used

### getInsertTypes

    public int[] getInsertTypes()

  Get the array of `Types` to be used for insert

### getJdbcTemplate

    protected JdbcTemplate getJdbcTemplate()

  Get the `JdbcTemplate` that is configured to be used

### compile

    public final void compile()
                       throws InvalidDataAccessApiUsageException

  Compile this JdbcInsert using provided parameters and meta data plus other settings. This finalizes the configuration for this object and subsequent attempts to compile are ignored. This will be implicitly called the first time an un-compiled insert is executed.

  Throws:
    `InvalidDataAccessApiUsageException` - if the object hasn't been correctly initialized, for example if no DataSource has been provided

### compileInternal

    protected void compileInternal()

  Method to perform the actual compilation. Subclasses can override this template method to perform their own compilation. Invoked after this base class's compilation is complete.

### onCompileInternal

    protected void onCompileInternal()

  Hook method that subclasses may override to react to compilation. This implementation does nothing.

### isCompiled

    public boolean isCompiled()

  Is this operation "compiled"?

  Returns:
    whether this operation is compiled, and ready to use.

### checkCompiled

    protected void checkCompiled()

  Check whether this operation has been compiled already; lazily compile it if not already compiled.

  Automatically called by `validateParameters`.

### checkIfConfigurationModificationIsAllowed

    protected void checkIfConfigurationModificationIsAllowed()

  Method to check whether we are allowd to make any configuration changes at this time. If the class has been compiled, then no further changes to the configuration are allowed.

### doExecute

    protected int doExecute(Map<String,Object> args)

  Method that provides execution of the insert using the passed in Map of parameters

  Parameters:
    `args` - Map with parameter names and values to be used in insert
  Returns:
    number of rows affected

### doExecute

    protected int doExecute(SqlParameterSource parameterSource)

  Method that provides execution of the insert using the passed in `SqlParameterSource`

  Parameters:
    `parameterSource` - parameter names and values to be used in insert
  Returns:
    number of rows affected

### doExecuteAndReturnKey

    protected Number doExecuteAndReturnKey(Map<String,Object> args)

  Method that provides execution of the insert using the passed in Map of parameters and returning a generated key

  Parameters:
    `args` - Map with parameter names and values to be used in insert
  Returns:
    the key generated by the insert

### doExecuteAndReturnKey

    protected Number doExecuteAndReturnKey(SqlParameterSource parameterSource)

  Method that provides execution of the insert using the passed in `SqlParameterSource` and returning a generated key

  Parameters:
    `parameterSource` - parameter names and values to be used in insert
  Returns:
    the key generated by the insert

### doExecuteAndReturnKeyHolder

    protected KeyHolder doExecuteAndReturnKeyHolder(Map<String,Object> args)

  Method that provides execution of the insert using the passed in Map of parameters and returning all generated keys

  Parameters:
    `args` - Map with parameter names and values to be used in insert
  Returns:
    the KeyHolder containing keys generated by the insert

### doExecuteAndReturnKeyHolder

    protected KeyHolder doExecuteAndReturnKeyHolder(SqlParameterSource parameterSource)

  Method that provides execution of the insert using the passed in `SqlParameterSource` and returning all generated keys

  Parameters:
    `parameterSource` - parameter names and values to be used in insert
  Returns:
    the KeyHolder containing keys generated by the insert

### doExecuteBatch

    protected int[] doExecuteBatch(Map<String,Object>[] batch)

  Method that provides execution of a batch insert using the passed in Maps of parameters

  Parameters:
    `batch` - array of Maps with parameter names and values to be used in batch insert
  Returns:
    array of number of rows affected

### doExecuteBatch

    protected int[] doExecuteBatch(SqlParameterSource[] batch)

  Method that provides execution of a batch insert using the passed in array of `SqlParameterSource`

  Parameters:
    `batch` - array of SqlParameterSource with parameter names and values to be used in insert
  Returns:
    array of number of rows affected

### matchInParameterValuesWithInsertColumns

    protected List<Object> matchInParameterValuesWithInsertColumns(SqlParameterSource parameterSource)

  Match the provided in parameter values with regitered parameters and parameters defined via metedata processing.

  Parameters:
    `parameterSource` - the parameter vakues provided as a `SqlParameterSource`
  Returns:
    Map with parameter names and values

### matchInParameterValuesWithInsertColumns

    protected List<Object> matchInParameterValuesWithInsertColumns(Map<String,Object> args)

  Match the provided in parameter values with regitered parameters and parameters defined via metedata processing.

  Parameters:
    `args` - the parameter values provided in a Map
  Returns:
    Map with parameter names and values

The Spring Framework

Copyright © 2002-2008 The Spring Framework.