Merge pull request #7565 from HSLdevcom/move-nearby-stop-finder

Move nearby stop and place finder classes to a new package and move nearby stop finding to happen in one interface

Author: optionsome

application/src/ext-test/java/org/opentripplanner/ext/carpooling/service/DefaultCarpoolingServiceAccessEgressTest.java

@@ -26,7 +26,6 @@
 import org.opentripplanner.routing.algorithm.raptoradapter.router.street.AccessEgressType;
 import org.opentripplanner.routing.api.request.RouteRequest;
 import org.opentripplanner.routing.api.request.request.StreetRequest;
-import org.opentripplanner.routing.graphfinder.TransitServiceResolver;
 import org.opentripplanner.routing.linking.VertexLinkerTestFactory;
 import org.opentripplanner.routing.linking.internal.VertexCreationService;
 import org.opentripplanner.street.geometry.WgsCoordinate;
@@ -39,6 +38,7 @@
 import org.opentripplanner.street.service.StreetLimitationParametersService;
 import org.opentripplanner.transit.service.DefaultTransitService;
 import org.opentripplanner.transit.service.TransitService;
+import org.opentripplanner.transit.service.TransitServiceResolver;
 
 /**
  * Integration tests for {@link DefaultCarpoolingService#routeAccessEgress}.

application/src/ext-test/java/org/opentripplanner/ext/flex/FlexRouterTest.java

@@ -9,7 +9,6 @@
 import java.util.Map;
 import java.util.Set;
 import java.util.stream.Collectors;
-import org.jspecify.annotations.NonNull;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
@@ -87,7 +86,7 @@ private void assertTripsForDate(
     assertEquals(Set.of(expectedTripIds), actualTripIds);
   }
 
-  private @NonNull FlexRouter setupEnvironment(TripRequest tripRequest) {
+  private FlexRouter setupEnvironment(TripRequest tripRequest) {
     // Test FlexTrip running day -> service date aggregation using three trips:
     //     trip1 runs on it's service day
     //     trip2 runs on it's service day and the day after

application/src/ext-test/java/org/opentripplanner/ext/flex/template/ClosestTripTest.java

@@ -16,7 +16,7 @@
 import org.opentripplanner.core.model.id.FeedScopedId;
 import org.opentripplanner.ext.flex.trip.FlexTrip;
 import org.opentripplanner.ext.flex.trip.UnscheduledTrip;
-import org.opentripplanner.routing.graphfinder.NearbyStop;
+import org.opentripplanner.place.api.NearbyStop;
 import org.opentripplanner.street.model.vertex.TransitStopVertex;
 import org.opentripplanner.transfer.regular.model.PathTransfer;
 import org.opentripplanner.transit.api.request.TripRequest;

application/src/ext-test/java/org/opentripplanner/ext/flex/template/FlexTemplateFactoryTest.java

@@ -27,7 +27,7 @@
 import org.opentripplanner.ext.flex.trip.UnscheduledTrip;
 import org.opentripplanner.model.PickDrop;
 import org.opentripplanner.model.StopTime;
-import org.opentripplanner.routing.graphfinder.NearbyStop;
+import org.opentripplanner.place.api.NearbyStop;
 import org.opentripplanner.street.model.vertex.StreetLocation;
 import org.opentripplanner.street.search.request.StreetSearchRequest;
 import org.opentripplanner.street.search.state.State;

application/src/ext-test/java/org/opentripplanner/ext/ojp/service/CallAtStopServiceTest.java

@@ -13,25 +13,27 @@
 import org.junit.jupiter.params.provider.MethodSource;
 import org.locationtech.jts.geom.Coordinate;
 import org.opentripplanner.core.model.id.FeedScopedId;
-import org.opentripplanner.routing.graphfinder.DirectGraphFinder;
-import org.opentripplanner.routing.graphfinder.GraphFinder;
-import org.opentripplanner.routing.graphfinder.NearbyStop;
-import org.opentripplanner.routing.graphfinder.PlaceAtDistance;
-import org.opentripplanner.routing.graphfinder.PlaceType;
+import org.opentripplanner.place.NearbyStopFinder;
+import org.opentripplanner.place.api.NearbyStop;
+import org.opentripplanner.place.nearbystopfinder.StraightLineNearbyStopFinder;
+import org.opentripplanner.routing.api.request.RouteRequest;
 import org.opentripplanner.street.geometry.WgsCoordinate;
+import org.opentripplanner.street.model.StreetMode;
+import org.opentripplanner.street.model.vertex.Vertex;
 import org.opentripplanner.street.search.state.TestStateBuilder;
 import org.opentripplanner.transit.model._data.TransitTestEnvironment;
 import org.opentripplanner.transit.model._data.TransitTestEnvironmentBuilder;
 import org.opentripplanner.transit.model._data.TripInput;
-import org.opentripplanner.transit.model.basic.TransitMode;
 import org.opentripplanner.transit.model.framework.EntityNotFoundException;
 import org.opentripplanner.transit.model.site.RegularStop;
 import org.opentripplanner.transit.service.ArrivalDeparture;
-import org.opentripplanner.transit.service.TransitService;
 
 class CallAtStopServiceTest {
 
   private final TransitTestEnvironmentBuilder envBuilder = TransitTestEnvironment.of();
+  private static final NearbyStopFinder NEARBY_STOP_FINDER = new StraightLineNearbyStopFinder(e ->
+    List.of()
+  );
 
   private static final String STOP_A_ID = "A";
   private static final String STOP_B_ID = "B";
@@ -74,10 +76,7 @@ public static List<FeedScopedId> stopPointRefCases() {
   @MethodSource("stopPointRefCases")
   void stopPointRef(FeedScopedId ref) {
     var env = envBuilder.addTrip(TRIP_INPUT).build();
-    var service = new CallAtStopService(
-      env.transitService(),
-      new DirectGraphFinder(e -> List.of())
-    );
+    var service = new CallAtStopService(env.transitService(), NEARBY_STOP_FINDER);
     var result = service.findCallsAtStop(ref, params(env, 100));
     assertThat(result).hasSize(1);
     var stopId = result.getFirst().tripTimeOnDate().getStop().getId();
@@ -87,20 +86,17 @@ void stopPointRef(FeedScopedId ref) {
   @Test
   void notFound() {
     var env = envBuilder.addTrip(TRIP_INPUT).build();
-    var service = new CallAtStopService(
-      env.transitService(),
-      new DirectGraphFinder(e -> List.of())
-    );
+    var service = new CallAtStopService(env.transitService(), NEARBY_STOP_FINDER);
     assertThrows(EntityNotFoundException.class, () ->
       service.findCallsAtStop(id("unknown"), params(env, 100))
     );
   }
 
   @Test
   void coordinates() {
-    var finder = new GraphFinder() {
+    var finder = new NearbyStopFinder() {
       @Override
-      public List<NearbyStop> findClosestStops(Coordinate coordinate, double radiusMeters) {
+      public List<NearbyStop> findNearbyStops(Coordinate coordinate, double radiusMeters) {
         return List.of(
           new NearbyStop(
             STOP_A.getId(),
@@ -112,19 +108,11 @@ public List<NearbyStop> findClosestStops(Coordinate coordinate, double radiusMet
       }
 
       @Override
-      public List<PlaceAtDistance> findClosestPlaces(
-        double lat,
-        double lon,
-        double radiusMeters,
-        int maxResults,
-        List<TransitMode> filterByModes,
-        List<PlaceType> filterByPlaceTypes,
-        List<FeedScopedId> filterByStops,
-        List<FeedScopedId> filterByStations,
-        List<FeedScopedId> filterByRoutes,
-        List<String> filterByBikeRentalStations,
-        List<String> filterByNetwork,
-        TransitService transitService
+      public List<NearbyStop> findNearbyStops(
+        Vertex vertex,
+        RouteRequest routingRequest,
+        StreetMode streetMode,
+        boolean reverseDirection
       ) {
         return List.of();
       }
@@ -145,10 +133,7 @@ void numberOfDeparturesLimitsResultsForStation() {
       .addStop(STOP_C, "12:15", "12:16");
 
     var env = envBuilder.addTrip(TRIP_INPUT).addTrip(trip2).build();
-    var service = new CallAtStopService(
-      env.transitService(),
-      new DirectGraphFinder(e -> List.of())
-    );
+    var service = new CallAtStopService(env.transitService(), NEARBY_STOP_FINDER);
 
     // Station OMEGA has two child stops (A, D), each with a departure.
     // Requesting 1 departure should return exactly 1, not 2.
@@ -163,10 +148,7 @@ void numberOfDeparturesLimitsResultsForStation() {
   @Test
   void tooManyDepartures() {
     var env = envBuilder.addTrip(TRIP_INPUT).build();
-    var service = new CallAtStopService(
-      env.transitService(),
-      new DirectGraphFinder(e -> List.of())
-    );
+    var service = new CallAtStopService(env.transitService(), NEARBY_STOP_FINDER);
     assertThrows(IllegalArgumentException.class, () ->
       service.findCallsAtStop(STOP_A.getId(), params(env, 101))
     );

application/src/ext/java/org/opentripplanner/ext/carpooling/CarpoolingService.java

@@ -7,7 +7,7 @@
 import org.opentripplanner.routing.algorithm.raptoradapter.router.street.AccessEgressType;
 import org.opentripplanner.routing.api.request.RouteRequest;
 import org.opentripplanner.routing.api.request.request.StreetRequest;
-import org.opentripplanner.routing.graphfinder.TransitServiceResolver;
+import org.opentripplanner.transit.service.TransitServiceResolver;
 
 /**
  * Service for finding carpooling options by matching passenger requests with available driver trips.

application/src/ext/java/org/opentripplanner/ext/carpooling/routing/InsertionCandidate.java

@@ -6,7 +6,7 @@
 import org.opentripplanner.astar.model.GraphPath;
 import org.opentripplanner.ext.carpooling.model.CarpoolTrip;
 import org.opentripplanner.ext.carpooling.util.GraphPathUtils;
-import org.opentripplanner.routing.graphfinder.NearbyStop;
+import org.opentripplanner.place.api.NearbyStop;
 import org.opentripplanner.street.model.edge.Edge;
 import org.opentripplanner.street.model.vertex.Vertex;
 import org.opentripplanner.street.search.state.State;

application/src/ext/java/org/opentripplanner/ext/carpooling/routing/InsertionEvaluator.java

@@ -9,8 +9,8 @@
 import javax.annotation.Nullable;
 import org.opentripplanner.astar.model.GraphPath;
 import org.opentripplanner.ext.carpooling.constraints.PassengerDelayConstraints;
+import org.opentripplanner.place.api.NearbyStop;
 import org.opentripplanner.routing.algorithm.raptoradapter.router.street.AccessEgressType;
-import org.opentripplanner.routing.graphfinder.NearbyStop;
 import org.opentripplanner.street.model.edge.Edge;
 import org.opentripplanner.street.model.vertex.Vertex;
 import org.opentripplanner.street.search.state.State;

application/src/ext/java/org/opentripplanner/ext/carpooling/routing/ViableAccessEgress.java

@@ -3,8 +3,8 @@
 import java.util.List;
 import javax.annotation.Nullable;
 import org.opentripplanner.astar.model.GraphPath;
+import org.opentripplanner.place.api.NearbyStop;
 import org.opentripplanner.routing.algorithm.raptoradapter.router.street.AccessEgressType;
-import org.opentripplanner.routing.graphfinder.NearbyStop;
 import org.opentripplanner.street.model.edge.Edge;
 import org.opentripplanner.street.model.vertex.Vertex;
 import org.opentripplanner.street.search.state.State;

application/src/ext/java/org/opentripplanner/ext/carpooling/service/DefaultCarpoolingService.java

@@ -29,18 +29,17 @@
 import org.opentripplanner.ext.carpooling.util.GraphPathUtils;
 import org.opentripplanner.ext.carpooling.util.StreetVertexUtils;
 import org.opentripplanner.framework.model.TimeAndCost;
-import org.opentripplanner.graph_builder.module.nearbystops.StreetNearbyStopFinder;
 import org.opentripplanner.model.GenericLocation;
 import org.opentripplanner.model.plan.Itinerary;
+import org.opentripplanner.place.api.NearbyStop;
+import org.opentripplanner.place.nearbystopfinder.StreetNearbyStopFinder;
 import org.opentripplanner.routing.algorithm.raptoradapter.router.street.AccessEgressType;
 import org.opentripplanner.routing.api.request.RouteRequest;
 import org.opentripplanner.routing.api.request.request.StreetRequest;
 import org.opentripplanner.routing.api.response.InputField;
 import org.opentripplanner.routing.api.response.RoutingError;
 import org.opentripplanner.routing.api.response.RoutingErrorCode;
 import org.opentripplanner.routing.error.RoutingValidationException;
-import org.opentripplanner.routing.graphfinder.NearbyStop;
-import org.opentripplanner.routing.graphfinder.TransitServiceResolver;
 import org.opentripplanner.routing.linking.internal.VertexCreationService;
 import org.opentripplanner.street.geometry.WgsCoordinate;
 import org.opentripplanner.street.linking.TemporaryVerticesContainer;
@@ -50,6 +49,7 @@
 import org.opentripplanner.streetadapter.StreetSearchRequestMapper;
 import org.opentripplanner.transit.model.site.AreaStop;
 import org.opentripplanner.transit.service.TransitService;
+import org.opentripplanner.transit.service.TransitServiceResolver;
 import org.opentripplanner.utils.time.TimeUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -430,6 +430,7 @@ public List<CarpoolAccessEgress> routeAccessEgress(
       }
 
       var streetNearbyStopFinder = StreetNearbyStopFinder.of(
+        null,
         MAX_SEARCH_DURATION_FOR_NEARBY_STOPS_FOR_ACCESS_EGRESS,
         0
       );