AER-3988 Improve flow on handling import year (#350)

When importing the sources are checked for having emissions. However when both the specific import year and year in GML are for years for which no emission factors are available all sources that calculate emissions will be reported as having no emissions. This is not desired because upstream the year will be set to an valid year and emissions will be recalculated again making these earlier reported missing emissions invalid. Therefore it is better to always make sure the year used is a valid year. Because it's not known what a valid year is this is delegated by adding a method to GMLHelper to get the year. The implementation should always return a valid year, and also the implementation has the option to report a warning about the year in case it was adjusted.

This implementation uses a default implementation in the interface, which makes it backwards compatible. With this new implementation we always assume the year is adjusted to a valid year it doesn't add much to also validate the year to be out of certain ranges. Therefore these GMLValidator#validateYear method has been removed.

Author: Hilbrand

source/imaer-gml/src/main/java/nl/overheid/aerius/gml/GMLValidator.java

@@ -27,9 +27,6 @@
 
 public final class GMLValidator {
 
-  private static final int YEAR_LOWER_BOUNDARY = 1900;
-  private static final int YEAR_UPPER_BOUNDARY = 2100;
-
   private GMLValidator() {
     // Util class
   }
@@ -40,14 +37,6 @@ public static void validateGMLVersion(final AeriusGMLVersion version, final List
     }
   }
 
-  public static void validateYear(final int year, final List<AeriusException> exceptions) {
-    if (year < YEAR_LOWER_BOUNDARY) {
-      exceptions.add(new AeriusException(ImaerExceptionReason.GML_VALIDATION_FAILED, "year must be greater than " + YEAR_LOWER_BOUNDARY));
-    } else if (year > YEAR_UPPER_BOUNDARY) {
-      exceptions.add(new AeriusException(ImaerExceptionReason.GML_VALIDATION_FAILED, "year must be less than " + YEAR_UPPER_BOUNDARY));
-    }
-  }
-
   /**
    * Validates all meta data elements. Adds any violation to the list of exceptions.
    *

source/imaer-gml/src/main/java/nl/overheid/aerius/gml/base/GMLHelper.java

@@ -17,6 +17,7 @@
 package nl.overheid.aerius.gml.base;
 
 import java.util.List;
+import java.util.Optional;
 
 import nl.overheid.aerius.gml.base.source.ship.v31.GMLInlandShippingSupplier;
 import nl.overheid.aerius.shared.domain.geo.ReceptorGridSettings;
@@ -57,4 +58,19 @@ default EmissionSourceLimits getEmissionSourceGeometryLimits() {
     // Added default for backward compatibility. Will be removed when used in Calculator.
     return null;
   }
+
+  /**
+   * Returns the year to use for importing and the year that will be used for calculation emissions.
+   * Default implementation uses importYear or if not set the situationYear.
+   * Overriding implementations can force the year to be a year within the range of years emission values are available for.
+   * And to add a warning in case the year was changed.
+   *
+   * @param importYear year specified as being imported
+   * @param situationYear year as specified in the situation
+   * @param warnings list to add warnings in case the year is different from specified years.
+   * @return the year to use for import
+   */
+  default int yearToUseForImport(final Optional<Integer> importYear, final int situationYear, final List<AeriusException> warnings) {
+    return importYear.orElse(situationYear);
+  }
 }

source/imaer-gml/src/main/java/nl/overheid/aerius/importer/ImaerImporter.java

