If configured, add subway station entrances from OSM to walk steps

application/src/ext/java/org/opentripplanner/ext/restapi/mapping/RelativeDirectionMapper.java

@@ -25,6 +25,7 @@ public static ApiRelativeDirection mapRelativeDirection(RelativeDirection domain
       case UTURN_RIGHT -> ApiRelativeDirection.UTURN_RIGHT;
       case ENTER_STATION -> ApiRelativeDirection.ENTER_STATION;
       case EXIT_STATION -> ApiRelativeDirection.EXIT_STATION;
+      case ENTER_OR_EXIT_STATION -> ApiRelativeDirection.ENTER_OR_EXIT_STATION;
       case FOLLOW_SIGNS -> ApiRelativeDirection.FOLLOW_SIGNS;
     };
   }

application/src/ext/java/org/opentripplanner/ext/restapi/model/ApiRelativeDirection.java

@@ -21,5 +21,6 @@ public enum ApiRelativeDirection {
   UTURN_RIGHT,
   ENTER_STATION,
   EXIT_STATION,
+  ENTER_OR_EXIT_STATION,
   FOLLOW_SIGNS,
 }

application/src/main/java/org/opentripplanner/apis/gtfs/GtfsGraphQLIndex.java

@@ -37,6 +37,7 @@
 import org.opentripplanner.apis.gtfs.datafetchers.CurrencyImpl;
 import org.opentripplanner.apis.gtfs.datafetchers.DefaultFareProductImpl;
 import org.opentripplanner.apis.gtfs.datafetchers.DepartureRowImpl;
+import org.opentripplanner.apis.gtfs.datafetchers.EntranceImpl;
 import org.opentripplanner.apis.gtfs.datafetchers.FareProductTypeResolver;
 import org.opentripplanner.apis.gtfs.datafetchers.FareProductUseImpl;
 import org.opentripplanner.apis.gtfs.datafetchers.FeedImpl;
