Refactor NearbyStop to support multiple last states

optionsome · optionsome · commit 5e6eae533496 · 2026-02-10T16:15:57.000+02:00
diff --git a/application/src/ext-test/java/org/opentripplanner/ext/flex/template/ClosestTripTest.java b/application/src/ext-test/java/org/opentripplanner/ext/flex/template/ClosestTripTest.java
@@ -94,7 +94,7 @@ void filter() {
   private static Collection<ClosestTrip> closestTrips(Matcher<Trip> matcher) {
     return ClosestTrip.of(
       ADAPTER,
-      List.of(new NearbyStop(STOP, 100, List.of(), null)),
+      List.of(new NearbyStop(STOP, 100, List.of(), List.of())),
       matcher,
       List.of(FSD),
       true
diff --git a/application/src/ext/java/org/opentripplanner/ext/flex/template/AbstractFlexTemplate.java b/application/src/ext/java/org/opentripplanner/ext/flex/template/AbstractFlexTemplate.java
@@ -107,7 +107,8 @@ Stream<FlexAccessEgress> createFlexAccessEgressStream(FlexAccessEgressCallbackAd
     // transferStop is Location Area/Line
     else {
       double maxDistanceMeters =
-        maxTransferDuration.getSeconds() * accessEgress.state.getRequest().walk().speed();
+        maxTransferDuration.getSeconds() *
+        accessEgress.lastStates.getFirst().getRequest().walk().speed();
 
       return getTransfersFromTransferStop(callback)
         .stream()
@@ -192,7 +193,10 @@ private FlexAccessEgress createFlexAccessEgress(
     // this code is a little repetitive but needed as a performance improvement. previously
     // the flex path was checked before this method was called. this meant that every path
     // was traversed twice, leading to a noticeable slowdown.
-    final var afterFlexState = flexEdge.traverse(accessEgress.state);
+
+    // TODO flex routing doesn't support via locations yet
+    var lastState = accessEgress.lastStates.getFirst();
+    final var afterFlexState = flexEdge.traverse(lastState);
     if (State.isEmpty(afterFlexState)) {
       return null;
     }
diff --git a/application/src/ext/java/org/opentripplanner/ext/flex/template/FlexAccessTemplate.java b/application/src/ext/java/org/opentripplanner/ext/flex/template/FlexAccessTemplate.java
@@ -58,7 +58,7 @@ protected Vertex getFlexVertex(Edge edge) {
   }
 
   protected FlexPathDurations calculateFlexPathDurations(FlexTripEdge flexEdge, State state) {
-    int preFlexTime = (int) accessEgress.state.getElapsedTimeSeconds();
+    int preFlexTime = (int) accessEgress.duration().getSeconds();
     int edgeTimeInSeconds = flexEdge.getTimeInSeconds();
     int postFlexTime = (int) state.getElapsedTimeSeconds() - preFlexTime - edgeTimeInSeconds;
     return new FlexPathDurations(
@@ -70,8 +70,10 @@ protected FlexPathDurations calculateFlexPathDurations(FlexTripEdge flexEdge, St
   }
 
   protected FlexTripEdge getFlexEdge(Vertex flexToVertex, StopLocation transferStop) {
+    // TODO flex doesn't support via locations yet
+    var lastVertex = accessEgress.lastStates.getLast().getVertex();
     var flexPath = calculator.calculateFlexPath(
-      accessEgress.state.getVertex(),
+      lastVertex,
       flexToVertex,
       boardStopPosition,
       alightStopPosition
@@ -82,7 +84,7 @@ protected FlexTripEdge getFlexEdge(Vertex flexToVertex, StopLocation transferSto
     }
 
     return new FlexTripEdge(
-      accessEgress.state.getVertex(),
+      lastVertex,
       flexToVertex,
       accessEgress.stop,
       transferStop,
diff --git a/application/src/ext/java/org/opentripplanner/ext/flex/template/FlexDirectPathFactory.java b/application/src/ext/java/org/opentripplanner/ext/flex/template/FlexDirectPathFactory.java
@@ -105,7 +105,8 @@ private Optional<DirectFlexPath> createDirectGraphPath(
     int accessAlightStopPosition = accessTemplate.alightStopPosition;
     int requestedBookingTime = accessTemplate.requestedBookingTime;
 
-    var flexToVertex = egress.state.getVertex();
+    // TODO flex doesn't support via locations yet
+    var flexToVertex = egress.lastStates.getLast().getVertex();
 
     if (!isRouteable(accessTemplate, flexToVertex)) {
       return Optional.empty();
@@ -117,7 +118,9 @@ private Optional<DirectFlexPath> createDirectGraphPath(
       return Optional.empty();
     }
 
-    final State[] afterFlexState = flexEdge.traverse(accessNearbyStop.state);
+    // TODO flex doesn't support via locations yet
+    var lastState = accessNearbyStop.lastStates.getLast();
+    final State[] afterFlexState = flexEdge.traverse(lastState);
 
     var finalStateOpt = EdgeTraverser.traverseEdges(afterFlexState[0], egress.edges);
 
@@ -183,12 +186,14 @@ private Optional<DirectFlexPath> createDirectGraphPath(
   }
 
   protected boolean isRouteable(FlexAccessTemplate accessTemplate, Vertex flexVertex) {
-    if (accessTemplate.accessEgress.state.getVertex() == flexVertex) {
+    // TODO flex doesn't support via locations yet
+    var lastVertex = accessTemplate.accessEgress.lastStates.getLast().getVertex();
+    if (lastVertex == flexVertex) {
       return false;
     } else {
       return (
         accessTemplate.calculator.calculateFlexPath(
-          accessTemplate.accessEgress.state.getVertex(),
+          lastVertex,
           flexVertex,
           accessTemplate.boardStopPosition,
           accessTemplate.alightStopPosition
diff --git a/application/src/ext/java/org/opentripplanner/ext/flex/template/FlexEgressTemplate.java b/application/src/ext/java/org/opentripplanner/ext/flex/template/FlexEgressTemplate.java
@@ -59,7 +59,7 @@ protected Vertex getFlexVertex(Edge edge) {
   }
 
   protected FlexPathDurations calculateFlexPathDurations(FlexTripEdge flexEdge, State state) {
-    int postFlexTime = (int) accessEgress.state.getElapsedTimeSeconds();
+    int postFlexTime = (int) accessEgress.duration().getSeconds();
     int edgeTimeInSeconds = flexEdge.getTimeInSeconds();
     int preFlexTime = (int) state.getElapsedTimeSeconds() - postFlexTime - edgeTimeInSeconds;
     return new FlexPathDurations(
@@ -71,9 +71,11 @@ protected FlexPathDurations calculateFlexPathDurations(FlexTripEdge flexEdge, St
   }
 
   protected FlexTripEdge getFlexEdge(Vertex flexFromVertex, StopLocation transferStop) {
+    // TODO flex doesn't support via locations yet
+    var lastVertex = accessEgress.lastStates.getLast().getVertex();
     var flexPath = calculator.calculateFlexPath(
       flexFromVertex,
-      accessEgress.state.getVertex(),
+      lastVertex,
       boardStopPosition,
       alightStopPosition
     );
@@ -84,7 +86,7 @@ protected FlexTripEdge getFlexEdge(Vertex flexFromVertex, StopLocation transferS
 
     return new FlexTripEdge(
       flexFromVertex,
-      accessEgress.state.getVertex(),
+      lastVertex,
       transferStop,
       accessEgress.stop,
       trip,
diff --git a/application/src/main/java/org/opentripplanner/apis/gtfs/datafetchers/QueryTypeImpl.java b/application/src/main/java/org/opentripplanner/apis/gtfs/datafetchers/QueryTypeImpl.java
@@ -461,7 +461,7 @@ public DataFetcher<Object> node() {
           var stop = transitService.getRegularStop(FeedScopedId.parse(parts[1]));
 
           // TODO: Add geometry
-          return new NearbyStop(stop, Integer.parseInt(parts[0]), null, null);
+          return new NearbyStop(stop, Integer.parseInt(parts[0]), List.of(), List.of());
         }
         case "TicketType":
           // TODO
diff --git a/application/src/main/java/org/opentripplanner/apis/gtfs/datafetchers/StopImpl.java b/application/src/main/java/org/opentripplanner/apis/gtfs/datafetchers/StopImpl.java
@@ -444,7 +444,12 @@ public DataFetcher<Iterable<NearbyStop>> transfers() {
             .filter(transfer -> maxDistance == null || transfer.getDistanceMeters() < maxDistance)
             .filter(transfer -> transfer.to instanceof RegularStop)
             .map(transfer ->
-              new NearbyStop(transfer.to, transfer.getDistanceMeters(), transfer.getEdges(), null)
+              new NearbyStop(
+                transfer.to,
+                transfer.getDistanceMeters(),
+                transfer.getEdges(),
+                List.of()
+              )
             )
             .collect(Collectors.toList());
         },
diff --git a/application/src/main/java/org/opentripplanner/routing/algorithm/raptoradapter/router/street/AccessEgressRouter.java b/application/src/main/java/org/opentripplanner/routing/algorithm/raptoradapter/router/street/AccessEgressRouter.java
@@ -58,7 +58,7 @@ public Collection<NearbyStop> findAccessEgresses(
     // When looking for street accesses/egresses we ignore the already found direct accesses/egresses
     var ignoreVertices = zeroDistanceAccessEgress
       .stream()
-      .map(nearbyStop -> nearbyStop.state.getVertex())
+      .map(nearbyStop -> nearbyStop.lastStates.getLast().getVertex())
       .collect(Collectors.toSet());
 
     var originVertices = accessOrEgress.isAccess()
diff --git a/application/src/main/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/mappers/AccessEgressMapper.java b/application/src/main/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/mappers/AccessEgressMapper.java
@@ -10,6 +10,7 @@
 import org.opentripplanner.routing.algorithm.raptoradapter.transit.FlexAccessEgressAdapter;
 import org.opentripplanner.routing.algorithm.raptoradapter.transit.RoutingAccessEgress;
 import org.opentripplanner.routing.graphfinder.NearbyStop;
+import org.opentripplanner.street.search.state.State;
 import org.opentripplanner.transit.model.site.RegularStop;
 
 public class AccessEgressMapper {
@@ -45,7 +46,9 @@ private static RoutingAccessEgress mapNearbyStop(
 
     return new DefaultAccessEgress(
       nearbyStop.stop.getIndex(),
-      accessOrEgress.isEgress() ? nearbyStop.state.reverse() : nearbyStop.state
+      accessOrEgress.isEgress()
+        ? nearbyStop.lastStates.stream().map(State::reverse).toList().reversed()
+        : nearbyStop.lastStates
     );
   }
 }
diff --git a/application/src/main/java/org/opentripplanner/routing/graphfinder/DirectGraphFinder.java b/application/src/main/java/org/opentripplanner/routing/graphfinder/DirectGraphFinder.java
@@ -41,7 +41,7 @@ public List<NearbyStop> findClosestStops(Coordinate coordinate, double radiusMet
         SphericalDistanceLibrary.distance(coordinate, it.getCoordinate().asJtsCoordinate())
       );
       if (distance < radiusMeters) {
-        NearbyStop sd = new NearbyStop(it, distance, null, null);
+        NearbyStop sd = new NearbyStop(it, distance, List.of(), List.of());
         stopsFound.add(sd);
       }
     }
diff --git a/application/src/main/java/org/opentripplanner/routing/graphfinder/NearbyStop.java b/application/src/main/java/org/opentripplanner/routing/graphfinder/NearbyStop.java
@@ -20,14 +20,26 @@ public class NearbyStop implements Comparable<NearbyStop> {
   public final StopLocation stop;
   public final double distance;
 
+  /**
+   * All edges that are needed to reach the stop.
+   */
   public final List<Edge> edges;
-  public final State state;
 
-  public NearbyStop(StopLocation stop, double distance, List<Edge> edges, State state) {
+  /**
+   * This a list of states where the last state in the list is always at the stop and states before
+   * that state end at a via location.
+   */
+  public final List<State> lastStates;
+
+  public NearbyStop(StopLocation stop, double distance, List<Edge> edges, List<State> lastStates) {
     this.stop = Objects.requireNonNull(stop);
     this.distance = distance;
     this.edges = edges;
-    this.state = state;
+    this.lastStates = lastStates;
+  }
+
+  public NearbyStop(StopLocation stop, double distance, List<Edge> edges, State lastState) {
+    this(stop, distance, edges, List.of(Objects.requireNonNull(lastState)));
   }
 
   /**
@@ -63,14 +75,9 @@ public boolean isBetter(NearbyStop other) {
 
   @Override
   public int compareTo(NearbyStop that) {
-    if ((this.state == null) != (that.state == null)) {
-      throw new IllegalStateException(
-        "Only NearbyStops which both contain or lack a state may be compared."
-      );
-    }
-
-    if (this.state != null) {
-      return (int) (this.state.getWeight()) - (int) (that.state.getWeight());
+    var weightDifference = (int) (this.weight()) - (int) (that.weight());
+    if (weightDifference != 0) {
+      return weightDifference;
     }
     return (int) (this.distance) - (int) (that.distance);
   }
@@ -79,12 +86,21 @@ public int compareTo(NearbyStop that) {
    * Duration it took to reach the stop.
    */
   public Duration duration() {
-    return Duration.ofSeconds(state.getElapsedTimeSeconds());
+    return Duration.ofSeconds(
+      lastStates.stream().mapToLong(State::getElapsedTimeSeconds).reduce(0, Long::sum)
+    );
+  }
+
+  /**
+   * Weight (cost) of reaching the stop.
+   */
+  public double weight() {
+    return lastStates.stream().mapToDouble(State::getWeight).reduce(0.0, Double::sum);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(stop, distance, edges, state);
+    return Objects.hash(stop, distance, edges, lastStates);
   }
 
   @Override
@@ -100,7 +116,7 @@ public boolean equals(Object o) {
       Double.compare(that.distance, distance) == 0 &&
       stop.equals(that.stop) &&
       Objects.equals(edges, that.edges) &&
-      Objects.equals(state, that.state)
+      Objects.equals(lastStates, that.lastStates)
     );
   }
 
@@ -110,8 +126,8 @@ public String toString() {
       "stop %s at %.1f meters%s%s",
       stop,
       distance,
-      edges != null ? " (" + edges.size() + " edges)" : "",
-      state != null ? " w/state" : ""
+      " (" + edges.size() + " edges)",
+      " (" + lastStates.size() + " lastStates)"
     );
   }
 }
diff --git a/application/src/main/java/org/opentripplanner/routing/via/service/DefaultViaCoordinateTransferFactory.java b/application/src/main/java/org/opentripplanner/routing/via/service/DefaultViaCoordinateTransferFactory.java
@@ -61,8 +61,8 @@ public List<ViaCoordinateTransfer> createViaTransfers(
             to.stop.getIndex(),
             from.edges,
             to.edges,
-            (int) (from.state.getElapsedTimeSeconds() + to.state.getElapsedTimeSeconds()),
-            from.state.getWeight() + to.state.getWeight()
+            (int) (from.duration().plus(to.duration()).getSeconds()),
+            from.weight() + to.weight()
           )
         );
       }
diff --git a/application/src/test/java/org/opentripplanner/graph_builder/module/nearbystops/StreetNearbyStopFinderMultipleLinksTest.java b/application/src/test/java/org/opentripplanner/graph_builder/module/nearbystops/StreetNearbyStopFinderMultipleLinksTest.java
@@ -81,8 +81,9 @@ void assertZeroDistanceStop(TransitStopVertex expected, NearbyStop nearbyStop) {
     assertEquals(stopResolver.getRegularStop(expected.getId()), nearbyStop.stop);
     assertEquals(0, nearbyStop.distance);
     assertEquals(0, nearbyStop.edges.size());
-    assertEquals(expected, nearbyStop.state.getVertex());
-    assertNull(nearbyStop.state.getBackState());
+    var lastState = nearbyStop.lastStates.getLast();
+    assertEquals(expected, lastState.getVertex());
+    assertNull(lastState.getBackState());
   }
 
   /**
@@ -95,8 +96,9 @@ void assertStopAtDistance(
   ) {
     assertEquals(stopResolver.getRegularStop(expected.getId()), nearbyStop.stop);
     assertEquals(expectedDistance, nearbyStop.distance);
-    assertEquals(expected, nearbyStop.state.getVertex());
+    var lastState = nearbyStop.lastStates.getLast();
+    assertEquals(expected, lastState.getVertex());
     assertFalse(nearbyStop.edges.isEmpty());
-    assertNotNull(nearbyStop.state.getBackState());
+    assertNotNull(lastState.getBackState());
   }
 }
diff --git a/application/src/test/java/org/opentripplanner/graph_builder/module/nearbystops/StreetNearbyStopFinderTest.java b/application/src/test/java/org/opentripplanner/graph_builder/module/nearbystops/StreetNearbyStopFinderTest.java
@@ -190,8 +190,9 @@ void assertZeroDistanceStop(TransitStopVertex expected, NearbyStop nearbyStop) {
     assertEquals(stopResolver.getRegularStop(expected.getId()), nearbyStop.stop);
     assertEquals(0, nearbyStop.distance);
     assertEquals(0, nearbyStop.edges.size());
-    assertEquals(expected, nearbyStop.state.getVertex());
-    assertNull(nearbyStop.state.getBackState());
+    var lastState = nearbyStop.lastStates.getLast();
+    assertEquals(expected, lastState.getVertex());
+    assertNull(lastState.getBackState());
   }
 
   /**
@@ -204,8 +205,9 @@ void assertStopAtDistance(
   ) {
     assertEquals(stopResolver.getRegularStop(expected.getId()), nearbyStop.stop);
     assertEquals(expectedDistance, nearbyStop.distance);
-    assertEquals(expected, nearbyStop.state.getVertex());
+    var lastState = nearbyStop.lastStates.getLast();
+    assertEquals(expected, lastState.getVertex());
     assertFalse(nearbyStop.edges.isEmpty());
-    assertNotNull(nearbyStop.state.getBackState());
+    assertNotNull(lastState.getBackState());
   }
 }
diff --git a/application/src/test/java/org/opentripplanner/routing/algorithm/raptoradapter/router/street/AccessEgressRouterTest.java b/application/src/test/java/org/opentripplanner/routing/algorithm/raptoradapter/router/street/AccessEgressRouterTest.java
@@ -229,7 +229,7 @@ private String nearbyStopDescription(NearbyStop nearbyStop) {
     if (nearbyStop.edges.isEmpty()) {
       return "direct[" + nearbyStop.stop.getName() + "]";
     } else {
-      return "street[" + stateDescription(nearbyStop.state) + "]";
+      return "street" + nearbyStop.lastStates.stream().map(this::stateDescription).toList();
     }
   }
 
diff --git a/application/src/test/java/org/opentripplanner/routing/graphfinder/DirectGraphFinderTest.java b/application/src/test/java/org/opentripplanner/routing/graphfinder/DirectGraphFinderTest.java
@@ -36,8 +36,8 @@ public void build() {
 
   @Test
   void findClosestStops() {
-    var ns1 = new NearbyStop(siteRepository.getRegularStop(S1.getId()), 0, null, null);
-    var ns2 = new NearbyStop(siteRepository.getRegularStop(S2.getId()), 1112, null, null);
+    var ns1 = new NearbyStop(siteRepository.getRegularStop(S1.getId()), 0, List.of(), List.of());
+    var ns2 = new NearbyStop(siteRepository.getRegularStop(S2.getId()), 1112, List.of(), List.of());
 
     var subject = new DirectGraphFinder(siteRepository::findRegularStops);
     var coordinate = new Coordinate(19.000, 47.500);
diff --git a/application/src/test/java/org/opentripplanner/routing/graphfinder/NearbyStopTest.java b/application/src/test/java/org/opentripplanner/routing/graphfinder/NearbyStopTest.java
@@ -3,6 +3,7 @@
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
+import java.util.List;
 import org.junit.jupiter.api.Test;
 import org.opentripplanner.transit.model._data.TimetableRepositoryForTest;
 
@@ -16,13 +17,13 @@ class NearbyStopTest {
   void testIsBetter() {
     // We only test the distance here, since the compareTo method used should have a more complete
     // unit-test including tests on state weight.
-    var a = new NearbyStop(MODEL.stop("A").build(), 20.0, null, null);
-    var b = new NearbyStop(MODEL.stop("A").build(), 30.0, null, null);
+    var a = new NearbyStop(MODEL.stop("A").build(), 20.0, List.of(), List.of());
+    var b = new NearbyStop(MODEL.stop("A").build(), 30.0, List.of(), List.of());
 
     assertTrue(a.isBetter(b));
     assertFalse(b.isBetter(a));
 
-    var sameDistance = new NearbyStop(MODEL.stop("A").build(), 20.0, null, null);
+    var sameDistance = new NearbyStop(MODEL.stop("A").build(), 20.0, List.of(), List.of());
     assertFalse(a.isBetter(sameDistance));
     assertFalse(sameDistance.isBetter(a));
   }
diff --git a/application/src/test/java/org/opentripplanner/routing/graphfinder/StreetGraphFinderTest.java b/application/src/test/java/org/opentripplanner/routing/graphfinder/StreetGraphFinderTest.java

Original file line number	Diff line number	Diff line change
`@@ -461,7 +461,7 @@ public DataFetcher<Object> node() {`
`461`	`461`	`var stop = transitService.getRegularStop(FeedScopedId.parse(parts[1]));`
`462`	`462`
`463`	`463`	`// TODO: Add geometry`
`464`		`- return new NearbyStop(stop, Integer.parseInt(parts[0]), null, null);`
	`464`	`+ return new NearbyStop(stop, Integer.parseInt(parts[0]), List.of(), List.of());`
`465`	`465`	`}`
`466`	`466`	`case "TicketType":`
`467`	`467`	`// TODO`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public List<NearbyStop> findClosestStops(Coordinate coordinate, double radiusMet`
`41`	`41`	`SphericalDistanceLibrary.distance(coordinate, it.getCoordinate().asJtsCoordinate())`
`42`	`42`	`);`
`43`	`43`	`if (distance < radiusMeters) {`
`44`		`- NearbyStop sd = new NearbyStop(it, distance, null, null);`
	`44`	`+ NearbyStop sd = new NearbyStop(it, distance, List.of(), List.of());`
`45`	`45`	`stopsFound.add(sd);`
`46`	`46`	`}`
`47`	`47`	`}`