View Javadoc

1   /*
2    * Copyright 2006-2008 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  package org.springframework.batch.item.database.support;
17  
18  import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer;
19  
20  /**
21   * Factory for creating {@link DataFieldMaxValueIncrementer} implementations
22   * based upon a provided string.
23   * 
24   * @author Lucas Ward
25   *
26   */
27  public interface DataFieldMaxValueIncrementerFactory {
28  
29  	/**
30  	 * Return the {@link DataFieldMaxValueIncrementer} for the provided database type.
31  	 * 
32  	 * @param databaseType string represented database type
33  	 * @param incrementerName incrementer name to create. In many cases this may be the
34  	 *  sequence name
35  	 * @return incrementer
36  	 * @throws IllegalArgumentException if databaseType is invalid type, or incrementerName
37  	 * is null.
38  	 */
39  	public DataFieldMaxValueIncrementer getIncrementer(String databaseType, String incrementerName);
40  	
41  	/**
42  	 * Returns boolean indicated whether or not the provided string is supported by this
43  	 * factory.
44  	 */
45  	public boolean isSupportedIncrementerType(String databaseType);
46  
47  	/**
48  	 * Returns the list of supported database incrementer types
49  	 */
50  	public String[] getSupportedIncrementerTypes();
51  }