Merge pull request #6640 from entur/ferry_suport

Enable CAR transfers with ferries with NeTEx import

Author: t2gran

application/src/main/java/org/opentripplanner/netex/mapping/TransportModeMapper.java

@@ -1,7 +1,16 @@
 package org.opentripplanner.netex.mapping;
 
+import static org.rutebanken.netex.model.WaterSubmodeEnumeration.HIGH_SPEED_VEHICLE_SERVICE;
+import static org.rutebanken.netex.model.WaterSubmodeEnumeration.LOCAL_CAR_FERRY;
+import static org.rutebanken.netex.model.WaterSubmodeEnumeration.NATIONAL_CAR_FERRY;
+import static org.rutebanken.netex.model.WaterSubmodeEnumeration.REGIONAL_CAR_FERRY;
+
+import java.util.Set;
+import javax.annotation.Nullable;
 import org.opentripplanner.netex.mapping.support.NetexMainAndSubMode;
+import org.opentripplanner.transit.model.basic.SubMode;
 import org.opentripplanner.transit.model.basic.TransitMode;
+import org.opentripplanner.transit.model.network.CarAccess;
 import org.rutebanken.netex.model.AllVehicleModesOfTransportEnumeration;
 import org.rutebanken.netex.model.TransportSubmodeStructure;
 
@@ -13,6 +22,13 @@
  */
 class TransportModeMapper {
 
+  private static final Set<String> CARS_ALLOWED_WATER_SUBMODES = Set.of(
+    NATIONAL_CAR_FERRY.value(),
+    REGIONAL_CAR_FERRY.value(),
+    LOCAL_CAR_FERRY.value(),
+    HIGH_SPEED_VEHICLE_SERVICE.value()
+  );
+
   public NetexMainAndSubMode map(
     AllVehicleModesOfTransportEnumeration netexMode,
     TransportSubmodeStructure submode
@@ -44,6 +60,26 @@ public TransitMode mapAllVehicleModesOfTransport(AllVehicleModesOfTransportEnume
     };
   }
 
+  /**
+   * Use submode to determine if a trip/ServiceJourney is allowed for car or not. There are
+   * probably other ways to specify this in NeTEx. The list of included submodes
+   * {@link #CARS_ALLOWED_WATER_SUBMODES} are not complete, feel free to request
+   * changes.
+   */
+  public CarAccess mapCarsAllowed(@Nullable TransportSubmodeStructure submode) {
+    if (submode == null || submode.getWaterSubmode() == null) {
+      return CarAccess.NOT_ALLOWED;
+    }
+    return mapCarsAllowed(submode.getWaterSubmode().value());
+  }
+
+  /**
+   * @see #carsAllowed(TransportSubmodeStructure)
+   */
+  public CarAccess mapCarsAllowed(@Nullable SubMode otpSubmode) {
+    return mapCarsAllowed(otpSubmode == null ? null : otpSubmode.name());
+  }
+
   private NetexMainAndSubMode getSubmodeAsString(TransportSubmodeStructure submode) {
     if (submode.getAirSubmode() != null) {
       return new NetexMainAndSubMode(TransitMode.AIRPLANE, submode.getAirSubmode().value());
@@ -77,4 +113,10 @@ public UnsupportedModeException(AllVehicleModesOfTransportEnumeration mode) {
       this.mode = mode;
     }
   }
+
+  private CarAccess mapCarsAllowed(@Nullable String submode) {
+    return submode != null && CARS_ALLOWED_WATER_SUBMODES.contains(submode)
+      ? CarAccess.ALLOWED
+      : CarAccess.NOT_ALLOWED;
+  }
 }

application/src/main/java/org/opentripplanner/netex/mapping/TripMapper.java

@@ -14,6 +14,7 @@
 import org.opentripplanner.transit.model.framework.DefaultEntityById;
 import org.opentripplanner.transit.model.framework.EntityById;
 import org.opentripplanner.transit.model.framework.FeedScopedId;
+import org.opentripplanner.transit.model.network.CarAccess;
 import org.opentripplanner.transit.model.organization.Operator;
 import org.opentripplanner.transit.model.timetable.Trip;
 import org.rutebanken.netex.model.DirectionTypeEnumeration;
@@ -130,6 +131,11 @@ Trip mapServiceJourney(ServiceJourney serviceJourney, Supplier<String> headsign)
       }
       builder.withMode(transitMode.mainMode());
       builder.withNetexSubmode(transitMode.subMode());
