Merge pull request opentripplanner#7090 from HSLdevcom/via-place

Add information to GraphQL schemas about if a place in an itinerary is a via location

Author: optionsome

application/src/ext/java/org/opentripplanner/ext/flex/FlexRouter.java

@@ -23,6 +23,7 @@
 import org.opentripplanner.model.PathTransfer;
 import org.opentripplanner.model.plan.Itinerary;
 import org.opentripplanner.routing.algorithm.mapping.GraphPathToItineraryMapper;
+import org.opentripplanner.routing.api.request.RouteRequest;
 import org.opentripplanner.routing.graph.Graph;
 import org.opentripplanner.routing.graphfinder.NearbyStop;
 import org.opentripplanner.routing.graphfinder.TransitServiceResolver;
@@ -120,7 +121,7 @@ public FlexRouter(
     );
   }
 
-  public List<Itinerary> createFlexOnlyItineraries(boolean arriveBy) {
+  public List<Itinerary> createFlexOnlyItineraries(boolean arriveBy, RouteRequest request) {
     OTPRequestTimeoutException.checkForTimeout();
 
     var directFlexPaths = new FlexDirectPathFactory(
@@ -136,7 +137,7 @@ public List<Itinerary> createFlexOnlyItineraries(boolean arriveBy) {
     for (DirectFlexPath it : directFlexPaths) {
       var startTime = startOfTime.plusSeconds(it.startTime());
       var itinerary = graphPathToItineraryMapper
-        .generateItinerary(new GraphPath<>(it.state()))
+        .generateItinerary(new GraphPath<>(it.state()), request)
         .withTimeShiftToStartAt(startTime);
 
       if (itinerary != null) {

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

@@ -110,7 +110,8 @@ public DataFetcher<StopArrival> from() {
         source.start(),
         source.start(),
         source.boardStopPosInPattern(),
-        source.boardingGtfsStopSequence()
+        source.boardingGtfsStopSequence(),
+        source.from().viaLocationType
       );
     };
   }
@@ -271,7 +272,8 @@ public DataFetcher<StopArrival> to() {
         source.end(),
         source.end(),
         source.alightStopPosInPattern(),
-        source.alightGtfsStopSequence()
+        source.alightGtfsStopSequence(),
+        source.to().viaLocationType
       );
     };
   }

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

@@ -11,6 +11,7 @@
 import org.opentripplanner.model.plan.VertexType;
 import org.opentripplanner.model.plan.leg.LegCallTime;
 import org.opentripplanner.model.plan.leg.StopArrival;
+import org.opentripplanner.model.plan.leg.ViaLocationType;
 import org.opentripplanner.service.vehicleparking.model.VehicleParking;
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalPlace;
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalStation;
@@ -168,6 +169,14 @@ public DataFetcher<String> vertexType() {
     };
   }
 
+  @Override
+  public DataFetcher<ViaLocationType> viaLocationType() {
+    return environment -> {
+      var stopArrival = getSource(environment);
+      return stopArrival.viaLocationType;
+    };
+  }
+
   private VehicleParking getBikePark(DataFetchingEnvironment environment) {
     StopArrival stopArrival = getSource(environment);
     var vehicleParkingWithEntrance = stopArrival.place.vehicleParkingWithEntrance;

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

@@ -28,7 +28,7 @@ public DataFetcher<DebugOutput> debugOutput() {
   @Override
   public DataFetcher<StopArrival> from() {
     return environment ->
-      new StopArrival(getSource(environment).getTripPlan().from, null, null, null, null);
+      new StopArrival(getSource(environment).getTripPlan().from, null, null, null, null, null);
   }
 
   @Override
@@ -115,7 +115,7 @@ public DataFetcher<Long> searchWindowUsed() {
   @Override
   public DataFetcher<StopArrival> to() {
     return environment ->
-      new StopArrival(getSource(environment).getTripPlan().to, null, null, null, null);
+      new StopArrival(getSource(environment).getTripPlan().to, null, null, null, null, null);
   }
 
   private RoutingResponse getSource(DataFetchingEnvironment environment) {

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

@@ -46,6 +46,7 @@
 import org.opentripplanner.model.plan.leg.LegCallTime;
 import org.opentripplanner.model.plan.leg.LegRealTimeEstimate;
 import org.opentripplanner.model.plan.leg.StopArrival;
+import org.opentripplanner.model.plan.leg.ViaLocationType;
 import org.opentripplanner.model.plan.walkstep.WalkStep;
 import org.opentripplanner.routing.alertpatch.TransitAlert;
 import org.opentripplanner.routing.api.response.RoutingError;
@@ -761,6 +762,8 @@ public interface GraphQLPlace {
     public DataFetcher<VehicleRentalStation> vehicleRentalStation();
 
     public DataFetcher<String> vertexType();
+
+    public DataFetcher<ViaLocationType> viaLocationType();
   }
 
   /** Interface for places, e.g. stops, stations, parking areas.. */

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

@@ -5693,6 +5693,12 @@ public enum GraphQLVertexType {
     TRANSIT,
   }
 
+  /** Categorization for via locations. */
+  public enum GraphQLViaLocationType {
+    PASS_THROUGH,
+    VISIT,
+  }
+
   public static class GraphQLWalkPreferencesInput {
 
     private org.opentripplanner.framework.model.Cost boardCost;

application/src/main/java/org/opentripplanner/apis/gtfs/generated/graphql-codegen.yml

@@ -136,4 +136,4 @@ config:
     CallSchedule: org.opentripplanner.apis.gtfs.model.CallSchedule#CallSchedule
     CallScheduledTime: org.opentripplanner.apis.gtfs.model.CallScheduledTime#CallScheduledTime
     RentalVehicleFuel: org.opentripplanner.service.vehiclerental.model.RentalVehicleFuel#RentalVehicleFuel
-
+    ViaLocationType: org.opentripplanner.model.plan.leg.ViaLocationType#ViaLocationType

application/src/main/java/org/opentripplanner/apis/transmodel/model/EnumTypes.java

@@ -7,6 +7,7 @@
 import java.util.function.Function;
 import org.opentripplanner.framework.doc.DocumentedEnum;
 import org.opentripplanner.model.plan.VertexType;
+import org.opentripplanner.model.plan.leg.ViaLocationType;
 import org.opentripplanner.model.plan.walkstep.AbsoluteDirection;
 import org.opentripplanner.model.plan.walkstep.RelativeDirection;
 import org.opentripplanner.model.transfer.TransferPriority;
@@ -468,6 +469,24 @@ public class EnumTypes {
     //TODO QL: .value("parkAndRide", VertexType.PARKANDRIDE)
     .build();
 
+  public static final GraphQLEnumType VIA_LOCATION_TYPE = GraphQLEnumType.newEnum()
+    .name("ViaLocationType")
+    .description("Categorization for via locations.")
+    .value(
+      "passThrough",
+      ViaLocationType.PASS_THROUGH,
+      "The via stop location must be visited as part of a transit trip as at the " +
+      "boarding stop, the intermediate stop, or the alighting stop."
+    )
+    .value(
+      "visit",
+      ViaLocationType.VISIT,
+      "The location is visited physically by boarding or alighting a transit trip at " +
+      "a given stop, or by traveling via requested coordinate location as part of a access, " +
+      "transfer, egress or direct segment. Intermediate stops visited on-board do not count."
+    )
+    .build();
+
   public static final GraphQLEnumType WHEELCHAIR_BOARDING = GraphQLEnumType.newEnum()
     .name("WheelchairBoarding")
     .value(

application/src/main/java/org/opentripplanner/apis/transmodel/model/plan/PlanPlaceType.java

@@ -131,6 +131,17 @@ public static GraphQLObjectType create(
           )
           .build()
       )
+      .field(
+        GraphQLFieldDefinition.newFieldDefinition()
+          .name("viaLocationType")
+          .type(EnumTypes.VIA_LOCATION_TYPE)
+          .description(
+            "This defines if the place is a requested via location, and what kind it is. If the " +
+            "value is `null`, this place is not a via location."
+          )
+          .dataFetcher(environment -> ((Place) environment.getSource()).viaLocationType)
+          .build()
+      )
       //                .field(GraphQLFieldDefinition.newFieldDefinition()
       //                        .name("bikePark")
       //                        .type(bikeParkType)

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

@@ -6,6 +6,7 @@
 import org.opentripplanner.framework.i18n.LocalizedString;
 import org.opentripplanner.framework.i18n.NonLocalizedString;
 import org.opentripplanner.model.GenericLocation;
+import org.opentripplanner.model.plan.leg.ViaLocationType;
 import org.opentripplanner.service.vehiclerental.model.VehicleRentalPlace;
 import org.opentripplanner.service.vehiclerental.street.VehicleRentalPlaceVertex;
 import org.opentripplanner.street.model.vertex.StreetVertex;
@@ -42,32 +43,43 @@ public class Place {
   /**
    * Reference to the stop if the type is {@link VertexType#TRANSIT}.
    */
+  @Nullable
   public final StopLocation stop;
 
   /**
    * The vehicle rental place if the type is {@link VertexType#VEHICLERENTAL}.
    */
+  @Nullable
   public final VehicleRentalPlace vehicleRentalPlace;
 
   /**
    * The vehicle parking entrance if the type is {@link VertexType#VEHICLEPARKING}.
    */
+  @Nullable
   public final VehicleParkingWithEntrance vehicleParkingWithEntrance;
 
+  /**
+   * Categorization for a via location, if the place is a via location in the request.
+   */
+  @Nullable
+  public final ViaLocationType viaLocationType;
+
   private Place(
     I18NString name,
     WgsCoordinate coordinate,
     VertexType vertexType,
-    StopLocation stop,
-    VehicleRentalPlace vehicleRentalPlace,
-    VehicleParkingWithEntrance vehicleParkingWithEntrance
+    @Nullable StopLocation stop,
+    @Nullable VehicleRentalPlace vehicleRentalPlace,
+    @Nullable VehicleParkingWithEntrance vehicleParkingWithEntrance,
+    @Nullable ViaLocationType viaLocationType
   ) {
     this.name = name;
     this.coordinate = coordinate;
     this.vertexType = vertexType;
     this.stop = stop;
     this.vehicleRentalPlace = vehicleRentalPlace;
     this.vehicleParkingWithEntrance = vehicleParkingWithEntrance;
+    this.viaLocationType = viaLocationType;
   }
 
   public static Place normal(Double lat, Double lon, I18NString name) {
@@ -77,23 +89,61 @@ public static Place normal(Double lat, Double lon, I18NString name) {
       VertexType.NORMAL,
       null,
       null,
+      null,
       null
     );
   }
 
+  public static Place normal(
+    Vertex vertex,
+    I18NString name,
+    @Nullable ViaLocationType viaLocationType
+  ) {
+    return new Place(
+      name,
+      WgsCoordinate.creatOptionalCoordinate(vertex.getLat(), vertex.getLon()),
+      VertexType.NORMAL,
+      null,
+      null,
+      null,
+      viaLocationType
+    );
+  }
+
   public static Place normal(Vertex vertex, I18NString name) {
     return new Place(
       name,
       WgsCoordinate.creatOptionalCoordinate(vertex.getLat(), vertex.getLon()),
       VertexType.NORMAL,
       null,
       null,
+      null,
       null
     );
   }
 
+  public static Place forStop(StopLocation stop, @Nullable ViaLocationType viaLocationType) {
+    return new Place(
+      stop.getName(),
+      stop.getCoordinate(),
+      VertexType.TRANSIT,
+      stop,
+      null,
+      null,
+      viaLocationType
+    );
+  }
+
   public static Place forStop(StopLocation stop) {
-    return new Place(stop.getName(), stop.getCoordinate(), VertexType.TRANSIT, stop, null, null);
+    return new Place(
+      stop.getName(),
+      stop.getCoordinate(),
+      VertexType.TRANSIT,
+      stop,
+      null,
+      null,
+      null
+    );
   }
 
   public static Place forFlexStop(StopLocation stop, Vertex vertex) {
@@ -114,6 +164,7 @@ public static Place forFlexStop(StopLocation stop, Vertex vertex) {
       VertexType.TRANSIT,
       stop,
       null,
+      null,
       null
     );
   }
@@ -140,6 +191,7 @@ public static Place forVehicleRentalPlace(VehicleRentalPlaceVertex vertex) {
       VertexType.VEHICLERENTAL,
       null,
       vertex.getStation(),
+      null,
       null
     );
   }
@@ -166,7 +218,8 @@ public static Place forVehicleParkingEntrance(VehicleParkingEntranceVertex verte
         .vehicleParking(vertex.getVehicleParking())
         .entrance(vertex.getParkingEntrance())
         .realtime(realTime)
-        .build()
+        .build(),
+      null
     );
   }
 
@@ -208,6 +261,7 @@ public String toString() {
       .addEnum("vertexType", vertexType)
       .addObj("vehicleRentalPlace", vehicleRentalPlace)
       .addObj("vehicleParkingEntrance", vehicleParkingWithEntrance)
+      .addObj("viaLocationType", viaLocationType)
       .toString();
   }
 }