IN PROGRESS - BATCH-830: DelegatingItemReader should be removed

replaced ValidatingItemReader with ValidatingItemProcessor

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

@@ -19,27 +19,27 @@ import org.springframework.util.Assert;
 @SuppressWarnings("unchecked")
 public class CompositeItemProcessor<I, O> implements ItemProcessor<I, O>, InitializingBean {
 
-	private List<ItemProcessor> itemTransformers;
+	private List<ItemProcessor> itemProcessors;
 
 	public O process(I item) throws Exception {
 		Object result = item;
 	
-		for(ItemProcessor transformer: itemTransformers){
+		for(ItemProcessor transformer: itemProcessors){
 			result = transformer.process(result);
 		}
 		return (O) result;
 	}
 
 	public void afterPropertiesSet() throws Exception {
-		Assert.notEmpty(itemTransformers);
+		Assert.notEmpty(itemProcessors);
 	}
 
 	/**
-	 * @param itemTransformers will be chained to produce a composite
+	 * @param itemProcessors will be chained to produce a composite
 	 * transformation.
 	 */
-	public void setItemTransformers(List<ItemProcessor> itemTransformers) {
-		this.itemTransformers = itemTransformers;
+	public void setItemProcessors(List<ItemProcessor> itemProcessors) {
+		this.itemProcessors = itemProcessors;
 	}
 
 }

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/ValidatingItemProcessor.java

@@ -0,0 +1,42 @@
+package org.springframework.batch.item.validator;
+
+import org.springframework.batch.item.ItemProcessor;
+import org.springframework.util.Assert;
+
+/**
+ * Simple implementation of {@link ItemProcessor} validates and input and
+ * returns it without modifications.
+ * 
+ * @author Robert Kasanicky
+ * 
+ */
+public class ValidatingItemProcessor<T> implements ItemProcessor<T, T> {
+
+	private Validator validator;
+	
+	public ValidatingItemProcessor(Validator validator){
+		Assert.notNull(validator, "Validator must not be null.");
+		this.validator = validator;
+	}
+
+	/**
+	 * Set the validator used to validate each item.
+	 * 
+	 * @param validator
+	 */
+	public void setValidator(Validator validator) {
+		this.validator = validator;
+	}
+
+	/**
+	 * Validate the item and return it unmodified
+	 * 
+	 * @return the input item
+	 * @throws ValidationException if validation fails
+	 */
+	public T process(T item) throws ValidationException {
+		validator.validate(item);
+		return item;
+	}
+
+}

spring-batch-infrastructure/src/main/java/org/springframework/batch/item/validator/ValidatingItemReader.java

@@ -1,59 +0,0 @@
-/*
- * Copyright 2006-2007 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.validator;
-
-import org.springframework.batch.item.support.DelegatingItemReader;
-import org.springframework.util.Assert;
-
-/**
- * Simple extension of {@link DelegatingItemReader} that provides for
- * validation before returning input.
- *
- * @author Lucas Ward
- *
- */
-public class ValidatingItemReader<T> extends DelegatingItemReader<T> {
-
-	private Validator validator;
-
-	/* (non-Javadoc)
-	 * @see org.springframework.batch.item.reader.DelegatingItemReader#afterPropertiesSet()
-	 */
-	public void afterPropertiesSet() throws Exception {
-		super.afterPropertiesSet();
-		Assert.notNull(validator, "Validator must not be null.");
-	}
-
-	/* (non-Javadoc)
-	 * @see org.springframework.batch.item.reader.DelegatingItemReader#read()
-	 */
-	public T read() throws Exception {
-		T input = super.read();
-		if(input != null){
-			validator.validate(input);
-		}
-		return input;
-	}
-
-	/**
-	 * Set the validator used to validate each item.
-	 *
-	 * @param validator
-	 */
-	public void setValidator(Validator validator) {
-		this.validator = validator;
-	}
-}

spring-batch-infrastructure/src/test/java/org/springframework/batch/item/support/CompositeItemProcessorTests.java

@@ -32,7 +32,7 @@ public class CompositeItemProcessorTests {
 		transformer1 = createMock(ItemProcessor.class);
 		transformer2 = createMock(ItemProcessor.class);
 		
-		composite.setItemTransformers(new ArrayList<ItemProcessor>() {{ 
+		composite.setItemProcessors(new ArrayList<ItemProcessor>() {{ 
 			add(transformer1); add(transformer2); 
 		}});
 		
@@ -71,7 +71,7 @@ public class CompositeItemProcessorTests {
 	public void testAfterPropertiesSet() throws Exception {
 		
 		// value not set
-		composite.setItemTransformers(null);
+		composite.setItemProcessors(null);
 		try {
 			composite.afterPropertiesSet();
 			fail();
@@ -81,7 +81,7 @@ public class CompositeItemProcessorTests {
 		}
 		
 		// empty list
-		composite.setItemTransformers(new ArrayList<ItemProcessor>());
+		composite.setItemProcessors(new ArrayList<ItemProcessor>());
 		try {
 			composite.afterPropertiesSet();
 			fail();

spring-batch-infrastructure/src/test/java/org/springframework/batch/item/validator/ValidatingItemProcessorTests.java

@@ -0,0 +1,39 @@
+package org.springframework.batch.item.validator;
+
+import org.junit.Test;
+import static org.junit.Assert.*;
+import static org.easymock.EasyMock.*;
+
+/**
+ * Tests for {@link ValidatingItemProcessor}.
+ */
+public class ValidatingItemProcessorTests {
+
+	private Validator validator = createMock(Validator.class);
+	
+	private ValidatingItemProcessor<String> tested = new ValidatingItemProcessor<String>(validator);
+	
+	private String item = "item";
+	
+	@Test
+	public void testSuccessfulValidation() throws Exception {
+		
+		validator.validate(item);
+		expectLastCall();
+		replay(validator);
+		
+		assertSame(item, tested.process(item));
+		
+		verify(validator);
+	}
+	
+	@Test(expected=ValidationException.class)
+	public void testFailedValidation() throws Exception {
+		
+		validator.validate(item);
+		expectLastCall().andThrow(new ValidationException("invalid item"));
+		replay(validator);
+		
+		tested.process(item);
+	}
+}

spring-batch-infrastructure/src/test/java/org/springframework/batch/item/validator/ValidatingItemReaderTests.java

@@ -1,115 +0,0 @@
-/*
- * Copyright 2006-2007 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.validator;
-
-import static org.easymock.EasyMock.createMock;
-import static org.easymock.EasyMock.expectLastCall;
-import static org.easymock.EasyMock.replay;
-import static org.easymock.EasyMock.verify;
-import junit.framework.TestCase;
-
-import org.springframework.batch.item.ItemReader;
-
-/**
- * @author Lucas Ward
- *
- */
-public class ValidatingItemReaderTests extends TestCase {
-
-	ItemReader<Object> inputSource;
-	ValidatingItemReader<Object> itemProvider;
-	Validator validator;
-
-	/* (non-Javadoc)
-	 * @see junit.framework.TestCase#setUp()
-	 */
-	protected void setUp() throws Exception {
-		super.setUp();
-
-		inputSource = new MockItemReader(this);
-		validator = createMock(Validator.class);
-		itemProvider = new ValidatingItemReader<Object>();
-		itemProvider.setItemReader(inputSource);
-		itemProvider.setValidator(validator);
-	}
-
-	/*
-	 * Super class' afterPropertieSet should be called to
-	 * ensure ItemReader is set.
-	 */
-	public void testItemReaderPropertiesSet(){
-		try{
-			itemProvider.setItemReader(null);
-			itemProvider.afterPropertiesSet();
-			fail();
-		}catch(Exception ex){
-			assertTrue(ex instanceof IllegalArgumentException);
-		}
-	}
-
-	public void testValidatorPropertesSet(){
-		try{
-			itemProvider.setValidator(null);
-			itemProvider.afterPropertiesSet();
-			fail();
-		}catch(Exception ex){
-			assertTrue(ex instanceof IllegalArgumentException);
-		}
-	}
-
-	public void testValidation() throws Exception{
-
-		validator.validate(this);
-		expectLastCall().once();
-		replay(validator);
-		assertEquals(itemProvider.read(), this);
-		verify(validator);
-	}
-
-	public void testValidationException() throws Exception{
-
-		validator.validate(this);
-		expectLastCall().andThrow(new ValidationException(""));
-		replay(validator);
-		try{
-			itemProvider.read();
-			fail();
-		}catch(ValidationException ex){
-			//expected
-		}
-	}
-
-	public void testNullInput() throws Exception{
-		replay(validator);
-		itemProvider.setItemReader(new MockItemReader(null));
-		assertNull(itemProvider.read());
-		//assert validator wasn't called.
-		verify(validator);
-	}
-
-	private static class MockItemReader implements ItemReader<Object> {
-
-		Object value;
-
-		public MockItemReader(Object value){
-			this.value = value;
-		}
-
-		public Object read() {
-			return value;
-		}
-	}
-}

spring-batch-samples/src/main/resources/jobs/beanWrapperMapperSampleJob.xml

@@ -11,13 +11,12 @@
 		<property name="steps">
 			<list>
 				<bean id="step1" parent="simpleStep">
-					<property name="streams" ref="tradeFileItemReader" />
-					<property name="itemReader">
-						<bean class="org.springframework.batch.item.validator.ValidatingItemReader">
-							<property name="itemReader" ref="tradeFileItemReader" />
-							<property name="validator" ref="fixedValidator" />
+					<property name="itemReader" ref="tradeFileItemReader" />
+					<property name="itemProcessor">
+						<bean class="org.springframework.batch.item.validator.ValidatingItemProcessor">
+							<constructor-arg ref="fixedValidator" />
 						</bean>
-					</property>
+					</property>	
 					<property name="itemWriter">
 						<bean class="org.springframework.batch.sample.domain.trade.internal.TradeWriter">
 							<property name="dao" ref="tradeDao" />

spring-batch-samples/src/main/resources/jobs/compositeItemWriterSampleJob.xml

@@ -18,14 +18,12 @@
 						<ref bean="fileItemWriter" />
 					</list>
 				</property>
-				<property name="itemReader">
-					<bean
-						class="org.springframework.batch.item.validator.ValidatingItemReader">
-						<property name="itemReader"
-							ref="fileItemReader" />
-						<property name="validator" ref="fixedValidator" />
+				<property name="itemReader" ref="fileItemReader" />
+				<property name="itemProcessor">
+					<bean class="org.springframework.batch.item.validator.ValidatingItemProcessor">
+						<constructor-arg ref="fixedValidator" />
 					</bean>
-				</property>
+				</property>	
 				<property name="itemWriter" ref="compositeWriter" />
 			</bean>
 		</property>

spring-batch-samples/src/main/resources/jobs/fixedLengthImportJob.xml

@@ -10,11 +10,10 @@
 	<bean id="fixedLengthImportJob" parent="simpleJob">
 		<property name="steps">
 			<bean id="step1" parent="simpleStep" p:commitInterval="3">
-				<property name="streams" ref="fileItemReader" />
-				<property name="itemReader">
-					<bean class="org.springframework.batch.item.validator.ValidatingItemReader">
-						<property name="itemReader" ref="fileItemReader" />
-						<property name="validator" ref="fixedValidator" />
+				<property name="itemReader" ref="fileItemReader" />
+				<property name="itemProcessor">
+					<bean class="org.springframework.batch.item.validator.ValidatingItemProcessor">
+						<constructor-arg ref="fixedValidator" />
 					</bean>
 				</property>
 				<property name="itemWriter">

spring-batch-samples/src/main/resources/jobs/multiResourceJob.xml

@@ -12,13 +12,10 @@
 	<bean id="multiResourceJob" parent="simpleJob">
 		<property name="steps">
 			<bean id="step1" parent="simpleStep" p:commitInterval="3">
-				<property name="streams" ref="fileItemReader" />
-				<property name="itemReader">
-					<bean
-						class="org.springframework.batch.item.validator.ValidatingItemReader">
-						<property name="itemReader"
-							ref="fileItemReader" />
-						<property name="validator" ref="fixedValidator" />
+				<property name="itemReader" ref="fileItemReader" />
+				<property name="itemProcessor">
+					<bean class="org.springframework.batch.item.validator.ValidatingItemProcessor">
+						<constructor-arg ref="fixedValidator" />
 					</bean>
 				</property>
 				<property name="itemWriter">

spring-batch-samples/src/main/resources/jobs/multilineOrderJob.xml

@@ -20,25 +20,29 @@
 					</list>
 				</property>
 				<property name="itemReader">
-					<bean class="org.springframework.batch.item.validator.ValidatingItemReader">
-						<property name="itemReader">
-							<bean class="org.springframework.batch.sample.domain.order.internal.OrderItemReader">
-								<property name="fieldSetReader" ref="fileItemReader" />
-								<property name="headerMapper" ref="headerFieldSetMapper" />
-								<property name="customerMapper" ref="customerFieldSetMapper" />
-								<property name="addressMapper" ref="addressFieldSetMapper" />
-								<property name="billingMapper" ref="billingFieldSetMapper" />
-								<property name="itemMapper" ref="orderItemFieldSetMapper" />
-								<property name="shippingMapper" ref="shippingFieldSetMapper" />
-							</bean>
-						</property>
-						<property name="validator" ref="validator" />
+					<bean class="org.springframework.batch.sample.domain.order.internal.OrderItemReader">
+						<property name="fieldSetReader" ref="fileItemReader" />
+						<property name="headerMapper" ref="headerFieldSetMapper" />
+						<property name="customerMapper" ref="customerFieldSetMapper" />
+						<property name="addressMapper" ref="addressFieldSetMapper" />
+						<property name="billingMapper" ref="billingFieldSetMapper" />
+						<property name="itemMapper" ref="orderItemFieldSetMapper" />
+						<property name="shippingMapper" ref="shippingFieldSetMapper" />
 					</bean>
 				</property>
 				<property name="itemWriter" ref="fileItemWriter" />
 				<property name="itemProcessor">
-					<bean class="org.springframework.batch.sample.domain.order.internal.OrderProcessor">
-						<property name="aggregators" ref="outputAggregators" />
+					<bean class="org.springframework.batch.item.support.CompositeItemProcessor">
+						<property name="itemProcessors">
+							<list>
+								<bean class="org.springframework.batch.item.validator.ValidatingItemProcessor">
+									<constructor-arg ref="validator" />
+								</bean>
+								<bean class="org.springframework.batch.sample.domain.order.internal.OrderProcessor">
+									<property name="aggregators" ref="outputAggregators" />
+								</bean>
+							</list>
+						</property>
 					</bean>
 				</property>
 			</bean>
@@ -134,7 +138,8 @@
 			</bean>
 		</property>
 	</bean>
-	<!-- "{" <key> : <rule> : <message> : [ <error_code> [ : <error_parameters> ] ] "}" -->
+	<!-- "{" <key> : <rule> : <message> : [ <error_code> [ : <error_parameters> ] ] "}"
+-->
 
 	<bean id="fileInputLocator" class="org.springframework.core.io.ClassPathResource">
 		<constructor-arg type="java.lang.String"

spring-batch-samples/src/main/resources/jobs/parallelJob.xml

@@ -15,16 +15,12 @@
 				<bean id="staging" parent="simpleStep">
 					<property name="commitInterval" value="2" />
 					<property name="startLimit" value="100" />
-					<property name="streams" ref="fileItemReader" />
-					<property name="itemReader">
-						<bean
-							class="org.springframework.batch.item.validator.ValidatingItemReader">
-							<property name="itemReader"
-								ref="fileItemReader" />
-							<property name="validator"
-								ref="fixedValidator" />
+					<property name="itemReader" ref="fileItemReader" />
+					<property name="itemProcessor">
+						<bean class="org.springframework.batch.item.validator.ValidatingItemProcessor">
+							<constructor-arg ref="fixedValidator" />
 						</bean>
-					</property>
+					</property>	
 					<property name="itemWriter">
 						<bean
 							class="org.springframework.batch.sample.common.StagingItemWriter">

spring-batch-samples/src/main/resources/jobs/restartSample.xml

@@ -13,13 +13,12 @@
 		<property name="steps">
 			<bean id="step1" parent="simpleStep">
 				<property name="streams" ref="fileItemReader" />
-				<property name="itemReader">
-					<bean
-						class="org.springframework.batch.item.validator.ValidatingItemReader">
-						<property name="itemReader" ref="itemReader" />
-						<property name="validator" ref="fixedValidator" />
-					</bean>
-				</property>
+				<property name="itemReader" ref="itemReader" />
+					<property name="itemProcessor">
+						<bean class="org.springframework.batch.item.validator.ValidatingItemProcessor">
+							<constructor-arg ref="fixedValidator" />
+						</bean>
+					</property>	
 				<property name="itemWriter">
 					<bean
 						class="org.springframework.batch.sample.domain.trade.internal.TradeWriter">

spring-batch-samples/src/main/resources/jobs/skipSampleJob.xml

@@ -15,16 +15,7 @@
 			<list>
 				<bean id="step1" parent="skipLimitStep">
 					<property name="skipLimit" value="1" />
-					<property name="streams" ref="fileItemReader" />
-					<property name="itemReader">
-						<bean
-							class="org.springframework.batch.item.validator.ValidatingItemReader">
-							<property name="itemReader"
-								ref="fileItemReader" />
-							<property name="validator"
-								ref="tradeValidator" />
-						</bean>
-					</property>
+					<property name="itemReader" ref="fileItemReader" />
 					<property name="itemWriter">
 						<bean
 							class="org.springframework.batch.sample.domain.trade.internal.TradeWriter"

spring-batch-samples/src/main/resources/jobs/tradeJob.xml

@@ -16,13 +16,10 @@
 				<bean id="step1" parent="simpleStep">
 					<property name="transactionAttribute" value="PROPAGATION_REQUIRED,ISOLATION_READ_COMMITTED"/>
 					<property name="streams" ref="fileItemReader" />
-					<property name="itemReader">
-						<bean
-							class="org.springframework.batch.item.validator.ValidatingItemReader">
-							<property name="itemReader"
-								ref="fileItemReader" />
-							<property name="validator"
-								ref="tradeValidator" />
+					<property name="itemReader" ref="fileItemReader" />
+					<property name="itemProcessor">
+						<bean class="org.springframework.batch.item.validator.ValidatingItemProcessor">
+							<constructor-arg ref="tradeValidator" />
 						</bean>
 					</property>
 					<property name="itemWriter">