getProperties method moved from RowSet to BeanWrapperRowMapper, header array added as field to BeanWrapperRowMapper

Author: adrianpusty

spring-batch-excel/src/main/java/org/springframework/batch/extensions/excel/mapping/BeanWrapperRowMapper.java

@@ -99,6 +99,8 @@ public class BeanWrapperRowMapper<T> extends DefaultPropertyEditorRegistrar
 
 	private boolean strict = true;
 
+	private String[] header;
+
 	@Override
 	public void setBeanFactory(BeanFactory beanFactory) {
 		this.beanFactory = beanFactory;
@@ -138,6 +140,10 @@ public void setTargetType(Class<? extends T> type) {
 		this.type = type;
 	}
 
+	public void setHeader(String[] header) {
+		this.header = header;
+	}
+
 	/**
 	 * Check that precisely one of type or prototype bean name is specified.
 	 * @throws IllegalStateException if neither is set or both properties are set.
@@ -165,13 +171,35 @@ public void afterPropertiesSet() throws Exception {
 	public T mapRow(RowSet rs) throws BindException {
 		T copy = getBean();
 		DataBinder binder = createBinder(copy);
-		binder.bind(new MutablePropertyValues(getBeanProperties(copy, rs.getProperties())));
+		binder.bind(new MutablePropertyValues(getBeanProperties(copy, getProperties(rs))));
 		if (binder.getBindingResult().hasErrors()) {
 			throw new BindException(binder.getBindingResult());
 		}
 		return copy;
 	}
 
+	/**
+	 * Construct name-value pairs from the column names and string values. {@code null}
+	 * values are omitted.
+	 * @param rowSet rowSet
+	 * @return some properties representing the row set.
+	 * @throws IllegalStateException if the column name meta data is not available.
+	 */
+	public Properties getProperties(RowSet rowSet) {
+		if (this.header == null) {
+			throw new IllegalStateException("Cannot create properties without meta data");
+		}
+
+		Properties props = new Properties();
+		for (int i = 0; i < rowSet.getCurrentRow().length; i++) {
+			String value = rowSet.getCurrentRow()[i];
+			if (value != null) {
+				props.setProperty(this.header[i], value);
+			}
+		}
+		return props;
+	}
+
 	/**
 	 * Create a binder for the target object. The binder will then be used to bind the
 	 * properties form a field set into the target object. This implementation creates a

spring-batch-excel/src/main/java/org/springframework/batch/extensions/excel/support/rowset/DefaultRowSet.java

@@ -17,7 +17,6 @@
 package org.springframework.batch.extensions.excel.support.rowset;
 
 import java.util.Iterator;
-import java.util.Properties;
 
 import org.springframework.batch.extensions.excel.Sheet;
 
@@ -69,21 +68,4 @@ public String[] getCurrentRow() {
 		return this.currentRow;
 	}
 
-	@Override
-	public Properties getProperties() {
-		final String[] names = this.metaData.getColumnNames();
-		if (names == null) {
-			throw new IllegalStateException("Cannot create properties without meta data");
-		}
-
-		Properties props = new Properties();
-		for (int i = 0; i < this.currentRow.length; i++) {
-			String value = this.currentRow[i];
-			if (value != null) {
-				props.setProperty(names[i], value);
-			}
-		}
-		return props;
-	}
-
 }

spring-batch-excel/src/main/java/org/springframework/batch/extensions/excel/support/rowset/RowSet.java

@@ -16,8 +16,6 @@
 
 package org.springframework.batch.extensions.excel.support.rowset;
 
-import java.util.Properties;
-
 /**
  * Used by the {@code org.springframework.batch.item.excel.AbstractExcelItemReader} to
  * abstract away the complexities of the underlying Excel API implementations.
@@ -51,13 +49,4 @@ public interface RowSet {
 	 * @return the row as a {@code String[]}
 	 */
 	String[] getCurrentRow();
-
-	/**
-	 * Construct name-value pairs from the column names and string values. {@code null}
-	 * values are omitted.
-	 * @return some properties representing the row set.
-	 * @throws IllegalStateException if the column name meta data is not available.
-	 */
-	Properties getProperties();
-
 }

spring-batch-excel/src/test/java/org/springframework/batch/extensions/excel/BeanPropertyItemReaderTest.java