+      builder.withCarsAllowed(
+        transportModeMapper.mapCarsAllowed(serviceJourney.getTransportSubmode())
+      );
+    } else {
+      builder.withCarsAllowed(transportModeMapper.mapCarsAllowed(route.getNetexSubmode()));
     }
 
     builder.withDirection(DirectionMapper.map(resolveDirectionType(serviceJourney)));

application/src/test/java/org/opentripplanner/netex/mapping/TransportModeMapperTest.java

@@ -5,6 +5,13 @@
 import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.fail;
+import static org.opentripplanner.transit.model.network.CarAccess.ALLOWED;
+import static org.opentripplanner.transit.model.network.CarAccess.NOT_ALLOWED;
+import static org.rutebanken.netex.model.WaterSubmodeEnumeration.HIGH_SPEED_VEHICLE_SERVICE;
+import static org.rutebanken.netex.model.WaterSubmodeEnumeration.LOCAL_CAR_FERRY;
+import static org.rutebanken.netex.model.WaterSubmodeEnumeration.NATIONAL_CAR_FERRY;
+import static org.rutebanken.netex.model.WaterSubmodeEnumeration.POST_BOAT;
+import static org.rutebanken.netex.model.WaterSubmodeEnumeration.REGIONAL_CAR_FERRY;
 
 import java.util.EnumSet;
 import java.util.List;
@@ -14,6 +21,7 @@
 import org.junit.jupiter.params.provider.Arguments;
 import org.junit.jupiter.params.provider.MethodSource;
 import org.opentripplanner.netex.mapping.TransportModeMapper.UnsupportedModeException;
+import org.opentripplanner.transit.model.basic.SubMode;
 import org.opentripplanner.transit.model.basic.TransitMode;
 import org.rutebanken.netex.model.AirSubmodeEnumeration;
 import org.rutebanken.netex.model.AllVehicleModesOfTransportEnumeration;
@@ -126,10 +134,38 @@ void unsupportedMode() {
     assertThrows(UnsupportedModeException.class, () -> transportModeMapper.map(null, null));
   }
 
+  @Test
+  void carsAllowedBasedOnSubMode() {
+    assertEquals(ALLOWED, transportModeMapper.mapCarsAllowed(SubMode.of("nationalCarFerry")));
+    assertEquals(ALLOWED, transportModeMapper.mapCarsAllowed(SubMode.of("regionalCarFerry")));
+    assertEquals(ALLOWED, transportModeMapper.mapCarsAllowed(SubMode.of("localCarFerry")));
+    assertEquals(
+      ALLOWED,
+      transportModeMapper.mapCarsAllowed(SubMode.of("highSpeedVehicleService"))
+    );
+    assertEquals(NOT_ALLOWED, transportModeMapper.mapCarsAllowed(SubMode.UNKNOWN));
+    assertEquals(NOT_ALLOWED, transportModeMapper.mapCarsAllowed((SubMode) null));
+  }
+
+  @Test
+  void carsAllowedBasedOn() {
+    assertEquals(ALLOWED, transportModeMapper.mapCarsAllowed(tsm(NATIONAL_CAR_FERRY)));
+    assertEquals(ALLOWED, transportModeMapper.mapCarsAllowed(tsm(REGIONAL_CAR_FERRY)));
+    assertEquals(ALLOWED, transportModeMapper.mapCarsAllowed(tsm(LOCAL_CAR_FERRY)));
+    assertEquals(ALLOWED, transportModeMapper.mapCarsAllowed(tsm(HIGH_SPEED_VEHICLE_SERVICE)));
+    assertEquals(NOT_ALLOWED, transportModeMapper.mapCarsAllowed(tsm(POST_BOAT)));
+    assertEquals(NOT_ALLOWED, transportModeMapper.mapCarsAllowed(tsm(null)));
+    assertEquals(NOT_ALLOWED, transportModeMapper.mapCarsAllowed((TransportSubmodeStructure) null));
+  }
+
   private static List<Arguments> createSubModeTestCases() {
     return VALID_SUBMODE_STRUCTURES.entrySet()
       .stream()
       .map(entry -> Arguments.of(entry.getKey(), entry.getValue()))
       .toList();
   }
+
+  private static TransportSubmodeStructure tsm(WaterSubmodeEnumeration waterSubMode) {
+    return new TransportSubmodeStructure().withWaterSubmode(waterSubMode);
+  }
 }