Allow to different series to have the same catalog numbers.

Fix #287

Author: php-coder

NEWS.txt

@@ -3,6 +3,7 @@
 - (user interface) ported to Bootstrap 3
 - (infrastructure) ported to Spring Boot
 - (functionality)  implemented possibility to user to add additional images to series
+- (functionality)  allow to different series to have the same catalog numbers
 
 0.3
 - (functionality)  implemented possibility to user to add series to his collection

src/main/java/ru/mystamps/web/controller/SeriesController.java

@@ -52,10 +52,6 @@
 import ru.mystamps.web.entity.User;
 import ru.mystamps.web.model.AddImageForm;
 import ru.mystamps.web.model.AddSeriesForm;
-import ru.mystamps.web.model.AddSeriesForm.GibbonsCatalogChecks;
-import ru.mystamps.web.model.AddSeriesForm.MichelCatalogChecks;
-import ru.mystamps.web.model.AddSeriesForm.ScottCatalogChecks;
-import ru.mystamps.web.model.AddSeriesForm.YvertCatalogChecks;
 import ru.mystamps.web.service.CategoryService;
 import ru.mystamps.web.service.CollectionService;
 import ru.mystamps.web.service.CountryService;
@@ -155,10 +151,7 @@ public String showFormWithCountry(
 
 	@RequestMapping(value = Url.ADD_SERIES_PAGE, method = RequestMethod.POST)
 	public String processInput(
-		@Validated({
-			Default.class, MichelCatalogChecks.class, ScottCatalogChecks.class,
-			YvertCatalogChecks.class, GibbonsCatalogChecks.class, AddSeriesForm.ImageChecks.class
-		}) AddSeriesForm form,
+		@Validated({ Default.class, AddSeriesForm.ImageChecks.class }) AddSeriesForm form,
 		BindingResult result,
 		HttpServletRequest request,
 		User currentUser) {

src/main/java/ru/mystamps/web/dao/GibbonsCatalogDao.java

@@ -17,9 +17,10 @@
  */
 package ru.mystamps.web.dao;
 
+import java.util.List;
 import java.util.Set;
 
 public interface GibbonsCatalogDao {
-	void add(Set<String> gibbonsNumbers);
+	List<String> add(Set<String> gibbonsNumbers);
 	void addToSeries(Integer seriesId, Set<String> gibbonsNumbers);
 }

src/main/java/ru/mystamps/web/dao/JdbcSeriesDao.java

@@ -37,11 +37,6 @@ public interface JdbcSeriesDao {
 	long countSeriesOfCollection(Integer collectionId);
 	long countStampsOfCollection(Integer collectionId);
 
-	long countByMichelNumberCode(String michelNumber);
-	long countByScottNumberCode(String scottNumber);
-	long countByYvertNumberCode(String yvertNumber);
-	long countByGibbonsNumberCode(String gibbonsNumber);
-	
 	Optional<Integer> findSeriesIdByMichelNumberCode(String michelNumber);
 	Optional<Integer> findSeriesIdByScottNumberCode(String scottNumber);
 	Optional<Integer> findSeriesIdByYvertNumberCode(String yvertNumber);

src/main/java/ru/mystamps/web/dao/MichelCatalogDao.java

@@ -17,9 +17,10 @@
  */
 package ru.mystamps.web.dao;
 
+import java.util.List;
 import java.util.Set;
 
 public interface MichelCatalogDao {
-	void add(Set<String> michelNumbers);
+	List<String> add(Set<String> michelNumbers);
 	void addToSeries(Integer seriesId, Set<String> michelNumbers);
 }

src/main/java/ru/mystamps/web/dao/ScottCatalogDao.java

@@ -17,9 +17,10 @@
  */
 package ru.mystamps.web.dao;
 
+import java.util.List;
 import java.util.Set;
 
 public interface ScottCatalogDao {
-	void add(Set<String> scottNumbers);
+	List<String> add(Set<String> scottNumbers);
 	void addToSeries(Integer seriesId, Set<String> scottNumbers);
 }

src/main/java/ru/mystamps/web/dao/YvertCatalogDao.java

@@ -17,9 +17,10 @@
  */
 package ru.mystamps.web.dao;
 
+import java.util.List;
 import java.util.Set;
 
 public interface YvertCatalogDao {
-	void add(Set<String> yvertNumbers);
+	List<String> add(Set<String> yvertNumbers);
 	void addToSeries(Integer seriesId, Set<String> yvertNumbers);
 }

src/main/java/ru/mystamps/web/dao/impl/JdbcCatalogDao.java

@@ -17,13 +17,15 @@
  */
 package ru.mystamps.web.dao.impl;
 
+import java.util.ArrayList;
+import java.util.Collections;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
 import org.apache.commons.lang3.Validate;
 
-import org.springframework.jdbc.core.namedparam.MapSqlParameterSource;
 import org.springframework.jdbc.core.namedparam.NamedParameterJdbcTemplate;
 
 import lombok.AccessLevel;
@@ -34,15 +36,21 @@ class JdbcCatalogDao {
 
 	private final NamedParameterJdbcTemplate jdbcTemplate;
 
-	// Inserts all values with  multirow INSERT expression
-	protected void add(Set<String> numbers, String addNumberSql) {
-		Validate.validState(!numbers.isEmpty(), "Numbers must be non empty");
+	protected List<String> add(Set<String> numbers, String addNumberSql) {
 		Validate.validState(!"".equals(addNumberSql), "Query must be non empty");
 
-		Map<String, Object> params = prepareNumberedParamsWithBaseName("code", numbers);
-		String sql = prepareMultirowQueryWithSingleValue(addNumberSql, "code", numbers);
+		List<String> inserted = new ArrayList<>();
+		for (String number : numbers) {
+			int affected = jdbcTemplate.update(
+				addNumberSql,
+				Collections.singletonMap("code", number)
+			);
+			if (affected > 0) {
+				inserted.add(number);
+			}
+		}
 
-		jdbcTemplate.update(sql, new MapSqlParameterSource(params));
+		return inserted;
 	}
 
 	// CheckStyle: ignore LineLength for next 1 line
@@ -58,41 +66,4 @@ protected void addToSeries(Integer seriesId, Set<String> numbers, String addNumb
 		jdbcTemplate.update(addNumbersToSeriesSql, params);
 	}
 
-	// func("code", [10, 20, 30]) -> { "code1":"10", "code2":"20", "code3":"30" }
-	private static Map<String, Object> prepareNumberedParamsWithBaseName(
-		String paramBaseName,
-		Set<String> values) {
-		
-		Map<String, Object> params = new HashMap<>();
-		int paramNum = 1;
-		for (String value : values) {
-			String key = paramBaseName + Integer.valueOf(paramNum);
-			params.put(key, value);
-			paramNum++;
-		}
-		return params;
-	}
-	
-	// "INSERT INTO t(code) VALUES(:code1)" ->
-	// "INSERT INTO t(code) VALUES(:code1),(:code2),(:code3)"
-	private static String prepareMultirowQueryWithSingleValue(
-		String sql,
-		String paramBaseName,
-		Set<String> values) {
-		
-		// don't modify query with single parameter
-		if (values.size() == 1) { // NOPMD: AvoidLiteralsInIfCondition
-			return sql;
-		}
-		
-		StringBuilder sb = new StringBuilder(sql);
-		
-		// start from 2 to skip first parameter (it's already in SQL query)
-		for (int paramNum = 2; paramNum <= values.size(); paramNum++) {
-			sb.append(",(:").append(paramBaseName).append(paramNum).append(')');
-		}
-		
-		return sb.toString();
-	}
-	
 }

src/main/java/ru/mystamps/web/dao/impl/JdbcGibbonsCatalogDaoImpl.java

@@ -17,6 +17,7 @@
  */
 package ru.mystamps.web.dao.impl;
 
+import java.util.List;
 import java.util.Set;
 
 import org.springframework.beans.factory.annotation.Value;
@@ -37,8 +38,8 @@ public JdbcGibbonsCatalogDaoImpl(NamedParameterJdbcTemplate jdbcTemplate) {
 	}
 
 	@Override
-	public void add(Set<String> gibbonsNumbers) {
-		add(gibbonsNumbers, addGibbonsNumberSql);
+	public List<String> add(Set<String> gibbonsNumbers) {
+		return add(gibbonsNumbers, addGibbonsNumberSql);
 	}
 
 	@Override

src/main/java/ru/mystamps/web/dao/impl/JdbcMichelCatalogDaoImpl.java

@@ -17,6 +17,7 @@
  */
 package ru.mystamps.web.dao.impl;
 
+import java.util.List;
 import java.util.Set;
 
 import org.springframework.beans.factory.annotation.Value;
@@ -37,8 +38,8 @@ public JdbcMichelCatalogDaoImpl(NamedParameterJdbcTemplate jdbcTemplate) {
 	}
 
 	@Override
-	public void add(Set<String> michelNumbers) {
-		add(michelNumbers, addMichelNumberSql);
+	public List<String> add(Set<String> michelNumbers) {
+		return add(michelNumbers, addMichelNumberSql);
 	}
 
 	@Override

src/main/java/ru/mystamps/web/dao/impl/JdbcScottCatalogDaoImpl.java

@@ -17,6 +17,7 @@
  */
 package ru.mystamps.web.dao.impl;
 
+import java.util.List;
 import java.util.Set;
 
 import org.springframework.beans.factory.annotation.Value;
@@ -37,8 +38,8 @@ public JdbcScottCatalogDaoImpl(NamedParameterJdbcTemplate jdbcTemplate) {
 	}
 
 	@Override
-	public void add(Set<String> scottNumbers) {
-		add(scottNumbers, addScottNumberSql);
+	public List<String> add(Set<String> scottNumbers) {
+		return add(scottNumbers, addScottNumberSql);
 	}
 
 	@Override

src/main/java/ru/mystamps/web/dao/impl/JdbcSeriesDaoImpl.java

@@ -39,7 +39,7 @@
 import ru.mystamps.web.service.dto.SitemapInfoDto;
 
 // TODO: move stamps related methods to separate interface (#88)
-@SuppressWarnings({ "PMD.AvoidDuplicateLiterals", "PMD.TooManyMethods", "PMD.TooManyFields" })
+@SuppressWarnings({ "PMD.AvoidDuplicateLiterals", "PMD.TooManyMethods" })
 @RequiredArgsConstructor
 public class JdbcSeriesDaoImpl implements JdbcSeriesDao {
 
@@ -75,18 +75,6 @@ public class JdbcSeriesDaoImpl implements JdbcSeriesDao {
 	@Value("${series.count_stamps_of_collection}")
 	private String countStampsOfCollectionSql;
 
-	@Value("${series.count_stamps_by_michel_number}")
-	private String countStampsByMichelNumberSql;
-	
-	@Value("${series.count_stamps_by_scott_number}")
-	private String countStampsByScottNumberSql;
-	
-	@Value("${series.count_stamps_by_yvert_number}")
-	private String countStampsByYvertNumberSql;
-	
-	@Value("${series.count_stamps_by_gibbons_number}")
-	private String countStampsByGibbonsNumberSql;
-	
 	@Value("${series.find_series_id_by_michel_number}")
 	private String findSeriesIdByMichelNumberSql;
 
@@ -222,42 +210,6 @@ public long countStampsOfCollection(Integer collectionId) {
 		);
 	}
 
-	@Override
-	public long countByMichelNumberCode(String michelNumber) {
-		return jdbcTemplate.queryForObject(
-			countStampsByMichelNumberSql,
-			Collections.singletonMap("michel_number", michelNumber),
-			Long.class
-		);
-	}
-	
-	@Override
-	public long countByScottNumberCode(String scottNumber) {
-		return jdbcTemplate.queryForObject(
-			countStampsByScottNumberSql,
-			Collections.singletonMap("scott_number", scottNumber),
-			Long.class
-		);
-	}
-	
-	@Override
-	public long countByYvertNumberCode(String yvertNumber) {
-		return jdbcTemplate.queryForObject(
-			countStampsByYvertNumberSql,
-			Collections.singletonMap("yvert_number", yvertNumber),
-			Long.class
-		);
-	}
-	
-	@Override
-	public long countByGibbonsNumberCode(String gibbonsNumber) {
-		return jdbcTemplate.queryForObject(
-			countStampsByGibbonsNumberSql,
-			Collections.singletonMap("gibbons_number", gibbonsNumber),
-			Long.class
-		);
-	}
-	
 	@Override
 	public Optional<Integer> findSeriesIdByMichelNumberCode(String michelNumber) {
 		try {

src/main/java/ru/mystamps/web/dao/impl/JdbcYvertCatalogDaoImpl.java

@@ -17,6 +17,7 @@
  */
 package ru.mystamps.web.dao.impl;
 
+import java.util.List;
 import java.util.Set;
 
 import org.springframework.beans.factory.annotation.Value;
@@ -37,8 +38,8 @@ public JdbcYvertCatalogDaoImpl(NamedParameterJdbcTemplate jdbcTemplate) {
 	}
 
 	@Override
-	public void add(Set<String> yvertNumbers) {
-		add(yvertNumbers, addYvertNumberSql);
+	public List<String> add(Set<String> yvertNumbers) {
+		return add(yvertNumbers, addYvertNumberSql);
 	}
 
 	@Override