KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > springframework > jdbc > core > InterruptibleBatchPreparedStatementSetter


1 /*
2  * Copyright 2002-2006 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 /**
20  * Extension of the BatchPreparedStatementSetter interface that adds
21  * a batch exhaustion check.
22  *
23  * <p>This interface allows you to signal the end of a batch rather than
24  * having to determine the exact batch size upfront. Batch size is still
25  * being honored but it is now the maximum size of the batch.
26  *
27  * <p>The <code>isBatchExhausted</code> method is called after each call to
28  * <code>setValues</code> to determine whether there were some values added
29  * or if the batch was determined to be complete and no additional values
30  * were provided during the last call to <code>setValues</code>.
31  *
32  * <p>Consider extending the AbstractInterruptibleBatchPreparedStatementSetter
33  * base class instead of implementing this interface directly, having a
34  * single callback method that combines the check for available values
35  * and the setting of those.
36  *
37  * @author Thomas Risberg
38  * @since 2.0
39  * @see JdbcTemplate#batchUpdate(String, BatchPreparedStatementSetter)
40  * @see org.springframework.jdbc.core.support.AbstractInterruptibleBatchPreparedStatementSetter
41  */
42 public interface InterruptibleBatchPreparedStatementSetter extends BatchPreparedStatementSetter {
43
44     /**
45      * Return whether the batch is complete, that is, whether there were no
46      * additional values added during the last <code>setValues</code> call.
47      * <p><b>NOTE:</b> If this method returns <code>true</code>, any parameters
48      * that might have been set during the last <code>setValues</code> call will
49      * be ignored! Make sure that you set a corresponding internal flag if you
50      * detect exhaustion <i>at the beginning</i> of your <code>setValues</code>
51      * implementation, letting this method return <code>true</code> based on the flag.
52      * @param i index of the statement we're issuing in the batch, starting from 0
53      * @see #setValues
54      */
55     boolean isBatchExhausted(int i);
56
57 }
58
Popular Tags