validator-plugin-cnig - refactor code removing cnig_document_validator

Author: mborne

validator-core/src/main/java/fr/ign/validator/process/MetadataPreProcess.java

@@ -42,8 +42,25 @@ public void beforeMatching(Context context, Document document) throws Exception
 	 */
 	@Override
 	public void beforeValidate(Context context, Document document) throws Exception {
+		/*
+		 * Find first metadata file
+		 */
+		log.info(MARKER, "Locate metadata files...");
+		List<DocumentFile> metadataFiles = document.getDocumentFiles(MetadataModel.class);
+		if ( metadataFiles.isEmpty() ){
+			// already reported if metadata is expected
+			log.warn(MARKER, "Metadata file not found");
+			return;
+		}
+		if ( metadataFiles.size() > 1 ){
+			context
+				.report(context.createError(CoreErrorCodes.METADATA_MULTIPLE_FILES)
+				.setMessageParam("FILENAME_LIST", formatFiles(context,metadataFiles))
+			);
+		}
+		File metadataFile = metadataFiles.get(0).getPath() ;
 		log.info(MARKER, "Search data charset in metadata files...");
-		Charset charset = readCharsetFromMetadata(context, document);
+		Charset charset = readCharsetFromMetadata(context,metadataFile);
 		if ( null == charset ){
 			log.warn(MARKER, "Charset not found in metadata files!");
 		}else{
@@ -58,18 +75,7 @@ public void beforeValidate(Context context, Document document) throws Exception
 	 * @param document
 	 * @return
 	 */
-	private Charset readCharsetFromMetadata(Context context, Document document) {
-		List<DocumentFile> metadataFiles = document.getDocumentFiles(MetadataModel.class);
-		if ( metadataFiles.isEmpty() ){
-			return null;
-		}
-		if ( metadataFiles.size() > 1 ){
-			context.report(context.createError(CoreErrorCodes.METADATA_MULTIPLE_FILES)
-				.setMessageParam("FILENAME_LIST", formatFiles(context,metadataFiles))
-			);
-		}
-		
-		File metadataFile = metadataFiles.get(0).getPath() ;
+	private Charset readCharsetFromMetadata(Context context, File metadataFile) {
 		try {
 			Metadata reader = MetadataISO19115.readFile(metadataFile);
 			CharacterSetCode characterSet = reader.getCharacterSet();

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

@@ -9,7 +9,7 @@
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang.StringUtils;
 
-import fr.ign.validator.cnig.utils.IdgestExtractor;
+import fr.ign.validator.cnig.process.internal.IdgestExtractor;
 import fr.ign.validator.command.AbstractCommand;
 
 

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

@@ -1,4 +1,4 @@
-package fr.ign.validator.cnig.utils;
+package fr.ign.validator.cnig.model;
 
 /**
  * 
@@ -9,8 +9,10 @@
  * @author MBorne
  *
  */
-public class DocumentModelNameUtils {
+public class DocumentModelName {
 
+	private static final String REGEXP_YYYY = "[0-9]{4}";
+	
 	/**
 	 * Test if document model is a CNIG standard
 	 * @param documentModelName
@@ -44,7 +46,7 @@ public static String getVersion(String documentModelName){
 		}
 		String[] parts = documentModelName.split("_");
 		String candidate = parts[parts.length - 1];
-		if ( ! candidate.matches("[0-9]{4}") ){
+		if ( ! candidate.matches(REGEXP_YYYY) ){
 			return null;
 		}
 		return candidate;

validator-plugin-cnig/src/main/java/fr/ign/validator/cnig/idurba/IdurbaHelperFactory.java

@@ -1,4 +1,4 @@
-package fr.ign.validator.cnig.utils;
+package fr.ign.validator.cnig.model;
 
 /**
  * 
@@ -7,14 +7,14 @@
  * @author MBorne
  *
  */
-public class DocumentNameHelper {
+public class DocumentName {
 
 	public static final String REGEXP_YYYYMMDD = "[0-9]{8}" ; 
 
-	public static final String REGEXP_DU_TERRITOIRE = "("+InseeUtils.REGEXP_COMMUNE+"|"+SirenUtils.REGEXP_SIREN+")" ; 
+	public static final String REGEXP_DU_TERRITOIRE = "("+MunicipalityCode.REGEXP+"|"+SirenCode.REGEXP+")" ; 
 	public static final String REGEXP_DU_TYPE       = "(PLU|PLUi|POS|CC|PSMV)" ;
 	public static final String REGEXP_DU_CODE       = "[A-Z]";
 
-	public static final String REGEXP_DU = REGEXP_DU_TERRITOIRE + "_" + REGEXP_DU_TYPE + "_" + DocumentNameHelper.REGEXP_YYYYMMDD+ "(_"+REGEXP_DU_CODE+")?" ;
-
+	public static final String REGEXP_DU = REGEXP_DU_TERRITOIRE + "_" + REGEXP_DU_TYPE + "_" + DocumentName.REGEXP_YYYYMMDD+ "(_"+REGEXP_DU_CODE+")?" ;
+	
 }

validator-plugin-cnig/src/main/java/fr/ign/validator/cnig/utils/DocumentModelNameUtils.java renamed to validator-plugin-cnig/src/main/java/fr/ign/validator/cnig/model/DocumentModelName.java

@@ -0,0 +1,13 @@
+package fr.ign.validator.cnig.model;
+
+public enum DocumentType {
+	PLU,
+	POS,
+	CC,
+	PLUi,
+	PSMV,
+	
+	SUP,
+	
+	SCoT
+}

validator-plugin-cnig/src/main/java/fr/ign/validator/cnig/utils/DocumentNameHelper.java renamed to validator-plugin-cnig/src/main/java/fr/ign/validator/cnig/model/DocumentName.java

@@ -1,4 +1,4 @@
-package fr.ign.validator.cnig.utils;
+package fr.ign.validator.cnig.model;
 
 import org.apache.commons.lang.StringUtils;
 
@@ -10,7 +10,7 @@
  * @author MBorne
  *
  */
-public class SpecificationUtils {
+public class MetadataSpecification {
 
 	private static final String CNIG_SPECIFICATION_REGEXP = "(?i)CNIG\\s(CC|POS|PLU|PLUi|PSMV|SUP)\\sv\\d{4}";
 

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

@@ -0,0 +1,28 @@
+package fr.ign.validator.cnig.model;
+
+/**
+ * 
+ * Validates insee codes
+ * 
+ * @author MBorne
+ *
+ */
+public class MunicipalityCode {
+	public static final String REGEXP = "(2[AB][0-9]{3}|[0-9]{5})" ; 
+
+	/**
+	 * Validates a municipality code
+	 * 
+	 * @param insee
+	 * @return
+	 */
+	public static boolean isValidCommune(String insee){
+		if ( null == insee ){
+			return false ;
+		}
+		return insee.matches(REGEXP) ;
+	}
+
+}
+
+

validator-plugin-cnig/src/main/java/fr/ign/validator/cnig/utils/SpecificationUtils.java renamed to validator-plugin-cnig/src/main/java/fr/ign/validator/cnig/model/MetadataSpecification.java

@@ -1,4 +1,4 @@
-package fr.ign.validator.cnig.utils;
+package fr.ign.validator.cnig.model;
 
 /**
  * 
@@ -9,9 +9,9 @@
  * @author MBorne
  *
  */
-public class SirenUtils {
+public class SirenCode {
 
-	public static final String REGEXP_SIREN = "[0-9]{9}" ;
+	public static final String REGEXP = "[0-9]{9}" ;
 
 	/**
 	 * Indicates if given parameter is a valid SIREN code
@@ -23,7 +23,7 @@ public static boolean isValid(String siren){
 		if ( null == siren ){
 			return false ;
 		}
-		return siren.matches(REGEXP_SIREN) ;
+		return siren.matches(REGEXP) ;
 	}
-	
+
 }