01: /*
02: * Copyright 2002-2007 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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 {@link BatchPreparedStatementSetter} interface,
21: * adding 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 {@link #isBatchExhausted} method is called after each call to
28: * {@link #setValues} 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
33: * {@link org.springframework.jdbc.core.support.AbstractInterruptibleBatchPreparedStatementSetter}
34: * base class instead of implementing this interface directly, using a single
35: * <code>setValuesIfAvailable</code> callback method that checks for available
36: * values and sets them, returning whether values have actually been provided.
37: *
38: * @author Thomas Risberg
39: * @author Juergen Hoeller
40: * @since 2.0
41: * @see JdbcTemplate#batchUpdate(String, BatchPreparedStatementSetter)
42: * @see org.springframework.jdbc.core.support.AbstractInterruptibleBatchPreparedStatementSetter
43: */
44: public interface InterruptibleBatchPreparedStatementSetter extends
45: BatchPreparedStatementSetter {
46:
47: /**
48: * Return whether the batch is complete, that is, whether there were no
49: * additional values added during the last <code>setValues</code> call.
50: * <p><b>NOTE:</b> If this method returns <code>true</code>, any parameters
51: * that might have been set during the last <code>setValues</code> call will
52: * be ignored! Make sure that you set a corresponding internal flag if you
53: * detect exhaustion <i>at the beginning</i> of your <code>setValues</code>
54: * implementation, letting this method return <code>true</code> based on the flag.
55: * @param i index of the statement we're issuing in the batch, starting from 0
56: * @return whether the batch is already exhausted
57: * @see #setValues
58: * @see org.springframework.jdbc.core.support.AbstractInterruptibleBatchPreparedStatementSetter#setValuesIfAvailable
59: */
60: boolean isBatchExhausted(int i);
61:
62: }
|