@@ -73,6 +73,7 @@ public class ImaerImporter {
   private static final Logger LOGGER = LoggerFactory.getLogger(ImaerImporter.class);
 
   private final GMLReaderFactory factory;
+  private final GMLHelper gmlHelper;
   private final EPSG epsg;
   private final EmissionSourceLimits limits;
 
@@ -83,6 +84,7 @@ public class ImaerImporter {
    * @throws AeriusException
    */
   public ImaerImporter(final GMLHelper gmlHelper, final GMLReaderFactory gmlReaderFactory) throws AeriusException {
+    this.gmlHelper = gmlHelper;
     factory = gmlReaderFactory;
     epsg = gmlHelper.getReceptorGridSettings().getEPSG();
     limits = gmlHelper.getEmissionSourceGeometryLimits();
@@ -146,14 +148,13 @@ public void importStream(final InputStream inputStream, final Set<ImportOption>
     }
 
     final AeriusGMLVersion version = reader.getVersion();
-    setImportResultMetaData(result, reader);
+    setImportResultMetaData(result, reader, importYear);
     GMLValidator.validateMetaData(result.getImportedMetaData(), result.getExceptions(), ImportOption.VALIDATE_METADATA.in(importOptions)
         && result.getArchiveMetaData() == null);
-    GMLValidator.validateYear(result.getSituation().getYear(), result.getExceptions());
     GMLValidator.validateGMLVersion(version, result.getWarnings());
 
     final ScenarioSituation situation = addSituationProperties(reader, result);
-    addEmissionSources(reader, importOptions, result, importYear);
+    addEmissionSources(reader, importOptions, result);
     addAeriusPoints(reader, importOptions, result);
     addCimlkMeasures(reader, importOptions, result, situation);
     addCimlkDispersionLines(reader, importOptions, situation);
@@ -194,15 +195,14 @@ protected GMLReader createGMLReader(final InputStream inputStream, final Set<Imp
         result.getExceptions(), result.getWarnings());
   }
 
-  private void addEmissionSources(final GMLReader reader, final Set<ImportOption> importOptions, final ImportParcel result,
-      final Optional<Integer> importYear) throws AeriusException {
+  private void addEmissionSources(final GMLReader reader, final Set<ImportOption> importOptions, final ImportParcel result) throws AeriusException {
     if (ImportOption.INCLUDE_SOURCES.in(importOptions)) {
       final List<EmissionSourceFeature> sources = reader.readEmissionSourceList();
       if (ImportOption.VALIDATE_SOURCES.in(importOptions)) {
         EmissionSourceValidator.validateSources(sources, result.getExceptions(), result.getWarnings(),
             factory.createValidationHelper());
       }
-      reader.enforceEmissions(sources, importYear.orElse(result.getSituation().getYear()));
+      reader.enforceEmissions(sources, result.getSituation().getYear());
       if (ImportOption.VALIDATE_SOURCES.in(importOptions)) {
         EmissionSourceValidator.validateSourcesWithEmissions(sources, result.getExceptions(), result.getWarnings());
       }
@@ -324,9 +324,9 @@ private static ArrayList<CalculationPointFeature> filterResultPoints(final List<
     return list;
   }
 
-  private static void setImportResultMetaData(final ImportParcel result, final GMLReader reader) throws AeriusException {
+  private void setImportResultMetaData(final ImportParcel result, final GMLReader reader, final Optional<Integer> importYear) throws AeriusException {
     final GMLMetaDataReader metaDataReader = reader.metaDataReader();
-    result.getSituation().setYear(metaDataReader.readYear());
+    result.getSituation().setYear(gmlHelper.yearToUseForImport(importYear, reader.metaDataReader().readYear(), result.getWarnings()));
     result.setVersion(metaDataReader.readAeriusVersion());
     result.setDatabaseVersion(metaDataReader.readDatabaseVersion());
     result.setGmlCreator(metaDataReader.readGmlCreator());

source/imaer-gml/src/test/java/nl/overheid/aerius/gml/AssertGML.java

@@ -236,6 +236,7 @@ static GMLHelper mockGMLHelper() throws AeriusException {
   static GMLHelper mockGMLHelper(final CharacteristicsType ct) throws AeriusException {
     final GMLHelper gmlHelper = mock(GMLHelper.class);
     when(gmlHelper.getReceptorGridSettings()).thenReturn(ReceptorGridSettings.NL);
+    when(gmlHelper.yearToUseForImport(any(), anyInt(), any())).thenCallRealMethod();
     mockEmissionSourceGeometryLimits(gmlHelper);
     when(gmlHelper.getCharacteristicsType()).thenReturn(ct);
     final TestValidationAndEmissionHelper validationAndEmissionHelper = new TestValidationAndEmissionHelper(

source/imaer-gml/src/test/java/nl/overheid/aerius/gml/GMLValidateErrorsTest.java

@@ -233,18 +233,6 @@ void testGMLUnknownError() throws IOException {
     assertResult("fout_666_unknown_error", "GML Unknown error", ImaerExceptionReason.INTERNAL_ERROR, IllegalArgumentException.class);
   }
 
-  @Test
-  void testGMLYear2100() throws IOException {
-    assertResult("fout_year_over_2100", "GML year greater than", ImaerExceptionReason.GML_VALIDATION_FAILED,
-        e -> assertEquals("year must be less than 2100", e.getArgs()[0], "Year invalid"));
-  }
-
-  @Test
-  void testGMLYear1900() throws IOException {
-    assertResult("fout_year_under_1900", "GML year under than", ImaerExceptionReason.GML_VALIDATION_FAILED,
-        e -> assertEquals("year must be greater than 1900", e.getArgs()[0], "Year invalid"));
-  }
-
   @Test
   void testGMLCustomTimeVaryingProfileUnknownType() throws IOException {
     assertResult("fout_1023_custom_time_varying_profile", "GML custom time-varying profile type",

source/imaer-gml/src/test/java/nl/overheid/aerius/gml/InvalidGMLTest.java

@@ -81,11 +81,6 @@ void testInvalidXML3() throws IOException, AeriusException {
     assertResult("invalid_xml_3", "Expected GML parse error", ImaerExceptionReason.GML_VALIDATION_FAILED);
   }
 
-  @Test
-  void testInvalidYear() throws IOException, AeriusException {
-    assertResult("invalid_year", "Expected incorrect year message", ImaerExceptionReason.GML_VALIDATION_FAILED);
-  }
-
   @Test
   void testUnsupportedAeriusGMLVersion() throws IOException, AeriusException {
     assertResult("unsupported_aerius_gml_version", "", ImaerExceptionReason.GML_VERSION_NOT_SUPPORTED);