RESOLVED - issue BATCH-986: Provide factory bean for SqlPagingQueryProvider

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/AbstractSqlPagingQueryProvider.java

@@ -130,7 +130,7 @@ public abstract class AbstractSqlPagingQueryProvider implements PagingQueryProvi
 	}
 
 	/**
-	 * The sort key placegholder will vary depending on whether named parameters or traditional placeholders
+	 * The sort key placeholder will vary depending on whether named parameters or traditional placeholders
 	 * are used in query strings.
 	 *
 	 * @return place holder for sortKey.

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/DefaultDataFieldMaxValueIncrementerFactory.java

@@ -15,7 +15,15 @@
  */
 package org.springframework.batch.item.database.support;
 
-import static org.springframework.batch.support.DatabaseType.*;
+import static org.springframework.batch.support.DatabaseType.DB2;
+import static org.springframework.batch.support.DatabaseType.DB2ZOS;
+import static org.springframework.batch.support.DatabaseType.DERBY;
+import static org.springframework.batch.support.DatabaseType.HSQL;
+import static org.springframework.batch.support.DatabaseType.MYSQL;
+import static org.springframework.batch.support.DatabaseType.ORACLE;
+import static org.springframework.batch.support.DatabaseType.POSTGRES;
+import static org.springframework.batch.support.DatabaseType.SQLSERVER;
+import static org.springframework.batch.support.DatabaseType.SYBASE;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -23,6 +31,7 @@ import java.util.List;
 import javax.sql.DataSource;
 
 import org.springframework.batch.support.DatabaseType;
+import org.springframework.jdbc.support.incrementer.DB2MainframeSequenceMaxValueIncrementer;
 import org.springframework.jdbc.support.incrementer.DB2SequenceMaxValueIncrementer;
 import org.springframework.jdbc.support.incrementer.DataFieldMaxValueIncrementer;
 import org.springframework.jdbc.support.incrementer.DerbyMaxValueIncrementer;
@@ -32,25 +41,10 @@ import org.springframework.jdbc.support.incrementer.OracleSequenceMaxValueIncrem
 import org.springframework.jdbc.support.incrementer.PostgreSQLSequenceMaxValueIncrementer;
 import org.springframework.jdbc.support.incrementer.SqlServerMaxValueIncrementer;
 import org.springframework.jdbc.support.incrementer.SybaseMaxValueIncrementer;
-import org.springframework.jdbc.support.incrementer.DB2MainframeSequenceMaxValueIncrementer;
 
 /**
  * Default implementation of the {@link DataFieldMaxValueIncrementerFactory}
- * interface. Valid types are:
- * 
- * Valid values are:
- * 
- * <ul>
- * <li>db2</li>
- * <li>db2zos</li>
- * <li>derby</li>
- * <li>hsql</li>
- * <li>mysql</li>
- * <li>oracle</li>
- * <li>postgres</li>
- * <li>sqlserver</li>
- * <li>sybase</li>
- * </ul>
+ * interface. Valid database types are given by the {@link DatabaseType} enum.
  * 
  * @author Lucas Ward
  * @see DatabaseType
@@ -64,8 +58,8 @@ public class DefaultDataFieldMaxValueIncrementerFactory implements DataFieldMaxV
 	/**
 	 * Public setter for the column name (defaults to "ID") in the incrementer.
 	 * Only used by some platforms (Derby, HSQL, MySQL, SQL Server and Sybase),
-	 * and should be fine for use with Spring Batch meta data as long as the default
-	 * batch schema hasn't been changed.
+	 * and should be fine for use with Spring Batch meta data as long as the
+	 * default batch schema hasn't been changed.
 	 * 
 	 * @param incrementerColumnName the primary key column name to set
 	 */
