Export regulated timing point information to Jore4 database.

jarkkoka · jarkkoka · commit c91b17e2e982 · 2023-04-12T16:44:42.000+03:00
diff --git a/src/main/java/fi/hsl/jore/importer/feature/batch/route/JourneyPatternStopExportMapper.java b/src/main/java/fi/hsl/jore/importer/feature/batch/route/JourneyPatternStopExportMapper.java
@@ -2,6 +2,7 @@
 
 import fi.hsl.jore.importer.feature.common.converter.IJsonbConverter;
 import fi.hsl.jore.importer.feature.common.dto.field.MultilingualString;
+import fi.hsl.jore.importer.feature.jore3.enumerated.RegulatedTimingPointStatus;
 import fi.hsl.jore.importer.feature.network.route.dto.ImporterJourneyPatternStop;
 import org.springframework.jdbc.core.RowMapper;
 
@@ -33,6 +34,9 @@ public ImporterJourneyPatternStop mapRow(final ResultSet resultSet,
                 resultSet.getString("short_id"),
                 resultSet.getBoolean("is_used_as_timing_point"),
                 Optional.ofNullable(resultSet.getString("timing_place_id")),
+                // should never throw exception because of a database check constraint
+                RegulatedTimingPointStatus.of(resultSet.getInt("regulated_timing_point_status"))
+                                          .orElseThrow(),
                 resultSet.getBoolean("is_via_point"),
                 Optional.ofNullable(resultSet.getString("via_names"))
                         .map(viaNames -> jsonConverter.fromJson(viaNames, MultilingualString.class))
diff --git a/src/main/java/fi/hsl/jore/importer/feature/batch/route/JourneyPatternStopExportProcessor.java b/src/main/java/fi/hsl/jore/importer/feature/batch/route/JourneyPatternStopExportProcessor.java
@@ -1,5 +1,6 @@
 package fi.hsl.jore.importer.feature.batch.route;
 
+import fi.hsl.jore.importer.feature.jore3.enumerated.RegulatedTimingPointStatus;
 import fi.hsl.jore.importer.feature.jore4.entity.Jore4JourneyPatternStop;
 import fi.hsl.jore.importer.feature.network.route.dto.ImporterJourneyPatternStop;
 import org.slf4j.Logger;
@@ -21,11 +22,15 @@ public Jore4JourneyPatternStop process(final ImporterJourneyPatternStop input) t
         LOGGER.debug("Processing journey pattern stop: {}", input);
 
         final boolean isUsedAsTimingPoint = isUsedAsTimingPoint(input);
+        final boolean isRegulatedTimingPoint = isRegulatedTimingPoint(input, isUsedAsTimingPoint);
+        final boolean isLoadingTimeAllowed = isLoadingTimeAllowed(input, isUsedAsTimingPoint);
 
         return Jore4JourneyPatternStop.of(input.journeyPatternJore4Id(),
                                           input.orderNumber(),
                                           input.scheduledStopPointJore4Label(),
                                           isUsedAsTimingPoint,
+                                          isRegulatedTimingPoint,
+                                          isLoadingTimeAllowed,
                                           input.isViaPoint(),
                                           input.viaPointNames()
         );
@@ -50,4 +55,29 @@ private static boolean isUsedAsTimingPoint(final ImporterJourneyPatternStop stop
 
         return false;
     }
+
+    private static boolean isRegulatedTimingPoint(final ImporterJourneyPatternStop stop,
+                                                  final boolean isUsedAsTimingPoint) {
+
+        if (stop.regulatedTimingPointStatus().isRegulatedTimingPoint()) {
+            if (isUsedAsTimingPoint) {
+                return true;
+            } else {
+                LOGGER.warn(
+                        "Jore3 route direction {}: route point {}: stop point marked as a regulated timing point, but "
+                                + "at the same time it is not used as a timing point => discarding regulated timing "
+                                + "point status",
+                        stop.routeDirectionJore3Id(),
+                        stop.orderNumber());
+            }
+        }
+
+        return false;
+    }
+
+    private static boolean isLoadingTimeAllowed(final ImporterJourneyPatternStop stop,
+                                                final boolean isUsedAsTimingPoint) {
+
+        return isUsedAsTimingPoint && stop.regulatedTimingPointStatus() == RegulatedTimingPointStatus.YES_LOAD_TIME;
+    }
 }
diff --git a/src/main/java/fi/hsl/jore/importer/feature/jore3/enumerated/RegulatedTimingPointStatus.java b/src/main/java/fi/hsl/jore/importer/feature/jore3/enumerated/RegulatedTimingPointStatus.java
@@ -35,6 +35,10 @@ public String getDescription() {
         return description;
     }
 
