refactor(model): validator-core - remove support for XML models (refs #…

…351)
IGNF · Aug 8, 2024 · b629fa1 · b629fa1
1 parent e1458d7
commit b629fa1
Show file tree

Hide file tree

Showing 12 changed files with 6 additions and 253 deletions.
diff --git a/validator-core/src/main/java/fr/ign/validator/command/DocumentValidatorCommand.java b/validator-core/src/main/java/fr/ign/validator/command/DocumentValidatorCommand.java
@@ -20,8 +20,6 @@
 import org.apache.logging.log4j.MarkerManager;
 import org.locationtech.jts.geom.Geometry;
 
-import com.ctc.wstx.util.StringUtil;
-
 import fr.ign.validator.Context;
 import fr.ign.validator.Version;
 import fr.ign.validator.command.options.DocumentEmpriseOption;

diff --git a/validator-core/src/main/java/fr/ign/validator/io/AbstractModelReader.java b/validator-core/src/main/java/fr/ign/validator/io/AbstractModelReader.java
@@ -21,7 +21,7 @@
 import fr.ign.validator.tools.ModelHelper;
 
 /**
- * Common implementation for JSON and XML ModelReader.
+ * Common implementation for JSON and XML ModelReader (removed).
  *
  * @author MBorne
  */

diff --git a/validator-core/src/main/java/fr/ign/validator/io/ModelReader.java b/validator-core/src/main/java/fr/ign/validator/io/ModelReader.java
@@ -21,7 +21,7 @@ public interface ModelReader {
     public String getFormat();
 
     /**
-     * Read File as a DocumentModel (files.xml)
+     * Read File as a DocumentModel
      *
      * @param documentModelPath
      * @return

diff --git a/validator-core/src/main/java/fr/ign/validator/io/ModelReaderFactory.java b/validator-core/src/main/java/fr/ign/validator/io/ModelReaderFactory.java
@@ -2,6 +2,8 @@
 
 import java.net.URL;
 
+import fr.ign.validator.exception.InvalidModelException;
+
 /**
  * Create ModelReader instances
  *
@@ -26,7 +28,7 @@ private ModelReaderFactory() {
      */
     public static ModelReader createModelReader(URL url) {
         if (url.toString().endsWith(".xml")) {
-            return new XmlModelReader();
+            throw new InvalidModelException("Fail to load "+url+" (XML model support has been removed, use JSON format)");
         } else {
             return new JsonModelReader();
         }

diff --git a/validator-core/src/main/java/fr/ign/validator/io/XmlModelReader.java b/validator-core/src/main/java/fr/ign/validator/io/XmlModelReader.java
diff --git a/validator-core/src/main/java/fr/ign/validator/io/xml/AttributeTypeAdapter.java b/validator-core/src/main/java/fr/ign/validator/io/xml/AttributeTypeAdapter.java
diff --git a/validator-core/src/main/java/fr/ign/validator/io/xml/FileModelAdapter.java b/validator-core/src/main/java/fr/ign/validator/io/xml/FileModelAdapter.java
diff --git a/validator-core/src/main/java/fr/ign/validator/model/AttributeType.java b/validator-core/src/main/java/fr/ign/validator/model/AttributeType.java
@@ -4,15 +4,13 @@
 import java.util.List;
 
 import javax.xml.bind.annotation.XmlTransient;
-import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 import com.fasterxml.jackson.annotation.JsonInclude.Include;
 
 import fr.ign.validator.data.Attribute;
-import fr.ign.validator.io.xml.AttributeTypeAdapter;
 import fr.ign.validator.validation.Validator;
 import fr.ign.validator.validation.attribute.AttributeRequiredValidator;
 import fr.ign.validator.validation.attribute.CharactersValidator;
@@ -24,7 +22,6 @@
  *
  * @param <T> the matching java type
  */
-@XmlJavaTypeAdapter(AttributeTypeAdapter.class)
 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type")
 @JsonInclude(value = Include.NON_NULL)
 public abstract class AttributeType<T> implements Model, Cloneable {

diff --git a/validator-core/src/main/java/fr/ign/validator/model/AttributeTypeFactory.java b/validator-core/src/main/java/fr/ign/validator/model/AttributeTypeFactory.java
@@ -10,7 +10,7 @@
  * Prototype based factory providing AttributeType creation by name (Boolean,
  * Double, etc.)
  *
- * @see src/main/resources/META-INF/services/fr.ign.validator.model.AttributeType
+ * @see src/main/resources/META-INF/services/fr.ign.validator.model.AttributeType containing the list of this types.
  *
  * @author MBorne
  *

diff --git a/validator-core/src/main/java/fr/ign/validator/model/DocumentModel.java b/validator-core/src/main/java/fr/ign/validator/model/DocumentModel.java
@@ -4,12 +4,6 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import javax.xml.bind.annotation.XmlElement;
-import javax.xml.bind.annotation.XmlElementWrapper;
-import javax.xml.bind.annotation.XmlRootElement;
-import javax.xml.bind.annotation.XmlTransient;
-import javax.xml.bind.annotation.XmlType;
-
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import org.apache.logging.log4j.Marker;
@@ -33,10 +27,6 @@
  *
  * @author MBorne
  */
-@XmlRootElement(name = "document")
-@XmlType(propOrder = {
-    "name", "regexp", "fileModels", "staticTables"
-})
 public class DocumentModel implements Model {
     public static final Logger log = LogManager.getRootLogger();
     public static final Marker MARKER = MarkerManager.getMarker("DocumentModel");
@@ -103,7 +93,6 @@ public void setName(String name) {
         this.name = name;
     }
 
-    @XmlTransient
     public DocumentConstraints getConstraints() {
         return constraints;
     }
@@ -132,8 +121,6 @@ public void setRegexp(String regexp) {
         this.constraints.setFolderName(regexp);
     }
 
-    @XmlElementWrapper(name = "files")
-    @XmlElement(name = "file")
     @JsonProperty("files")
     public List<FileModel> getFileModels() {
         return fileModels;

diff --git a/validator-core/src/main/java/fr/ign/validator/model/FeatureType.java b/validator-core/src/main/java/fr/ign/validator/model/FeatureType.java
@@ -3,12 +3,6 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import javax.xml.bind.annotation.XmlElement;
-import javax.xml.bind.annotation.XmlElementWrapper;
-import javax.xml.bind.annotation.XmlRootElement;
-import javax.xml.bind.annotation.XmlTransient;
-import javax.xml.bind.annotation.XmlType;
-
 import com.fasterxml.jackson.annotation.JsonProperty;
 
 import fr.ign.validator.model.type.GeometryType;
@@ -18,10 +12,6 @@
  *
  * @author MBorne
  */
-@XmlRootElement
-@XmlType(propOrder = {
-    "name", "description", "attributes", "constraints"
-})
 public class FeatureType implements Model {
     /**
      * Parent (optional)
@@ -72,13 +62,11 @@ public FeatureType getParent() {
      *
      * @param featureType
      */
-    @XmlTransient
     public void setParent(FeatureType parent) {
         this.parent = parent;
     }
 
     @Override
-    @XmlElement(name = "typeName")
     public String getName() {
         return name;
     }
@@ -120,7 +108,6 @@ public String getDescription() {
         return description;
     }
 
-    @XmlElement
     public void setDescription(String description) {
         this.description = description;
     }
@@ -136,8 +123,6 @@ public List<AttributeType<?>> getAttributes() {
         return attributes;
     }
 
-    @XmlElementWrapper(name = "attributes")
-    @XmlElement(name = "attribute")
     @JsonProperty("columns")
     public void setAttributes(List<AttributeType<?>> attributes) {
         this.attributes = attributes;