From 9a830aae1931748e697fd1db4116a30b521ac969 Mon Sep 17 00:00:00 2001 From: lucasward Date: Wed, 13 Feb 2008 21:05:42 +0000 Subject: [PATCH] BATCH-220: More refinements to chunking, both the chunker and dechunker now return a 'result'. The chunker returns a ChunkingResult, and the Dechunker returns a DechunkingResult, allowing for the step to handle exceptions in a uniform way. --- .../batch/core/domain/ChunkingResult.java | 43 +++++++++++++++++++ .../batch/core/domain/Dechunker.java | 2 +- ...ChunkResult.java => DechunkingResult.java} | 42 +++++++----------- .../batch/core/domain/ItemFailureLog.java | 31 +++++++++++++ .../core/domain/ChunkingResultTests.java | 42 ++++++++++++++++++ 5 files changed, 133 insertions(+), 27 deletions(-) create mode 100644 spring-batch-core/src/main/java/org/springframework/batch/core/domain/ChunkingResult.java rename spring-batch-core/src/main/java/org/springframework/batch/core/domain/{ChunkResult.java => DechunkingResult.java} (53%) create mode 100644 spring-batch-core/src/main/java/org/springframework/batch/core/domain/ItemFailureLog.java create mode 100644 spring-batch-core/src/test/java/org/springframework/batch/core/domain/ChunkingResultTests.java diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/domain/ChunkingResult.java b/spring-batch-core/src/main/java/org/springframework/batch/core/domain/ChunkingResult.java new file mode 100644 index 000000000..f7dfcad62 --- /dev/null +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/domain/ChunkingResult.java @@ -0,0 +1,43 @@ +/* + * 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.core.domain; + +import java.util.List; + +/** + * Value object representing the result of chunking. + * + * @author Lucas Ward + */ +public class ChunkingResult { + + private final Chunk chunk; + + private final List exceptions; + + public ChunkingResult(Chunk chunk, List exceptions) { + this.chunk = chunk; + this.exceptions = exceptions; + } + + public Chunk getChunk() { + return chunk; + } + + public List getExceptions() { + return exceptions; + } +} diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/domain/Dechunker.java b/spring-batch-core/src/main/java/org/springframework/batch/core/domain/Dechunker.java index 2680bc6c1..60655b6e4 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/domain/Dechunker.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/domain/Dechunker.java @@ -29,5 +29,5 @@ import org.springframework.batch.item.ItemReader; */ public interface Dechunker { - ChunkResult dechunk(Chunk chunk) throws Exception; + DechunkingResult dechunk(Chunk chunk) throws Exception; } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/domain/ChunkResult.java b/spring-batch-core/src/main/java/org/springframework/batch/core/domain/DechunkingResult.java similarity index 53% rename from spring-batch-core/src/main/java/org/springframework/batch/core/domain/ChunkResult.java rename to spring-batch-core/src/main/java/org/springframework/batch/core/domain/DechunkingResult.java index 23145c327..417b0770d 100644 --- a/spring-batch-core/src/main/java/org/springframework/batch/core/domain/ChunkResult.java +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/domain/DechunkingResult.java @@ -18,47 +18,37 @@ package org.springframework.batch.core.domain; import java.util.ArrayList; import java.util.List; -import org.springframework.core.enums.ShortCodedLabeledEnum; - /** + * Value object representing the result of dechunking a {@link Chunk}. It contains + * the id of the chunk that was processed, a list of exceptions, and whether or not + * the chunk was successful. * * @author Ben Hale + * @author Lucas Ward */ -public class ChunkResult { - - public static final ChunkResultType SUCCESS = new ChunkResultType(0, "Success"); - - public static final ChunkResultType FAILURE = new ChunkResultType(1, "Failure"); - - private final ChunkResultType resultType; +public class DechunkingResult { private final Long chunkId; - private final List skippedItems; + private final List exceptions; + + private final boolean successful; - public ChunkResult(ChunkResultType resultType, Long chunkId, List skippedItems) { - this.resultType = resultType; + public DechunkingResult(boolean successful, Long chunkId, List exceptions) { this.chunkId = chunkId; - this.skippedItems = skippedItems; - } - - public ChunkResultType getResultType() { - return resultType; + this.exceptions = exceptions; + this.successful = successful; } public Long getChunkId() { return chunkId; } - public List getSkippedItems() { - return new ArrayList(skippedItems); + public List getExceptions() { + return new ArrayList(exceptions); } - - private static class ChunkResultType extends ShortCodedLabeledEnum { - - public ChunkResultType(int code, String label) { - super(code, label); - } - + + public boolean isSuccessful() { + return successful; } } diff --git a/spring-batch-core/src/main/java/org/springframework/batch/core/domain/ItemFailureLog.java b/spring-batch-core/src/main/java/org/springframework/batch/core/domain/ItemFailureLog.java new file mode 100644 index 000000000..bf6381a45 --- /dev/null +++ b/spring-batch-core/src/main/java/org/springframework/batch/core/domain/ItemFailureLog.java @@ -0,0 +1,31 @@ +/* + * 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.core.domain; + +import java.util.List; + +/** + * Interface for defining the contract to log out read and write + * failures encountered during batch processing. + * + * @author Lucas Ward + * + */ +public interface ItemFailureLog { + + void log(List exceptions); + +} diff --git a/spring-batch-core/src/test/java/org/springframework/batch/core/domain/ChunkingResultTests.java b/spring-batch-core/src/test/java/org/springframework/batch/core/domain/ChunkingResultTests.java new file mode 100644 index 000000000..ce5b4e164 --- /dev/null +++ b/spring-batch-core/src/test/java/org/springframework/batch/core/domain/ChunkingResultTests.java @@ -0,0 +1,42 @@ +/* + * 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.core.domain; + +import java.util.ArrayList; +import java.util.List; + +import junit.framework.TestCase; + +/** + * @author Lucas Ward + * + */ +public class ChunkingResultTests extends TestCase { + + private Chunk chunk; + private List exceptions; + + public void testChunk(){ + + chunk = new Chunk(new Long(1), new ArrayList()); + exceptions = new ArrayList(); + + ChunkingResult result = new ChunkingResult(chunk,exceptions); + + assertEquals(chunk,result.getChunk()); + assertEquals(exceptions,result.getExceptions()); + } +}