prepare code validation refactoring (refs #124)

Author: mborne

validator-core/src/main/java/fr/ign/validator/code/CodeList.java

@@ -3,8 +3,10 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.List;
-import java.util.MissingResourceException;
+import java.util.Map;
 import java.util.ResourceBundle;
 
 /**
@@ -16,17 +18,24 @@
  *
  */
 public class CodeList {
-
+	/**
+	 * The name of the code list
+	 */
 	private String name ;
-	
-	private ResourceBundle bundle ;
-	
-	private CodeList(String name){
+	/**
+	 * The list of allowed codes associated to descriptions
+	 */
+	private Map<String,String> codes = new HashMap<>() ;
+
+	private CodeList(String name, Map<String, String> codes){
 		this.name = name;
-		
-		this.bundle = ResourceBundle.getBundle("codes/"+name);
+		this.codes = codes;
 	}
 
+	/**
+	 * Get the name of the list
+	 * @return
+	 */
 	public String getName() {
 		return name;
 	}
@@ -37,9 +46,7 @@ public String getName() {
 	 * @return
 	 */
 	public Collection<String> getAllowedValues(){
-		List<String> keys = new ArrayList<>(bundle.keySet());
-		Collections.sort(keys);
-		return keys;
+		return codes.keySet();
 	}
 
 	/**
@@ -48,22 +55,31 @@ public Collection<String> getAllowedValues(){
 	 * @param code
 	 * @return
 	 */
-	public String getTranslation(String code){
-		try {
-			return this.bundle.getString(code);
-		}catch (MissingResourceException e){
-			return null;
-		}
+	public String getDescription(String code){
+		return codes.get(code);
 	}
 
 	/**
 	 * Gets a code list by a given name
 	 * 
+	 * TODO Read JSON file where objects contains at least a name
+	 * 
 	 * @param name
 	 * @return
 	 */
 	public static CodeList getCodeList(String name){
-		return new CodeList(name);
+		/* load bundle file */
+		ResourceBundle bundle = ResourceBundle.getBundle("codes/"+name);
+
+		/* retreive code descriptions */
+		Map<String,String> codes = new LinkedHashMap<>();
+		List<String> keys = new ArrayList<>(bundle.keySet());
+		Collections.sort(keys);
+		for (String key : keys) {
+			codes.put(key,bundle.getString(key));
+		}
+		
+		return new CodeList(name,codes);
 	}
 
 }

validator-core/src/main/java/fr/ign/validator/code/CodeListValue.java

@@ -17,7 +17,7 @@ public abstract class CodeListValue {
 	 */
 	private CodeList codeList ;
 	/**
-	 * ISO 19115 code for charset
+	 * The value of the code
 	 */
 	private String value;
 

validator-core/src/main/java/fr/ign/validator/metadata/code/CharacterSetCode.java

@@ -37,7 +37,7 @@ public static CharacterSetCode valueOf(String code){
 	 * @return
 	 */
 	public Charset getCharset(){
-		String charsetName = CODE_LIST.getTranslation(getValue());
+		String charsetName = CODE_LIST.getDescription(getValue());
 		if ( null == charsetName ){
 			return null;
 		}

validator-core/src/main/java/fr/ign/validator/validation/attribute/GeometryErrorCode.java

@@ -39,7 +39,7 @@ public static GeometryErrorCode valueOf(String code){
 	 * @return
 	 */
 	public String getMessage(){
-		return CODE_LIST.getTranslation(getValue());
+		return CODE_LIST.getDescription(getValue());
 	}
 
 

validator-plugin-cnig/src/main/java/fr/ign/validator/cnig/command/CnigExtractIdgestCommand.java

@@ -1,6 +1,7 @@
 package fr.ign.validator.cnig.command;
 
 import java.io.File;
+import java.nio.charset.StandardCharsets;
 
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.Option;
@@ -61,7 +62,7 @@ public void execute() throws Exception {
 
 		// write results to file
 		File resultFile = new File(servitudeFile.getParent(), "idGest.txt");
-		FileUtils.writeStringToFile(resultFile, idGest);
+		FileUtils.writeStringToFile(resultFile, idGest,StandardCharsets.UTF_8);
 	}
 
 }

validator-plugin-cnig/src/main/java/fr/ign/validator/cnig/model/MunicipalityCode.java

@@ -2,7 +2,7 @@
 
 /**
  * 
- * Validates insee codes
+ * Validates INSEE codes for municipalities
  * 
  * @author MBorne
  *
@@ -13,14 +13,14 @@ public class MunicipalityCode {
 	/**
 	 * Validates a municipality code
 	 * 
-	 * @param insee
+	 * @param value
 	 * @return
 	 */
-	public static boolean isValidCommune(String insee){
-		if ( null == insee ){
+	public static boolean isValid(String value){
+		if ( null == value ){
 			return false ;
 		}
-		return insee.matches(REGEXP) ;
+		return value.matches(REGEXP) ;
 	}
 
 }

validator-plugin-cnig/src/main/java/fr/ign/validator/cnig/validation/attribute/InseeValidator.java

@@ -60,7 +60,7 @@ public void afterValidate(Context context, Document document) throws Exception {
 	@Override
 	public void validate(Context context, Attribute<String> validatable) {
 		String insee = validatable.getBindedValue() ;
-		if ( ! MunicipalityCode.isValidCommune(insee) ){
+		if ( ! MunicipalityCode.isValid(insee) ){
 			context.report(context.createError(CnigErrorCodes.CNIG_INSEE_INVALID)
 				.setMessageParam("VALUE", insee)
 			);

validator-plugin-cnig/src/test/java/fr/ign/validator/cnig/command/CnigExtractIdgestCommandTest.java

@@ -14,6 +14,11 @@
 import fr.ign.validator.tools.ResourceHelper;
 
 /**
+ * 
+ * Test command CnigExtractIdgestCommand
+ *  
+ * TODO use TemporaryFolder
+ * TODO test on a non SERVITUDE file
  * 
  * @author FCerizay
  *

validator-plugin-cnig/src/test/java/fr/ign/validator/cnig/error/CnigErrorCodesTest.java

@@ -13,7 +13,13 @@
 import fr.ign.validator.error.ErrorFactory;
 import fr.ign.validator.error.ValidatorError;
 
-
+/**
+ * 
+ * Ensure that CnigErrorCodes have default configuration 
+ * 
+ * @author MBorne
+ *
+ */
 public class CnigErrorCodesTest {
 
 	@Test

validator-plugin-cnig/src/test/java/fr/ign/validator/cnig/models/MunicipalityCodeTest.java

@@ -12,15 +12,15 @@ public class MunicipalityCodeTest {
 
 	@Test
 	public void testValidCommune(){
-		assertTrue(MunicipalityCode.isValidCommune("25349"));
-		assertTrue(MunicipalityCode.isValidCommune("2B111"));
+		assertTrue(MunicipalityCode.isValid("25349"));
+		assertTrue(MunicipalityCode.isValid("2B111"));
 	}
 
 	@Test	
 	public void testNotValidCommune(){
-		assertFalse(MunicipalityCode.isValidCommune("2534"));
-		assertFalse(MunicipalityCode.isValidCommune("253495"));
-		assertFalse(MunicipalityCode.isValidCommune("2C111"));
+		assertFalse(MunicipalityCode.isValid("2534"));
+		assertFalse(MunicipalityCode.isValid("253495"));
+		assertFalse(MunicipalityCode.isValid("2C111"));
 	}
 
 }