org.springframework.jdbc.object.SqlOperation Maven / Gradle / Ivy
/*
* Copyright 2002-2005 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 org.springframework.dao.InvalidDataAccessApiUsageException;
import org.springframework.jdbc.core.PreparedStatementCreator;
import org.springframework.jdbc.core.PreparedStatementCreatorFactory;
import org.springframework.jdbc.core.PreparedStatementSetter;
import org.springframework.jdbc.support.JdbcUtils;
/**
* RdbmsOperation using a JdbcTemplate and representing a SQL-based
* operation such as a query or update, as opposed to a stored procedure.
*
* Configures a PreparedStatementCreatorFactory based on the
* declared parameters.
*
* @author Rod Johnson
* @author Juergen Hoeller
* @see PreparedStatementCreatorFactory
*/
public abstract class SqlOperation extends RdbmsOperation {
/**
* Object enabling us to create PreparedStatementCreators
* efficiently, based on this class's declared parameters.
*/
private PreparedStatementCreatorFactory preparedStatementFactory;
/**
* Overridden method to configure the PreparedStatementCreatorFactory
* based on our declared parameters.
*/
protected final void compileInternal() {
// validate parameter count
try {
int bindVarCount = JdbcUtils.countParameterPlaceholders(getSql(), '?', "'\"");
if (bindVarCount != getDeclaredParameters().size()) {
throw new InvalidDataAccessApiUsageException(
"SQL '" + getSql() + "' requires " + bindVarCount + " bind variables, but " +
getDeclaredParameters().size() + " variables were declared for this object");
}
}
catch (IllegalArgumentException ex) {
// transform JDBC-agnostic error to data access error
throw new InvalidDataAccessApiUsageException(ex.getMessage());
}
this.preparedStatementFactory = new PreparedStatementCreatorFactory(getSql(), getDeclaredParameters());
this.preparedStatementFactory.setResultSetType(getResultSetType());
this.preparedStatementFactory.setUpdatableResults(isUpdatableResults());
this.preparedStatementFactory.setReturnGeneratedKeys(isReturnGeneratedKeys());
if (getGeneratedKeysColumnNames() != null) {
this.preparedStatementFactory.setGeneratedKeysColumnNames(getGeneratedKeysColumnNames());
}
this.preparedStatementFactory.setNativeJdbcExtractor(getJdbcTemplate().getNativeJdbcExtractor());
onCompileInternal();
}
/**
* Hook method that subclasses may override to post-process compilation.
* This implementation does nothing.
* @see #compileInternal
*/
protected void onCompileInternal() {
}
/**
* Return a PreparedStatementCreator to perform an operation
* with the given parameters.
* @param params parameter array. May be null.
*/
protected final PreparedStatementCreator newPreparedStatementCreator(Object[] params) {
return this.preparedStatementFactory.newPreparedStatementCreator(params);
}
/**
* Return a PreparedStatementSetter to perform an operation
* with the given parameters.
* @param params parameter array. May be null.
*/
protected final PreparedStatementSetter newPreparedStatementSetter(Object[] params) {
return this.preparedStatementFactory.newPreparedStatementSetter(params);
}
}