1 /*
2 * Copyright 2002-2012 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.springframework.jdbc.core;
18
19 import java.sql.PreparedStatement;
20 import java.sql.SQLException;
21
22 /**
23 * Batch update callback interface used by the {@link JdbcTemplate} class.
24 *
25 * <p>This interface sets values on a {@link java.sql.PreparedStatement} provided
26 * by the JdbcTemplate class, for each of a number of updates in a batch using the
27 * same SQL. Implementations are responsible for setting any necessary parameters.
28 * SQL with placeholders will already have been supplied.
29 *
30 * <p>Implementations <i>do not</i> need to concern themselves with SQLExceptions
31 * that may be thrown from operations they attempt. The JdbcTemplate class will
32 * catch and handle SQLExceptions appropriately.
33 *
34 * @author Rod Johnson
35 * @since March 2, 2003
36 * @see JdbcTemplate#batchUpdate(String, BatchPreparedStatementSetter)
37 * @see InterruptibleBatchPreparedStatementSetter
38 */
39 public interface BatchPreparedStatementSetter {
40
41 /**
42 * Set parameter values on the given PreparedStatement.
43 * @param ps the PreparedStatement to invoke setter methods on
44 * @param i index of the statement we're issuing in the batch, starting from 0
45 * @throws SQLException if a SQLException is encountered
46 * (i.e. there is no need to catch SQLException)
47 */
48 void setValues(PreparedStatement ps, int i) throws SQLException;
49
50 /**
51 * Return the size of the batch.
52 * @return the number of statements in the batch
53 */
54 int getBatchSize();
55
56 }