@@ -179,6 +180,7 @@ protected static GraphQLSchema buildSchema() {
         .type(typeWiring.build(FareProductUseImpl.class))
         .type(typeWiring.build(DefaultFareProductImpl.class))
         .type(typeWiring.build(TripOccupancyImpl.class))
+        .type(typeWiring.build(EntranceImpl.class))
         .build();
       SchemaGenerator schemaGenerator = new SchemaGenerator();
       return schemaGenerator.makeExecutableSchema(typeRegistry, runtimeWiring);

application/src/main/java/org/opentripplanner/apis/gtfs/datafetchers/EntranceImpl.java

@@ -0,0 +1,47 @@
+package org.opentripplanner.apis.gtfs.datafetchers;
+
+import graphql.schema.DataFetcher;
+import org.opentripplanner.apis.gtfs.GraphQLUtils;
+import org.opentripplanner.apis.gtfs.generated.GraphQLDataFetchers;
+import org.opentripplanner.apis.gtfs.generated.GraphQLTypes;
+import org.opentripplanner.transit.model.site.Entrance;
+
+public class EntranceImpl implements GraphQLDataFetchers.GraphQLEntrance {
+
+  @Override
+  public DataFetcher<String> code() {
+    return environment -> {
+      Entrance entrance = environment.getSource();
+      return entrance.getCode();
+    };
+  }
+
+  @Override
+  public DataFetcher<String> entranceId() {
+    return environment -> {
+      Entrance entrance = environment.getSource();
+      return entrance.getId() != null ? entrance.getId().toString() : null;
+    };
+  }
+
+  @Override
+  public DataFetcher<String> name() {
+    return environment -> {
+      Entrance entrance = environment.getSource();
+      return entrance.getName() != null
+        ? org.opentripplanner.framework.graphql.GraphQLUtils.getTranslation(
+          entrance.getName(),
+          environment
+        )
+        : null;
+    };
+  }
+
+  @Override
+  public DataFetcher<GraphQLTypes.GraphQLWheelchairBoarding> wheelchairAccessible() {
+    return environment -> {
+      Entrance entrance = environment.getSource();
+      return GraphQLUtils.toGraphQL(entrance.getWheelchairAccessibility());
+    };
+  }
+}

application/src/main/java/org/opentripplanner/apis/gtfs/datafetchers/stepImpl.java

@@ -53,6 +53,11 @@ public DataFetcher<String> exit() {
     return environment -> getSource(environment).getExit();
   }
 
+  @Override
+  public DataFetcher<Object> entrance() {
+    return environment -> getSource(environment).getEntrance();
+  }
+
   @Override
   public DataFetcher<Double> lat() {
     return environment -> getSource(environment).getStartLocation().latitude();

application/src/main/java/org/opentripplanner/apis/gtfs/generated/GraphQLDataFetchers.java

@@ -357,6 +357,17 @@ public interface GraphQLEmissions {
     public DataFetcher<org.opentripplanner.framework.model.Grams> co2();
   }
 
+  /** Station entrance or exit. */
+  public interface GraphQLEntrance {
+    public DataFetcher<String> code();
+
+    public DataFetcher<String> entranceId();
+
+    public DataFetcher<String> name();
+
+    public DataFetcher<org.opentripplanner.apis.gtfs.generated.GraphQLTypes.GraphQLWheelchairBoarding> wheelchairAccessible();
+  }
+
   /** A 'medium' that a fare product applies to, for example cash, 'Oyster Card' or 'DB Navigator App'. */
   public interface GraphQLFareMedium {
     public DataFetcher<String> id();
@@ -1424,6 +1435,8 @@ public interface GraphQLStep {
 
     public DataFetcher<Iterable<org.opentripplanner.model.plan.ElevationProfile.Step>> elevationProfile();
 
+    public DataFetcher<Object> entrance();
+
     public DataFetcher<String> exit();
 
     public DataFetcher<Double> lat();

application/src/main/java/org/opentripplanner/apis/gtfs/generated/GraphQLTypes.java

@@ -3994,6 +3994,7 @@ public enum GraphQLRelativeDirection {
     CONTINUE,
     DEPART,
     ELEVATOR,
+    ENTER_OR_EXIT_STATION,
     ENTER_STATION,
     EXIT_STATION,
     FOLLOW_SIGNS,

application/src/main/java/org/opentripplanner/apis/gtfs/mapping/DirectionMapper.java

@@ -38,6 +38,7 @@ public static GraphQLRelativeDirection map(RelativeDirection relativeDirection)
       case UTURN_RIGHT -> GraphQLRelativeDirection.UTURN_RIGHT;
       case ENTER_STATION -> GraphQLRelativeDirection.ENTER_STATION;
       case EXIT_STATION -> GraphQLRelativeDirection.EXIT_STATION;
+      case ENTER_OR_EXIT_STATION -> GraphQLRelativeDirection.ENTER_OR_EXIT_STATION;
       case FOLLOW_SIGNS -> GraphQLRelativeDirection.FOLLOW_SIGNS;
     };
   }

application/src/main/java/org/opentripplanner/graph_builder/module/configure/GraphBuilderModules.java

@@ -69,6 +69,7 @@ static OsmModule provideOsmModule(
           osmConfiguredDataSource.dataSource(),
           osmConfiguredDataSource.config().osmTagMapper(),
           osmConfiguredDataSource.config().timeZone(),
+          osmConfiguredDataSource.config().includeOsmSubwayEntrances(),
           config.osmCacheDataInMem,
           issueStore
         )
@@ -84,6 +85,7 @@ static OsmModule provideOsmModule(
       .withStaticBikeParkAndRide(config.staticBikeParkAndRide)
       .withMaxAreaNodes(config.maxAreaNodes)
       .withBoardingAreaRefTags(config.boardingLocationTags)
+      .withIncludeOsmSubwayEntrances(config.osmDefaults.includeOsmSubwayEntrances())
       .withIssueStore(issueStore)
       .withStreetLimitationParameters(streetLimitationParameters)
       .build();

application/src/main/java/org/opentripplanner/graph_builder/module/osm/OsmModule.java

@@ -70,7 +70,13 @@ public class OsmModule implements GraphBuilderModule {
     this.issueStore = issueStore;
     this.params = params;
     this.osmdb = new OsmDatabase(issueStore);
-    this.vertexGenerator = new VertexGenerator(osmdb, graph, params.boardingAreaRefTags());
+    this.vertexGenerator =
+      new VertexGenerator(
+        osmdb,
+        graph,
+        params.boardingAreaRefTags(),
+        params.includeOsmSubwayEntrances()
+      );
     this.normalizer = new SafetyValueNormalizer(graph, issueStore);
     this.streetLimitationParameters = Objects.requireNonNull(streetLimitationParameters);
   }

application/src/main/java/org/opentripplanner/graph_builder/module/osm/OsmModuleBuilder.java

@@ -24,6 +24,7 @@ public class OsmModuleBuilder {
   private boolean platformEntriesLinking = false;
   private boolean staticParkAndRide = false;
   private boolean staticBikeParkAndRide = false;
+  private boolean includeOsmSubwayEntrances = false;
   private int maxAreaNodes;
   private StreetLimitationParameters streetLimitationParameters = new StreetLimitationParameters();
 
@@ -72,6 +73,11 @@ public OsmModuleBuilder withMaxAreaNodes(int maxAreaNodes) {
     return this;
   }
 
+  public OsmModuleBuilder withIncludeOsmSubwayEntrances(boolean includeOsmSubwayEntrances) {
+    this.includeOsmSubwayEntrances = includeOsmSubwayEntrances;
+    return this;
+  }
+
   public OsmModuleBuilder withStreetLimitationParameters(StreetLimitationParameters parameters) {
     this.streetLimitationParameters = parameters;
     return this;
@@ -90,7 +96,8 @@ public OsmModule build() {
         areaVisibility,
         platformEntriesLinking,
         staticParkAndRide,
-        staticBikeParkAndRide
+        staticBikeParkAndRide,
+        includeOsmSubwayEntrances
       )
     );
   }

application/src/main/java/org/opentripplanner/graph_builder/module/osm/VertexGenerator.java

@@ -33,12 +33,19 @@ class VertexGenerator {
   private final HashMap<Long, Map<OsmLevel, OsmVertex>> multiLevelNodes = new HashMap<>();
   private final OsmDatabase osmdb;
   private final Set<String> boardingAreaRefTags;
+  private final Boolean includeOsmSubwayEntrances;
   private final VertexFactory vertexFactory;
 
-  public VertexGenerator(OsmDatabase osmdb, Graph graph, Set<String> boardingAreaRefTags) {
+  public VertexGenerator(
+    OsmDatabase osmdb,
+    Graph graph,
+    Set<String> boardingAreaRefTags,
+    boolean includeOsmSubwayEntrances
+  ) {
     this.osmdb = osmdb;
     this.vertexFactory = new VertexFactory(graph);
     this.boardingAreaRefTags = boardingAreaRefTags;
+    this.includeOsmSubwayEntrances = includeOsmSubwayEntrances;
   }
 
   /**
@@ -95,6 +102,13 @@ IntersectionVertex getVertexForOsmNode(OsmNode node, OsmWithTags way) {
         iv = bv;
       }
 
+      if (includeOsmSubwayEntrances && node.isSubwayEntrance()) {
+        String ref = node.getTag("ref");
+
+        boolean accessible = node.isTag("wheelchair", "yes");
+        iv = vertexFactory.stationEntrance(nid, coordinate, ref, accessible);
+      }
+
       if (iv == null) {
         iv =
           vertexFactory.osm(

application/src/main/java/org/opentripplanner/graph_builder/module/osm/parameters/OsmExtractParameters.java

@@ -11,16 +11,28 @@
  * Example: {@code "osm" : [ {source: "file:///path/to/otp/norway.pbf"} ] }
  *
  */
-public record OsmExtractParameters(URI source, OsmTagMapperSource osmTagMapper, ZoneId timeZone)
+public record OsmExtractParameters(
+  URI source,
+  OsmTagMapperSource osmTagMapper,
+  ZoneId timeZone,
+  boolean includeOsmSubwayEntrances
+)
   implements DataSourceConfig {
   public static final OsmTagMapperSource DEFAULT_OSM_TAG_MAPPER = OsmTagMapperSource.DEFAULT;
 
   public static final ZoneId DEFAULT_TIME_ZONE = null;
 
+  public static final boolean DEFAULT_INCLUDE_OSM_SUBWAY_ENTRANCES = false;
+
   public static final OsmExtractParameters DEFAULT = new OsmExtractParametersBuilder().build();
 
   OsmExtractParameters(OsmExtractParametersBuilder builder) {
-    this(builder.getSource(), builder.getOsmTagMapper(), builder.getTimeZone());
+    this(
+      builder.getSource(),
+      builder.getOsmTagMapper(),
+      builder.getTimeZone(),
+      builder.includeOsmSubwayEntrances()
+    );
   }
 
   @Override
@@ -37,6 +49,11 @@ public ZoneId timeZone() {
     return timeZone;
   }
 
+  @Nullable
+  public boolean includeOsmSubwayEntrances() {
+    return includeOsmSubwayEntrances;
+  }
+
   public OsmExtractParametersBuilder copyOf() {
     return new OsmExtractParametersBuilder(this);
   }

application/src/main/java/org/opentripplanner/graph_builder/module/osm/parameters/OsmExtractParametersBuilder.java

@@ -24,14 +24,18 @@ public class OsmExtractParametersBuilder {
    */
   private ZoneId timeZone;
 
+  private boolean includeOsmSubwayEntrances;
+
   public OsmExtractParametersBuilder() {
     this.osmTagMapper = OsmExtractParameters.DEFAULT_OSM_TAG_MAPPER;
     this.timeZone = OsmExtractParameters.DEFAULT_TIME_ZONE;
+    this.includeOsmSubwayEntrances = OsmExtractParameters.DEFAULT_INCLUDE_OSM_SUBWAY_ENTRANCES;
   }
 
   public OsmExtractParametersBuilder(OsmExtractParameters original) {
     this.osmTagMapper = original.osmTagMapper();
     this.timeZone = original.timeZone();
+    this.includeOsmSubwayEntrances = original.includeOsmSubwayEntrances();
   }
 
   public OsmExtractParametersBuilder withSource(URI source) {
@@ -49,6 +53,13 @@ public OsmExtractParametersBuilder withTimeZone(ZoneId timeZone) {
     return this;
   }
 
+  public OsmExtractParametersBuilder withIncludeOsmSubwayEntrances(
+    boolean includeOsmSubwayEntrances
+  ) {
+    this.includeOsmSubwayEntrances = includeOsmSubwayEntrances;
+    return this;
+  }
+
   public URI getSource() {
     return source;
   }
@@ -61,6 +72,10 @@ public ZoneId getTimeZone() {
     return timeZone;
   }
 
+  public boolean includeOsmSubwayEntrances() {
+    return includeOsmSubwayEntrances;
+  }
+
   public OsmExtractParameters build() {
     return new OsmExtractParameters(this);
   }

application/src/main/java/org/opentripplanner/graph_builder/module/osm/parameters/OsmProcessingParameters.java

@@ -13,6 +13,7 @@
  * @param platformEntriesLinking Whether platform entries should be linked
  * @param staticParkAndRide      Whether we should create car P+R stations from OSM data.
  * @param staticBikeParkAndRide  Whether we should create bike P+R stations from OSM data.
+ * @param includeOsmSubwayEntrances Whether we should create subway entrances from OSM data.
  */
 public record OsmProcessingParameters(
   Set<String> boardingAreaRefTags,
@@ -21,7 +22,8 @@ public record OsmProcessingParameters(
   boolean areaVisibility,
   boolean platformEntriesLinking,
   boolean staticParkAndRide,
-  boolean staticBikeParkAndRide
+  boolean staticBikeParkAndRide,
+  boolean includeOsmSubwayEntrances
 ) {
   public OsmProcessingParameters {
     boardingAreaRefTags = Set.copyOf(Objects.requireNonNull(boardingAreaRefTags));

application/src/main/java/org/opentripplanner/model/plan/RelativeDirection.java

@@ -21,6 +21,7 @@ public enum RelativeDirection {
   UTURN_RIGHT,
   ENTER_STATION,
   EXIT_STATION,
+  ENTER_OR_EXIT_STATION,
   FOLLOW_SIGNS;
 
   public static RelativeDirection calculate(

application/src/main/java/org/opentripplanner/model/plan/WalkStep.java

@@ -8,6 +8,7 @@
 import org.opentripplanner.framework.i18n.I18NString;
 import org.opentripplanner.street.model.edge.Edge;
 import org.opentripplanner.street.model.note.StreetNote;
+import org.opentripplanner.transit.model.site.Entrance;
 import org.opentripplanner.utils.lang.DoubleUtils;
 import org.opentripplanner.utils.tostring.ToStringBuilder;
 
@@ -44,6 +45,7 @@ public final class WalkStep {
   private final boolean walkingBike;
 
   private final String exit;
+  private final Entrance entrance;
   private final ElevationProfile elevationProfile;
   private final boolean stayOn;
 
@@ -56,6 +58,7 @@ public final class WalkStep {
     I18NString directionText,
     Set<StreetNote> streetNotes,
     String exit,
+    Entrance entrance,
     ElevationProfile elevationProfile,
     boolean bogusName,
     boolean walkingBike,
@@ -76,6 +79,7 @@ public final class WalkStep {
     this.walkingBike = walkingBike;
     this.area = area;
     this.exit = exit;
+    this.entrance = entrance;
     this.elevationProfile = elevationProfile;
     this.stayOn = stayOn;
     this.edges = List.copyOf(Objects.requireNonNull(edges));
@@ -130,6 +134,13 @@ public String getExit() {
     return exit;
   }
 
+  /**
+   * Get information about building entrance or exit.
+   */
+  public Entrance getEntrance() {
+    return entrance;
+  }
+
   /**
    * Indicates whether a street changes direction at an intersection.
    */