Merge pull request #233 from entur/add_support_for_jaxb_validators

Add support for JAXB validators

Author: vpaturet

pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>org.entur</groupId>
     <artifactId>netex-validator-java</artifactId>
-    <version>2.0.27-SNAPSHOT</version>
+    <version>3.0.0-SNAPSHOT</version>
 
     <name>netex-validator-java</name>
     <description>Library for validating NeTEx datasets against the Nordic NeTEx Profile.</description>
@@ -55,7 +55,9 @@
         <jdk.version>17</jdk.version>
 
         <netex-java-model.version>2.0.15</netex-java-model.version>
+        <netex-parser-java.version>3.1.23</netex-parser-java.version>
         <saxon.version>11.6</saxon.version>
+        <geotools.version>32.0</geotools.version>
         <snakeyaml.version>2.3</snakeyaml.version>
         <slf4j.version>2.0.16</slf4j.version>
 
@@ -108,12 +110,38 @@
             <artifactId>netex-java-model</artifactId>
             <version>${netex-java-model.version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.entur</groupId>
+            <artifactId>netex-parser-java</artifactId>
+            <version>${netex-parser-java.version}</version>
+        </dependency>
         <dependency>
             <groupId>net.sf.saxon</groupId>
             <artifactId>Saxon-HE</artifactId>
             <version>${saxon.version}</version>
         </dependency>
 
+        <dependency>
+            <groupId>org.geotools</groupId>
+            <artifactId>gt-coverage</artifactId>
+            <version>${geotools.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.geotools</groupId>
+            <artifactId>gt-geotiff</artifactId>
+            <version>${geotools.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.geotools</groupId>
+            <artifactId>gt-api</artifactId>
+            <version>${geotools.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.geotools</groupId>
+            <artifactId>gt-geojson-core</artifactId>
+            <version>${geotools.version}</version>
+        </dependency>
+
         <dependency>
             <groupId>org.yaml</groupId>
             <artifactId>snakeyaml</artifactId>
@@ -364,6 +392,13 @@
             </plugin>
         </plugins>
     </build>
+    <repositories>
+        <repository>
+            <id>osgeo</id>
+            <name>Open Source Geospatial Foundation Repository</name>
+            <url>https://repo.osgeo.org/repository/release/</url>
+        </repository>
+    </repositories>
     <profiles>
         <profile>
             <id>sonar</id>

src/main/java/org/entur/netex/validation/validator/NetexDatasetValidator.java renamed to src/main/java/org/entur/netex/validation/validator/AbstractDatasetValidator.java

@@ -2,19 +2,20 @@
 
 import java.util.Objects;
 
-public abstract class NetexDatasetValidator {
+/**
+ * Base class for DatasetValidators.
+ */
+public abstract class AbstractDatasetValidator implements DatasetValidator {
 
   private final ValidationReportEntryFactory validationReportEntryFactory;
 
-  protected NetexDatasetValidator(
+  protected AbstractDatasetValidator(
     ValidationReportEntryFactory validationReportEntryFactory
   ) {
     this.validationReportEntryFactory =
       Objects.requireNonNull(validationReportEntryFactory);
   }
 
-  public abstract ValidationReport validate(ValidationReport validationReport);
-
   protected ValidationReportEntry createValidationReportEntry(
     String code,
     DataLocation dataLocation,

src/main/java/org/entur/netex/validation/validator/AbstractNetexValidator.java renamed to src/main/java/org/entur/netex/validation/validator/AbstractXPathValidator.java

@@ -4,13 +4,13 @@
 import org.entur.netex.validation.validator.id.IdVersion;
 
 /**
- * Base class for NeTEx validators.
+ * Base class for XPath-based validators.
  */
-public abstract class AbstractNetexValidator implements NetexValidator {
+public abstract class AbstractXPathValidator implements XPathValidator {
 
   private final ValidationReportEntryFactory validationReportEntryFactory;
 
-  protected AbstractNetexValidator(
+  protected AbstractXPathValidator(
     ValidationReportEntryFactory validationReportEntryFactory
   ) {
     this.validationReportEntryFactory =

src/main/java/org/entur/netex/validation/validator/DatasetValidator.java

@@ -0,0 +1,9 @@
+package org.entur.netex.validation.validator;
+
+/**
+ * Validator applied to the whole dataset (not individual files).
+ * This includes validators that require data collected from different files within the dataset.
+ */
+public interface DatasetValidator {
+  ValidationReport validate(ValidationReport validationReport);
+}

src/main/java/org/entur/netex/validation/validator/NetexValidator.java

@@ -1,25 +1,18 @@
 package org.entur.netex.validation.validator;
 
 import java.util.Set;
-import org.entur.netex.validation.validator.xpath.ValidationContext;
 
 /**
- * A validator that updates a {@link ValidationReport} according to a {@link ValidationContext}.
+ *  A Validator applied to a NeTEx file.
  */
-public interface NetexValidator {
+public interface NetexValidator<V extends ValidationContext> {
   /**
-   * Validate the document specified in the {@link ValidationContext} and update the given {@link ValidationReport}
-   * @param validationReport the validation report to be updated.
-   * @param validationContext the current validation context.
+   * Validate NeTEx data provided by the validation context and report issues in the validation report.
    */
-  void validate(
-    ValidationReport validationReport,
-    ValidationContext validationContext
-  );
+  void validate(ValidationReport validationReport, V validationContext);
 
   /**
    * Return the textual descriptions of the validation rules verified by this validator.
-   * @return the textual descriptions of the rules
    */
   Set<String> getRuleDescriptions();
 }