@@ -39,9 +39,10 @@ public class BeanPropertyItemReaderTest {
 	@BeforeEach
 	public void setup() throws Exception {
 		ExecutionContext executionContext = new ExecutionContext();
+		String[] header = {"id", "lastName", "firstName", "position", "birthYear", "debutYear"};
 
 		List<String[]> rows = new ArrayList<>();
-		rows.add(new String[] { "id", "lastName", "firstName", "position", "birthYear", "debutYear" });
+		rows.add(header);
 		rows.add(new String[] { "AbduKa00", "Abdul-Jabbar", "Karim", "rb", "1974", "1996" });
 		rows.add(new String[] { "AbduRa00", "Abdullah", "Rabih", "rb", "1975", "1999" });
 		MockSheet sheet = new MockSheet("players", rows);
@@ -51,6 +52,7 @@ public void setup() throws Exception {
 		BeanWrapperRowMapper<Player> rowMapper = new BeanWrapperRowMapper<>();
 		rowMapper.setTargetType(Player.class);
 		rowMapper.afterPropertiesSet();
+		rowMapper.setHeader(header);
 
 		this.reader.setLinesToSkip(1); // Skip first row as that is the header
 		this.reader.setRowMapper(rowMapper);

spring-batch-excel/src/test/java/org/springframework/batch/extensions/excel/BeanPropertyWithStaticHeaderItemReaderTest.java

@@ -36,6 +36,7 @@
  */
 public class BeanPropertyWithStaticHeaderItemReaderTest {
 
+	private static final String[] HEADER = new String[] { "id", "lastName", "firstName", "position", "birthYear", "debutYear" };
 	private MockExcelItemReader<Player> reader;
 
 	@BeforeEach
@@ -51,13 +52,13 @@ public void setup() throws Exception {
 
 		BeanWrapperRowMapper<Player> rowMapper = new BeanWrapperRowMapper<>();
 		rowMapper.setTargetType(Player.class);
+		rowMapper.setHeader(HEADER);
 		rowMapper.afterPropertiesSet();
 
 		this.reader.setRowMapper(rowMapper);
 
 		DefaultRowSetFactory factory = new DefaultRowSetFactory();
-		factory.setColumnNameExtractor(new StaticColumnNameExtractor(
-				new String[] { "id", "lastName", "firstName", "position", "birthYear", "debutYear" }));
+		factory.setColumnNameExtractor(new StaticColumnNameExtractor(HEADER));
 		this.reader.setRowSetFactory(factory);
 		this.reader.afterPropertiesSet();
 		this.reader.open(executionContext);

spring-batch-excel/src/test/java/org/springframework/batch/extensions/excel/mapping/BeanWrapperRowMapperTest.java

@@ -39,6 +39,8 @@
  */
 public class BeanWrapperRowMapperTest {
 
+	private static final String[] HEADER = {"id", "lastName", "firstName", "position", "birthYear", "debutYear"};
+
 	@Test
 	public void givenNoNameWhenInitCompleteThenIllegalStateShouldOccur() {
 		Assertions.assertThatThrownBy(() -> {
@@ -51,10 +53,11 @@ public void givenNoNameWhenInitCompleteThenIllegalStateShouldOccur() {
 	public void givenAValidRowWhenMappingThenAValidPlayerShouldBeConstructed() throws Exception {
 		BeanWrapperRowMapper<Player> mapper = new BeanWrapperRowMapper<>();
 		mapper.setTargetType(Player.class);
+		mapper.setHeader(HEADER);
 		mapper.afterPropertiesSet();
 
 		List<String[]> rows = new ArrayList<>();
-		rows.add(new String[] { "id", "lastName", "firstName", "position", "birthYear", "debutYear" });
+		rows.add(HEADER);
 		rows.add(new String[] { "AbduKa00", "Abdul-Jabbar", "Karim", "rb", "1974", "1996" });
 		MockSheet sheet = new MockSheet("players", rows);
 
@@ -82,9 +85,10 @@ public void givenAValidRowWhenMappingThenAValidPlayerShouldBeConstructedBasedOnP
 
 		ApplicationContext ctx = new AnnotationConfigApplicationContext(TestConfig.class);
 		BeanWrapperRowMapper<Player> mapper = ctx.getBean("playerRowMapper", BeanWrapperRowMapper.class);
+		mapper.setHeader(HEADER);
 
 		List<String[]> rows = new ArrayList<>();
-		rows.add(new String[] { "id", "lastName", "firstName", "position", "birthYear", "debutYear" });
+		rows.add(HEADER);
 		rows.add(new String[] { "AbduKa00", "Abdul-Jabbar", "Karim", "rb", "1974", "1996" });
 		MockSheet sheet = new MockSheet("players", rows);