Add option to include stations in nearest search

src/ext/java/org/opentripplanner/ext/transmodelapi/TransmodelGraphQLSchema.java

@@ -900,6 +900,7 @@ private GraphQLSchema create() {
           .argument(relay.getConnectionFieldArguments())
           .dataFetcher(environment -> {
             List<FeedScopedId> filterByStops = null;
+            List<FeedScopedId> filterByStations = null;
             List<FeedScopedId> filterByRoutes = null;
             List<String> filterByBikeRentalStations = null;
             List<String> filterByBikeParks = null;
@@ -949,6 +950,7 @@ private GraphQLSchema create() {
                   filterByTransportModes,
                   filterByPlaceTypes,
                   filterByStops,
+                  filterByStations,
                   filterByRoutes,
                   filterByBikeRentalStations,
                   GqlUtil.getTransitService(environment)

src/main/java/org/opentripplanner/apis/gtfs/GraphQLUtils.java

@@ -91,6 +91,7 @@ public static PlaceType toModel(GraphQLFilterPlaceType type) {
       case CAR_PARK -> PlaceType.CAR_PARK;
       case DEPARTURE_ROW -> PlaceType.PATTERN_AT_STOP;
       case STOP -> PlaceType.STOP;
+      case STATION -> PlaceType.STATION;
     };
   }
 

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/PlaceInterfaceTypeResolver.java

@@ -9,6 +9,7 @@
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalStation;
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalVehicle;
 import org.opentripplanner.transit.model.site.RegularStop;
+import org.opentripplanner.transit.model.site.Station;
 
 public class PlaceInterfaceTypeResolver implements TypeResolver {
 
@@ -45,7 +46,7 @@ public GraphQLObjectType getType(TypeResolutionEnvironment environment) {
     if (o instanceof PatternAtStop) {
       return schema.getObjectType("DepartureRow");
     }
-    if (o instanceof RegularStop) {
+    if (o instanceof RegularStop || o instanceof Station) {
       return schema.getObjectType("Stop");
     }
 

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/QueryTypeImpl.java

@@ -17,9 +17,11 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Comparator;
+import java.util.EnumSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Set;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 import org.locationtech.jts.geom.Coordinate;
@@ -75,6 +77,10 @@ public class QueryTypeImpl implements GraphQLDataFetchers.GraphQLQueryType {
     DataImportIssueStore.NOOP
   );
 
+  private final List<PlaceType> DEFAULT_PLACE_TYPES = List.copyOf(
+    EnumSet.complementOf(EnumSet.of(PlaceType.STATION))
+  );
+
   @Override
   public DataFetcher<Iterable<Agency>> agencies() {
     return environment -> getTransitService(environment).getAgencies();
@@ -276,6 +282,7 @@ public DataFetcher<Trip> fuzzyTrip() {
   public DataFetcher<Connection<PlaceAtDistance>> nearest() {
     return environment -> {
       List<FeedScopedId> filterByStops = null;
+      List<FeedScopedId> filterByStations = null;
       List<FeedScopedId> filterByRoutes = null;
       List<String> filterByBikeRentalStations = null;
       // TODO implement
@@ -293,6 +300,10 @@ public DataFetcher<Connection<PlaceAtDistance>> nearest() {
           filterByIds.getGraphQLStops() != null
             ? filterByIds.getGraphQLStops().stream().map(FeedScopedId::parse).toList()
             : null;
+        filterByStations =
+          filterByIds.getGraphQLStations() != null
+            ? filterByIds.getGraphQLStations().stream().map(FeedScopedId::parse).toList()
+            : null;
         filterByRoutes =
           filterByIds.getGraphQLRoutes() != null
             ? filterByIds.getGraphQLRoutes().stream().map(FeedScopedId::parse).toList()
@@ -318,7 +329,7 @@ public DataFetcher<Connection<PlaceAtDistance>> nearest() {
         : null;
       List<PlaceType> filterByPlaceTypes = args.getGraphQLFilterByPlaceTypes() != null
         ? args.getGraphQLFilterByPlaceTypes().stream().map(GraphQLUtils::toModel).toList()
-        : null;
+        : DEFAULT_PLACE_TYPES;
 
       List<PlaceAtDistance> places;
       try {
@@ -333,6 +344,7 @@ public DataFetcher<Connection<PlaceAtDistance>> nearest() {
                 filterByModes,
                 filterByPlaceTypes,
                 filterByStops,
+                filterByStations,
                 filterByRoutes,
                 filterByBikeRentalStations,
                 getTransitService(environment)

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

@@ -237,6 +237,7 @@ public enum GraphQLFilterPlaceType {
     BIKE_PARK,
     CAR_PARK,
     DEPARTURE_ROW,
+    STATION,
     STOP,
     VEHICLE_RENT,
   }
@@ -372,6 +373,7 @@ public static class GraphQLInputFiltersInput {
     private List<String> bikeRentalStations;
     private List<String> carParks;
     private List<String> routes;
+    private List<String> stations;
     private List<String> stops;
 
     public GraphQLInputFiltersInput(Map<String, Object> args) {
@@ -380,6 +382,7 @@ public GraphQLInputFiltersInput(Map<String, Object> args) {
         this.bikeRentalStations = (List<String>) args.get("bikeRentalStations");
         this.carParks = (List<String>) args.get("carParks");
         this.routes = (List<String>) args.get("routes");
+        this.stations = (List<String>) args.get("stations");
         this.stops = (List<String>) args.get("stops");
       }
     }
@@ -400,6 +403,10 @@ public List<String> getGraphQLRoutes() {
       return this.routes;
     }
 
+    public List<String> getGraphQLStations() {
+      return this.stations;
+    }
+
     public List<String> getGraphQLStops() {
       return this.stops;
     }
@@ -420,6 +427,10 @@ public void setGraphQLRoutes(List<String> routes) {
       this.routes = routes;
     }
 
+    public void setGraphQLStations(List<String> stations) {
+      this.stations = stations;
+    }
+
     public void setGraphQLStops(List<String> stops) {
       this.stops = stops;
     }

src/main/java/org/opentripplanner/routing/graphfinder/DirectGraphFinder.java

@@ -60,6 +60,7 @@ public List<PlaceAtDistance> findClosestPlaces(
     List<TransitMode> filterByModes,
     List<PlaceType> filterByPlaceTypes,
     List<FeedScopedId> filterByStops,
+    List<FeedScopedId> filterByStations,
     List<FeedScopedId> filterByRoutes,
     List<String> filterByBikeRentalStations,
     TransitService transitService

src/main/java/org/opentripplanner/routing/graphfinder/GraphFinder.java

@@ -66,6 +66,7 @@ List<PlaceAtDistance> findClosestPlaces(
     List<TransitMode> filterByModes,
     List<PlaceType> filterByPlaceTypes,
     List<FeedScopedId> filterByStops,
+    List<FeedScopedId> filterByStations,
     List<FeedScopedId> filterByRoutes,
     List<String> filterByBikeRentalStations,
     TransitService transitService

src/main/java/org/opentripplanner/routing/graphfinder/PlaceFinderTraverseVisitor.java

@@ -29,6 +29,7 @@ public class PlaceFinderTraverseVisitor implements TraverseVisitor<State, Edge>
   private final TransitService transitService;
   private final Set<TransitMode> filterByModes;
   private final Set<FeedScopedId> filterByStops;
+  private final Set<FeedScopedId> filterByStations;
   private final Set<FeedScopedId> filterByRoutes;
   private final Set<String> filterByVehicleRental;
   private final Set<String> seenPatternAtStops = new HashSet<>();
@@ -40,6 +41,7 @@ public class PlaceFinderTraverseVisitor implements TraverseVisitor<State, Edge>
   private final boolean includeVehicleRentals;
   private final boolean includeCarParking;
   private final boolean includeBikeParking;
+  private final boolean includeStations;
   private final int maxResults;
   private final double radiusMeters;
 
@@ -64,23 +66,31 @@ public PlaceFinderTraverseVisitor(
     List<TransitMode> filterByModes,
     List<PlaceType> filterByPlaceTypes,
     List<FeedScopedId> filterByStops,
+    List<FeedScopedId> filterByStations,
     List<FeedScopedId> filterByRoutes,
     List<String> filterByBikeRentalStations,
     int maxResults,
     double radiusMeters
   ) {
+    if (filterByPlaceTypes == null || filterByPlaceTypes.isEmpty()) {
+      throw new IllegalArgumentException("No place type filter was included in request");
+    }
     this.transitService = transitService;
+
     this.filterByModes = toSet(filterByModes);
     this.filterByStops = toSet(filterByStops);
+    this.filterByStations = toSet(filterByStations);
     this.filterByRoutes = toSet(filterByRoutes);
     this.filterByVehicleRental = toSet(filterByBikeRentalStations);
-
     includeStops = shouldInclude(filterByPlaceTypes, PlaceType.STOP);
+
     includePatternAtStops = shouldInclude(filterByPlaceTypes, PlaceType.PATTERN_AT_STOP);
     includeVehicleRentals = shouldInclude(filterByPlaceTypes, PlaceType.VEHICLE_RENT);
     includeCarParking = shouldInclude(filterByPlaceTypes, PlaceType.CAR_PARK);
     includeBikeParking = shouldInclude(filterByPlaceTypes, PlaceType.BIKE_PARK);
+    includeStations = shouldInclude(filterByPlaceTypes, PlaceType.STATION);
     this.maxResults = maxResults;
+
     this.radiusMeters = radiusMeters;
   }
 
@@ -134,7 +144,7 @@ public SkipEdgeStrategy<State, Edge> getSkipEdgeStrategy() {
 
   private static <T> Set<T> toSet(List<T> list) {
     if (list == null) {
-      return null;
+      return Set.of();
     }
     return Set.copyOf(list);
   }
@@ -156,7 +166,7 @@ private void handleParking(VehicleParking parking, double distance) {
   }
 
   private boolean shouldInclude(List<PlaceType> filterByPlaceTypes, PlaceType type) {
-    return filterByPlaceTypes == null || filterByPlaceTypes.contains(type);
+    return filterByPlaceTypes.contains(type);
   }
 
   private boolean stopHasPatternsWithMode(RegularStop stop, Set<TransitMode> modes) {
@@ -167,17 +177,54 @@ private boolean stopHasPatternsWithMode(RegularStop stop, Set<TransitMode> modes
       .anyMatch(modes::contains);
   }
 
+  private boolean stopIsIncludedByStopFilter(RegularStop stop) {
+    return filterByStops.isEmpty() || filterByStops.contains(stop.getId());
+  }
+
+  private boolean stopIsIncludedByStationFilter(RegularStop stop) {
+    return (
+      ((filterByStations.isEmpty() || filterByStations.contains(stop.getParentStation().getId())))
+    );
+  }
+
+  private boolean stopIsIncludedByModeFilter(RegularStop stop) {
+    return filterByModes.isEmpty() || stopHasPatternsWithMode(stop, filterByModes);
+  }
+
+  /* Checks whether the stop is included in the stop filter and whether the stop should be considered
+   * a stop or a station in the search.*/
+  private boolean stopShouldNotBeIncludedAsStop(RegularStop stop) {
+    return (
+      (includeStations && !stop.isPartOfStation() && !stopIsIncludedByStopFilter(stop)) ||
+      (!includeStations && !stopIsIncludedByStopFilter(stop))
+    );
+  }
+
+  /* Checks if the stop is a part of a station and whether that station is
+   * included in the station filter */
+  private boolean stopShouldNotBeIncludedAsStation(RegularStop stop) {
+    return stop.isPartOfStation() && !stopIsIncludedByStationFilter(stop);
+  }
+
   private void handleStop(RegularStop stop, double distance) {
-    if (filterByStops != null && !filterByStops.contains(stop.getId())) {
-      return;
-    }
+    // Do not consider stop if it is not included in the stop or mode filter
+    // or if it or its parent station has already been seen.
     if (
-      includeStops &&
-      !seenStops.contains(stop.getId()) &&
-      (filterByModes == null || stopHasPatternsWithMode(stop, filterByModes))
+      stopShouldNotBeIncludedAsStop(stop) ||
+      stopShouldNotBeIncludedAsStation(stop) ||
+      seenStops.contains(stop.getId()) ||
+      seenStops.contains(stop.getStationOrStopId()) ||
+      !stopIsIncludedByModeFilter(stop)
     ) {
-      placesFound.add(new PlaceAtDistance(stop, distance));
+      return;
+    }
+
+    if (includeStations && stop.getParentStation() != null) {
+      seenStops.add(stop.getParentStation().getId());
+      placesFound.add(new PlaceAtDistance(stop.getParentStation(), distance));
+    } else if (includeStops) {
       seenStops.add(stop.getId());
+      placesFound.add(new PlaceAtDistance(stop, distance));
     }
   }
 
@@ -186,9 +233,9 @@ private void handlePatternsAtStop(RegularStop stop, double distance) {
       List<TripPattern> patterns = transitService
         .getPatternsForStop(stop)
         .stream()
-        .filter(pattern -> filterByModes == null || filterByModes.contains(pattern.getMode()))
+        .filter(pattern -> filterByModes.isEmpty() || filterByModes.contains(pattern.getMode()))
         .filter(pattern ->
-          filterByRoutes == null || filterByRoutes.contains(pattern.getRoute().getId())
+          filterByRoutes.isEmpty() || filterByRoutes.contains(pattern.getRoute().getId())
         )
         .filter(pattern -> pattern.canBoard(stop))
         .toList();
@@ -209,7 +256,9 @@ private void handleVehicleRental(VehicleRentalPlace station, double distance) {
     if (!includeVehicleRentals) {
       return;
     }
-    if (filterByVehicleRental != null && !filterByVehicleRental.contains(station.getStationId())) {
+    if (
+      !filterByVehicleRental.isEmpty() && !filterByVehicleRental.contains(station.getStationId())
+    ) {
       return;
     }
     if (seenVehicleRentalPlaces.contains(station.getId())) {

src/main/java/org/opentripplanner/routing/graphfinder/PlaceType.java

@@ -9,4 +9,5 @@ public enum PlaceType {
   VEHICLE_RENT,
   BIKE_PARK,
   CAR_PARK,
+  STATION,
 }

src/main/java/org/opentripplanner/routing/graphfinder/StreetGraphFinder.java

@@ -53,6 +53,7 @@ public List<PlaceAtDistance> findClosestPlaces(
     List<TransitMode> filterByModes,
     List<PlaceType> filterByPlaceTypes,
     List<FeedScopedId> filterByStops,
+    List<FeedScopedId> filterByStations,
     List<FeedScopedId> filterByRoutes,
     List<String> filterByBikeRentalStations,
     TransitService transitService
@@ -62,6 +63,7 @@ public List<PlaceAtDistance> findClosestPlaces(
       filterByModes,
       filterByPlaceTypes,
       filterByStops,
+      filterByStations,
       filterByRoutes,
       filterByBikeRentalStations,
       maxResults,

src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls

@@ -1002,7 +1002,10 @@ enum FeedAlertType {
 }
 
 enum FilterPlaceType {
-    """Stops"""
+    """
+    Stops.
+    NOTE: if this is selected at the same time as `STATION`, stops that have a parent station will not be returned but their parent stations will be returned instead.
+    """
     STOP
 
     """Departure rows"""
@@ -1019,6 +1022,13 @@ enum FilterPlaceType {
 
     """Parking lots that contain spaces for cars"""
     CAR_PARK
+
+
+    """
+    Stations.
+    NOTE: if this is selected at the same time as `STOP`, stops that have a parent station will not be returned but their parent stations will be returned instead.
+    """
+    STATION
 }
 
 type Geometry {
@@ -1098,6 +1108,9 @@ input InputFilters {
     """Stops to include by GTFS id."""
     stops: [String]
 
+    """Stations to include by GTFS id."""
+    stations: [String]
+
     """Routes to include by GTFS id."""
     routes: [String]
 
@@ -2560,7 +2573,7 @@ type QueryType {
         filterByModes: [Mode]
 
         """Only include places that match one of the given GTFS ids."""
-        filterByIds: InputFilters
+        filterByIds: InputFilters @deprecated(reason: "Not actively maintained")
         before: String
         after: String
         first: Int