+    public boolean isRegulatedTimingPoint() {
+        return this == YES || this == YES_LOAD_TIME;
+    }
+
     public static Optional<RegulatedTimingPointStatus> of(final int i) {
         return Arrays.stream(values())
                      .filter(transportType -> transportType.value == i)
diff --git a/src/main/java/fi/hsl/jore/importer/feature/jore4/entity/Jore4JourneyPatternStop.java b/src/main/java/fi/hsl/jore/importer/feature/jore4/entity/Jore4JourneyPatternStop.java
@@ -21,6 +21,10 @@ public interface Jore4JourneyPatternStop {
 
     boolean isUsedAsTimingPoint();
 
+    boolean isRegulatedTimingPoint();
+
+    boolean isLoadingTimeAllowed();
+
     boolean isViaPoint();
 
     Optional<MultilingualString> viaPointNames();
@@ -29,6 +33,8 @@ static Jore4JourneyPatternStop of(final UUID journeyPatternId,
                                       final int scheduledStopPointSequence,
                                       final String scheduledStopPointLabel,
                                       final boolean isUsedAsTimingPoint,
+                                      final boolean isRegulatedTimingPoint,
+                                      final boolean isLoadingTimeAllowed,
                                       final boolean isViaPoint,
                                       final Optional<MultilingualString> viaPointNames) {
 
@@ -38,6 +44,8 @@ static Jore4JourneyPatternStop of(final UUID journeyPatternId,
                 .scheduledStopPointSequence(scheduledStopPointSequence)
                 .scheduledStopPointLabel(scheduledStopPointLabel)
                 .isUsedAsTimingPoint(isUsedAsTimingPoint)
+                .isRegulatedTimingPoint(isRegulatedTimingPoint)
+                .isLoadingTimeAllowed(isLoadingTimeAllowed)
                 .isViaPoint(isViaPoint)
                 .viaPointNames(viaPointNames)
                 .build();
diff --git a/src/main/java/fi/hsl/jore/importer/feature/jore4/repository/Jore4JourneyPatternStopRepository.java b/src/main/java/fi/hsl/jore/importer/feature/jore4/repository/Jore4JourneyPatternStopRepository.java
@@ -37,17 +37,21 @@ public void insert(final List<? extends Jore4JourneyPatternStop> journeyPatternS
                     SCHEDULED_STOP_POINT_IN_JOURNEY_PATTERN.SCHEDULED_STOP_POINT_LABEL,
                     SCHEDULED_STOP_POINT_IN_JOURNEY_PATTERN.SCHEDULED_STOP_POINT_SEQUENCE,
                     SCHEDULED_STOP_POINT_IN_JOURNEY_PATTERN.IS_USED_AS_TIMING_POINT,
+                    SCHEDULED_STOP_POINT_IN_JOURNEY_PATTERN.IS_REGULATED_TIMING_POINT,
+                    SCHEDULED_STOP_POINT_IN_JOURNEY_PATTERN.IS_LOADING_TIME_ALLOWED,
                     SCHEDULED_STOP_POINT_IN_JOURNEY_PATTERN.IS_VIA_POINT,
                     SCHEDULED_STOP_POINT_IN_JOURNEY_PATTERN.VIA_POINT_NAME_I18N,
                     SCHEDULED_STOP_POINT_IN_JOURNEY_PATTERN.VIA_POINT_SHORT_NAME_I18N
-                ).values((UUID) null, null, null, null, null, null, null)
+                ).values((UUID) null, null, null, null, null, null, null, null, null)
             );
 
             journeyPatternStops.forEach(journeyPatternStop -> batch.bind(
                     journeyPatternStop.journeyPatternId(),
                     journeyPatternStop.scheduledStopPointLabel(),
                     journeyPatternStop.scheduledStopPointSequence(),
                     journeyPatternStop.isUsedAsTimingPoint(),
+                    journeyPatternStop.isRegulatedTimingPoint(),
+                    journeyPatternStop.isLoadingTimeAllowed(),
                     journeyPatternStop.isViaPoint(),
                     // Use the existing via name for both normal and short names
                     journeyPatternStop.viaPointNames().map(jsonbConverter::asJson).orElse(null),
diff --git a/src/main/java/fi/hsl/jore/importer/feature/network/route/dto/ImporterJourneyPatternStop.java b/src/main/java/fi/hsl/jore/importer/feature/network/route/dto/ImporterJourneyPatternStop.java
@@ -1,6 +1,7 @@
 package fi.hsl.jore.importer.feature.network.route.dto;
 
 import fi.hsl.jore.importer.feature.common.dto.field.MultilingualString;
+import fi.hsl.jore.importer.feature.jore3.enumerated.RegulatedTimingPointStatus;
 import org.immutables.value.Value;
 
 import java.util.Optional;
@@ -25,6 +26,8 @@ public interface ImporterJourneyPatternStop {
 
     Optional<String> timingPlaceId();
 
+    RegulatedTimingPointStatus regulatedTimingPointStatus();
+
     boolean isViaPoint();
 
     Optional<MultilingualString> viaPointNames();
@@ -35,6 +38,7 @@ static ImporterJourneyPatternStop of(final UUID journeyPatternJore4Id,
                                          final String scheduledStopPointJore4Label,
                                          final boolean isUsedAsTimingPoint,
                                          final Optional<String> timingPlaceId,
+                                         final RegulatedTimingPointStatus regulatedTimingPointStatus,
                                          final boolean isViaPoint,
                                          final Optional<MultilingualString> viaPointNames) {
         return ImmutableImporterJourneyPatternStop
@@ -45,6 +49,7 @@ static ImporterJourneyPatternStop of(final UUID journeyPatternJore4Id,
                 .scheduledStopPointJore4Label(scheduledStopPointJore4Label)
                 .isUsedAsTimingPoint(isUsedAsTimingPoint)
                 .timingPlaceId(timingPlaceId)
+                .regulatedTimingPointStatus(regulatedTimingPointStatus)
                 .isViaPoint(isViaPoint)
                 .viaPointNames(viaPointNames)
                 .build();
diff --git a/src/main/resources/jore4-export/export_stops_of_journey_patterns.sql b/src/main/resources/jore4-export/export_stops_of_journey_patterns.sql
@@ -4,6 +4,7 @@ SELECT rd.journey_pattern_jore4_id AS journey_pattern_jore4_id,
        ssp.scheduled_stop_point_short_id AS short_id,
        rsp.network_route_stop_point_hastus_point AS is_used_as_timing_point,
        ssp.hastus_place_id AS timing_place_id,
+       rsp.network_route_stop_point_regulated_timing_point_status AS regulated_timing_point_status,
        rsp.network_route_stop_point_via_point AS is_via_point,
        rsp.network_route_stop_point_via_name AS via_names
 FROM network.network_route_directions rd
diff --git a/src/test/java/fi/hsl/jore/importer/feature/batch/route/JourneyPatternStopExportProcessorTest.java b/src/test/java/fi/hsl/jore/importer/feature/batch/route/JourneyPatternStopExportProcessorTest.java
@@ -1,10 +1,12 @@
 package fi.hsl.jore.importer.feature.batch.route;
 
 import fi.hsl.jore.importer.feature.common.dto.field.MultilingualString;
+import fi.hsl.jore.importer.feature.jore3.enumerated.RegulatedTimingPointStatus;
 import fi.hsl.jore.importer.feature.jore3.util.JoreLocaleUtil;
 import fi.hsl.jore.importer.feature.jore4.entity.Jore4JourneyPatternStop;
 import fi.hsl.jore.importer.feature.network.route.dto.ImporterJourneyPatternStop;
 import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
 
 import java.util.Locale;
@@ -22,6 +24,7 @@ class JourneyPatternStopExportProcessorTest {
     private static final String SCHEDULED_STOP_POINT_LABEL = "stop1";
     private static final boolean IS_USED_AS_TIMING_POINT = true;
     private static final String TIMING_PLACE_ID = "1ELIEL";
+    private static final RegulatedTimingPointStatus REGULATED_TIMING_POINT_STATUS = RegulatedTimingPointStatus.YES_LOAD_TIME;
     private static final boolean IS_VIA_POINT = true;
     private static final Map<Locale, String> VIA_POINT_NAME_MAP = Map.of(
             JoreLocaleUtil.FINNISH, "ViaSuomi",
@@ -36,6 +39,7 @@ class JourneyPatternStopExportProcessorTest {
             SCHEDULED_STOP_POINT_LABEL,
             IS_USED_AS_TIMING_POINT,
             Optional.of(TIMING_PLACE_ID),
+            REGULATED_TIMING_POINT_STATUS,
             IS_VIA_POINT,
             VIA_POINT_NAMES
     );
@@ -70,6 +74,20 @@ void shouldReturnJourneyPatternStopWithCorrectIsUsedAsTimingPointInformation() t
         assertThat(output.isUsedAsTimingPoint()).isEqualTo(IS_USED_AS_TIMING_POINT);
     }
 
+    @Test
+    @DisplayName("Should return a journey pattern stop with the correct is-regulated-timing-point information")
+    void shouldReturnJourneyPatternStopWithCorrectIsRegulatedTimingPointInformation() throws Exception {
+        final Jore4JourneyPatternStop output = processor.process(DEFAULT_INPUT);
+        assertThat(output.isRegulatedTimingPoint()).isEqualTo(true);
+    }
+
+    @Test
+    @DisplayName("Should return a journey pattern stop with the correct is-loading-time-allowed information")
+    void shouldReturnJourneyPatternStopWithCorrectIsLoadingTimeAllowedInformation() throws Exception {
+        final Jore4JourneyPatternStop output = processor.process(DEFAULT_INPUT);
+        assertThat(output.isLoadingTimeAllowed()).isEqualTo(true);
+    }
+
     @Test
     @DisplayName("Should return a journey pattern stop with the correct is-via-point information")
     void shouldReturnJourneyPatternStopWithCorrectIsViaPointInformation() throws Exception {
@@ -88,21 +106,72 @@ void shouldReturnJourneyPatternStopWithCorrectViaPointNames() throws Exception {
         assertThat(swedishName).isEqualTo(VIA_POINT_NAME_MAP.get(JoreLocaleUtil.SWEDISH));
     }
 
-    @Test
-    @DisplayName("When used as timing point and timing place ID absent")
-    void whenUsedAsTimingPointAndTimingPlaceIdAbsent() throws Exception {
-        final ImporterJourneyPatternStop INPUT = ImporterJourneyPatternStop.of(
+    @Nested
+    @DisplayName("When timing place ID absent")
+    class WhenTimingPlaceIdAbsent {
+
+        private final ImporterJourneyPatternStop INPUT = ImporterJourneyPatternStop.of(
                 JOURNEY_PATTERN_JORE4_ID,
                 ROUTE_DIRECTION_JORE3_ID,
                 ORDER_NUMBER,
                 SCHEDULED_STOP_POINT_LABEL,
                 true, // isUsedAsTimingPoint
                 Optional.empty(), // timing place ID absent
+                RegulatedTimingPointStatus.YES_LOAD_TIME,
+                false,
+                Optional.empty()
+        );
+
+        @Test
+        @DisplayName("is-used-as-timing-point should not be set")
+        void isUsedAsTimingPointShouldNotBeSet() throws Exception {
+            final Jore4JourneyPatternStop output = processor.process(INPUT);
+            assertThat(output.isUsedAsTimingPoint()).isEqualTo(false);
+        }
+
+        @Test
+        @DisplayName("is-regulated-timing-point should not be set")
+        void isRegulatedTimingPointShouldNotBeSet() throws Exception {
+            final Jore4JourneyPatternStop output = processor.process(INPUT);
+            assertThat(output.isRegulatedTimingPoint()).isEqualTo(false);
+        }
+
+        @Test
+        @DisplayName("is-loading-time-allowed should not be set")
+        void isLoadingTimeAllowedShouldNotBeSet() throws Exception {
+            final Jore4JourneyPatternStop output = processor.process(INPUT);
+            assertThat(output.isLoadingTimeAllowed()).isEqualTo(false);
+        }
+    }
+
+    @Nested
+    @DisplayName("When not used as timing point")
+    class WhenNotUsedAsTimingPoint {
+
+        private final ImporterJourneyPatternStop INPUT = ImporterJourneyPatternStop.of(
+                JOURNEY_PATTERN_JORE4_ID,
+                ROUTE_DIRECTION_JORE3_ID,
+                ORDER_NUMBER,
+                SCHEDULED_STOP_POINT_LABEL,
+                false, // isUsedAsTimingPoint
+                Optional.of(TIMING_PLACE_ID), // timing place ID is present
+                RegulatedTimingPointStatus.YES_LOAD_TIME,
                 false,
                 Optional.empty()
         );
 
-        final Jore4JourneyPatternStop output = processor.process(INPUT);
-        assertThat(output.isUsedAsTimingPoint()).isEqualTo(false);
+        @Test
+        @DisplayName("is-regulated-timing-point should not be set")
+        void isRegulatedTimingPointShouldNotBeSet() throws Exception {
+            final Jore4JourneyPatternStop output = processor.process(INPUT);
+            assertThat(output.isRegulatedTimingPoint()).isEqualTo(false);
+        }
+
+        @Test
+        @DisplayName("is-loading-time-allowed should not be set")
+        void isLoadingTimeAllowedShouldNotBeSet() throws Exception {
+            final Jore4JourneyPatternStop output = processor.process(INPUT);
+            assertThat(output.isLoadingTimeAllowed()).isEqualTo(false);
+        }
     }
 }
diff --git a/src/test/java/fi/hsl/jore/importer/feature/batch/route/JourneyPatternStopExportReaderTest.java b/src/test/java/fi/hsl/jore/importer/feature/batch/route/JourneyPatternStopExportReaderTest.java
@@ -1,6 +1,7 @@
 package fi.hsl.jore.importer.feature.batch.route;
 
 import fi.hsl.jore.importer.IntTest;
+import fi.hsl.jore.importer.feature.jore3.enumerated.RegulatedTimingPointStatus;
 import fi.hsl.jore.importer.feature.jore3.util.JoreLocaleUtil;
 import fi.hsl.jore.importer.feature.network.route.dto.ImporterJourneyPatternStop;
 import org.assertj.core.api.SoftAssertions;
@@ -75,13 +76,15 @@ class WhenSourceTableHasOneRouteWithTwoStops {
         private static final int FIRST_JOURNEY_PATTERN_STOP_ORDER_NUMBER = 1;
         private static final boolean FIRST_JOURNEY_PATTERN_STOP_IS_USED_AS_TIMING_POINT = false;
         private static final String FIRST_JOURNEY_PATTERN_STOP_TIMING_PLACE_ID = "1ELIEL";
+        private final RegulatedTimingPointStatus FIRST_JOURNEY_PATTERN_STOP_REGULATED_TIMING_POINT_STATUS = RegulatedTimingPointStatus.NO;
         private static final boolean FIRST_JOURNEY_PATTERN_STOP_IS_VIA_POINT = false;
 
         private final String SECOND_JOURNEY_PATTERN_STOP_JORE4_LABEL = "H4321";
         private static final int SECOND_JOURNEY_PATTERN_STOP_ORDER_NUMBER = 2;
         private static final boolean SECOND_JOURNEY_PATTERN_STOP_IS_USED_AS_TIMING_POINT = true;
         private static final boolean SECOND_JOURNEY_PATTERN_STOP_IS_VIA_POINT = true;
         private static final String SECOND_JOURNEY_PATTERN_STOP_TIMING_PLACE_ID = "1KALA";
+        private final RegulatedTimingPointStatus SECOND_JOURNEY_PATTERN_STOP_REGULATED_TIMING_POINT_STATUS = RegulatedTimingPointStatus.YES_LOAD_TIME;
         private final String SECOND_JOURNEY_PATTERN_STOP_VIA_NAME_FINNISH = "ViaSuomi";
         private final String SECOND_JOURNEY_PATTERN_STOP_VIA_NAME_SWEDISH = "ViaSverige";
 
@@ -108,6 +111,9 @@ void firstInvocationOfReadMethodMustReturnInformationOfFirstStop(final SoftAsser
             softAssertions.assertThat(first.timingPlaceId())
                     .as("timingPlaceId")
                     .contains(FIRST_JOURNEY_PATTERN_STOP_TIMING_PLACE_ID);
+            softAssertions.assertThat(first.regulatedTimingPointStatus())
+                    .as("regulatedTimingPointStatus")
+                    .isEqualTo(FIRST_JOURNEY_PATTERN_STOP_REGULATED_TIMING_POINT_STATUS);
             softAssertions.assertThat(first.isViaPoint())
                     .as("isViaPoint")
                     .isEqualTo(FIRST_JOURNEY_PATTERN_STOP_IS_VIA_POINT);
@@ -142,6 +148,9 @@ void secondInvocationOfReadMethodMustReturnInformationOfSecondStop(SoftAssertion
             softAssertions.assertThat(second.timingPlaceId())
                     .as("timingPlaceId")
                     .contains(SECOND_JOURNEY_PATTERN_STOP_TIMING_PLACE_ID);
+            softAssertions.assertThat(second.regulatedTimingPointStatus())
+                    .as("regulatedTimingPointStatus")
+                    .isEqualTo(SECOND_JOURNEY_PATTERN_STOP_REGULATED_TIMING_POINT_STATUS);
             softAssertions.assertThat(second.isViaPoint())
                     .as("isViaPoint")
                     .isEqualTo(SECOND_JOURNEY_PATTERN_STOP_IS_VIA_POINT);
diff --git a/src/test/java/fi/hsl/jore/importer/feature/jore4/repository/Jore4JourneyPatternStopRepositoryTest.java b/src/test/java/fi/hsl/jore/importer/feature/jore4/repository/Jore4JourneyPatternStopRepositoryTest.java
diff --git a/src/test/resources/sql/importer/populate_route_stop_points_for_jore4_export.sql b/src/test/resources/sql/importer/populate_route_stop_points_for_jore4_export.sql