@@ -79,7 +73,7 @@ public class DefaultDataFieldMaxValueIncrementerFactory implements DataFieldMaxV
 
 	public DataFieldMaxValueIncrementer getIncrementer(String incrementerType, String incrementerName) {
 		DatabaseType databaseType = DatabaseType.valueOf(incrementerType.toUpperCase());
-		
+
 		if (databaseType == DB2) {
 			return new DB2SequenceMaxValueIncrementer(dataSource, incrementerName);
 		}
@@ -112,20 +106,20 @@ public class DefaultDataFieldMaxValueIncrementerFactory implements DataFieldMaxV
 	}
 
 	public boolean isSupportedIncrementerType(String incrementerType) {
-		for(DatabaseType type : DatabaseType.values()){
-			if(type.name().equals(incrementerType.toUpperCase())){
+		for (DatabaseType type : DatabaseType.values()) {
+			if (type.name().equals(incrementerType.toUpperCase())) {
 				return true;
 			}
 		}
-		
+
 		return false;
 	}
 
 	public String[] getSupportedIncrementerTypes() {
-		
+
 		List<String> types = new ArrayList<String>();
 
-		for(DatabaseType type : DatabaseType.values()){
+		for (DatabaseType type : DatabaseType.values()) {
 			types.add(type.name());
 		}
 

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/support/SqlPagingQueryProviderFactoryBean.java

@@ -0,0 +1,166 @@
+/*
+ * Copyright 2006-2008 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.batch.item.database.support;
+
+import static org.springframework.batch.support.DatabaseType.DB2;
+import static org.springframework.batch.support.DatabaseType.DB2ZOS;
+import static org.springframework.batch.support.DatabaseType.DERBY;
+import static org.springframework.batch.support.DatabaseType.HSQL;
+import static org.springframework.batch.support.DatabaseType.MYSQL;
+import static org.springframework.batch.support.DatabaseType.ORACLE;
+import static org.springframework.batch.support.DatabaseType.POSTGRES;
+import static org.springframework.batch.support.DatabaseType.SQLSERVER;
+import static org.springframework.batch.support.DatabaseType.SYBASE;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.sql.DataSource;
+
+import org.springframework.batch.item.database.PagingQueryProvider;
+import org.springframework.batch.support.DatabaseType;
+import org.springframework.beans.factory.FactoryBean;
+import org.springframework.jdbc.support.MetaDataAccessException;
+import org.springframework.util.Assert;
+import org.springframework.util.StringUtils;
+
+/**
+ * Factory bean for {@link PagingQueryProvider} interface. The database type
+ * will be determined from the data source if not provided explicitly. Valid
+ * types are given by the {@link DatabaseType} enum.
+ * 
+ * @author Dave Syer
+ */
+public class SqlPagingQueryProviderFactoryBean implements FactoryBean {
+
+	private DataSource dataSource;
+
+	private String databaseType;
+
+	private String fromClause;
+
+	private String whereClause;
+
+	private String selectClause;
+
+	private String sortKey;
+
+	private Map<DatabaseType, AbstractSqlPagingQueryProvider> providers = new HashMap<DatabaseType, AbstractSqlPagingQueryProvider>();
+	{
+		providers.put(DB2, new Db2PagingQueryProvider());
+		providers.put(DB2ZOS, new Db2PagingQueryProvider());
+		providers.put(DERBY,new DerbyPagingQueryProvider());
+		providers.put(HSQL,new HsqlPagingQueryProvider());
+		providers.put(MYSQL,new MySqlPagingQueryProvider());
+		providers.put(ORACLE,new OraclePagingQueryProvider());
+		providers.put(POSTGRES,new PostgresPagingQueryProvider());
+		providers.put(SQLSERVER,new SqlServerPagingQueryProvider());
+		providers.put(SYBASE,new SybasePagingQueryProvider());
+	}
+
+	/**
+	 * @param databaseType the databaseType to set
+	 */
+	public void setDatabaseType(String databaseType) {
+		this.databaseType = databaseType;
+	}
+
+	/**
+	 * @param dataSource the dataSource to set
+	 */
+	public void setDataSource(DataSource dataSource) {
+		this.dataSource = dataSource;
+	}
+
+	/**
+	 * @param fromClause the fromClause to set
+	 */
+	public void setFromClause(String fromClause) {
+		this.fromClause = fromClause;
+	}
+
+	/**
+	 * @param whereClause the whereClause to set
+	 */
+	public void setWhereClause(String whereClause) {
+		this.whereClause = whereClause;
+	}
+
+	/**
+	 * @param selectClause the selectClause to set
+	 */
+	public void setSelectClause(String selectClause) {
+		this.selectClause = selectClause;
+	}
+
+	/**
+	 * @param sortKey the sortKey to set
+	 */
+	public void setSortKey(String sortKey) {
+		this.sortKey = sortKey;
+	}
+
+	/**
+	 * Get a {@link PagingQueryProvider} instance using the provided properties
+	 * and appropriate for the given database type.
+	 * 
+	 * @see FactoryBean#getObject()
+	 */
+	public Object getObject() throws Exception {
+
+		DatabaseType type;
+		try {
+			type = databaseType != null ? DatabaseType.valueOf(databaseType.toUpperCase()) : DatabaseType
+					.fromMetaData(dataSource);
+		}
+		catch (MetaDataAccessException e) {
+			throw new IllegalArgumentException(
+					"Could not inspect meta data for database type.  You have to supply it explicitly.");
+		}
+
+		AbstractSqlPagingQueryProvider provider = providers.get(type);
+		Assert.state(provider!=null, "Should not happen: missing PagingQueryProvider for DatabaseType="+type);
+
+		provider.setFromClause(fromClause);
+		provider.setWhereClause(whereClause);
+		provider.setSortKey(sortKey);
+		if (StringUtils.hasText(selectClause)) {
+			provider.setSelectClause(selectClause);
+		}
+
+		provider.init(dataSource);
+
+		return provider;
+
+	}
+
+	/**
+	 * Always returns {@link PagingQueryProvider}.
+	 * 
+	 * @see FactoryBean#getObjectType()
+	 */
+	public Class<PagingQueryProvider> getObjectType() {
+		return PagingQueryProvider.class;
+	}
+
+	/**
+	 * Always returns true.
+	 * @see FactoryBean#isSingleton()
+	 */
+	public boolean isSingleton() {
+		return true;
+	}
+}

spring-batch-infrastructure/src/main/java/org/springframework/batch/support/DatabaseType.java

@@ -76,7 +76,7 @@ public enum DatabaseType {
 	 * @return DatabaseType
 	 * @throws MetaDataAccessException
 	 */
-	public static DatabaseType fromMetaData(DataSource dataSource) throws MetaDataAccessException{
+	public static DatabaseType fromMetaData(DataSource dataSource) throws MetaDataAccessException {
 		String databaseProductName =
 				JdbcUtils.extractDatabaseMetaData(dataSource, "getDatabaseProductName").toString();
 		if ("DB2".equals(databaseProductName)) {