Nav 131 extend query config for raptor

src/main/java/ch/naviqore/app/controller/RoutingController.java

@@ -1,11 +1,9 @@
 package ch.naviqore.app.controller;
 
 import ch.naviqore.app.dto.Connection;
+import ch.naviqore.app.dto.RouterInfo;
 import ch.naviqore.app.dto.StopConnection;
-import ch.naviqore.app.dto.TimeType;
-import ch.naviqore.service.PublicTransitService;
-import ch.naviqore.service.ScheduleInformationService;
-import ch.naviqore.service.Stop;
+import ch.naviqore.service.*;
 import ch.naviqore.service.config.ConnectionQueryConfig;
 import ch.naviqore.service.exception.ConnectionRoutingException;
 import ch.naviqore.utils.spatial.GeoCoordinate;
@@ -25,6 +23,7 @@
 import org.springframework.web.server.ResponseStatusException;
 
 import java.time.LocalDateTime;
+import java.util.EnumSet;
 import java.util.List;
 
 import static ch.naviqore.app.dto.DtoMapper.map;
@@ -47,6 +46,14 @@ private static void handleConnectionRoutingException(ConnectionRoutingException
         throw new ResponseStatusException(HttpStatus.INTERNAL_SERVER_ERROR, e.getMessage());
     }
 
+    @Operation(summary = "Get information about the routing service", description = "Get information about the routing service, such as supported features.")
+    @ApiResponse(responseCode = "200", description = "A list of features supported or not supported by the routing service.")
+    @GetMapping("/")
+    public RouterInfo getRouterInfo() {
+        return new RouterInfo(service.hasAccessibilityInformation(), service.hasBikeInformation(),
+                service.hasTravelModeInformation());
+    }
+
     @Operation(summary = "Request connections between two stops or locations", description = "Requests connections between two stops or locations at a given departure / arrival datetime.")
     @ApiResponse(responseCode = "200", description = "A list of connections between the specified stops.")
     @ApiResponse(responseCode = "400", description = "Invalid input parameters", content = @Content(schema = @Schema()))
@@ -63,8 +70,10 @@ public List<Connection> getConnections(@RequestParam(required = false) String so
                                            @RequestParam(required = false) Integer maxWalkingDuration,
                                            @RequestParam(required = false) Integer maxTransferNumber,
                                            @RequestParam(required = false) Integer maxTravelTime,
-                                           @RequestParam(required = false, defaultValue = "0") int minTransferTime) {
-
+                                           @RequestParam(required = false, defaultValue = "0") int minTransferTime,
+                                           @RequestParam(required = false, defaultValue = "false") boolean wheelchairAccessible,
+                                           @RequestParam(required = false, defaultValue = "false") boolean bikeAllowed,
+                                           @RequestParam(required = false) EnumSet<TravelMode> travelModes) {
         // get coordinates if available
         GeoCoordinate sourceCoordinate = Utils.getCoordinateIfAvailable(sourceStopId, sourceLatitude, sourceLongitude,
                 GlobalValidator.StopType.SOURCE);
@@ -78,19 +87,19 @@ public List<Connection> getConnections(@RequestParam(required = false) String so
         // configure routing request
         dateTime = GlobalValidator.validateAndSetDefaultDateTime(dateTime, service);
         ConnectionQueryConfig config = Utils.createConfig(maxWalkingDuration, maxTransferNumber, maxTravelTime,
-                minTransferTime);
+                minTransferTime, wheelchairAccessible, bikeAllowed, travelModes, service);
 
         // determine routing case and get connections
         try {
             if (sourceStop != null && targetStop != null) {
                 RoutingRequestValidator.validateStops(sourceStopId, targetStopId);
-                return map(service.getConnections(sourceStop, targetStop, dateTime, map(timeType), config));
+                return map(service.getConnections(sourceStop, targetStop, dateTime, timeType, config));
             } else if (sourceStop != null) {
-                return map(service.getConnections(sourceStop, targetCoordinate, dateTime, map(timeType), config));
+                return map(service.getConnections(sourceStop, targetCoordinate, dateTime, timeType, config));
             } else if (targetStop != null) {
-                return map(service.getConnections(sourceCoordinate, targetStop, dateTime, map(timeType), config));
+                return map(service.getConnections(sourceCoordinate, targetStop, dateTime, timeType, config));
             } else {
-                return map(service.getConnections(sourceCoordinate, targetCoordinate, dateTime, map(timeType), config));
+                return map(service.getConnections(sourceCoordinate, targetCoordinate, dateTime, timeType, config));
             }
         } catch (ConnectionRoutingException e) {
             handleConnectionRoutingException(e);
@@ -112,6 +121,9 @@ public List<StopConnection> getIsolines(@RequestParam(required = false) String s
                                             @RequestParam(required = false) Integer maxTransferNumber,
                                             @RequestParam(required = false) Integer maxTravelTime,
                                             @RequestParam(required = false, defaultValue = "0") int minTransferTime,
+                                            @RequestParam(required = false, defaultValue = "false") boolean wheelchairAccessible,
+                                            @RequestParam(required = false, defaultValue = "false") boolean bikeAllowed,
+                                            @RequestParam(required = false) EnumSet<TravelMode> travelModes,
                                             @RequestParam(required = false, defaultValue = "false") boolean returnConnections) {
 
         // get stops or coordinates if available
@@ -122,15 +134,14 @@ public List<StopConnection> getIsolines(@RequestParam(required = false) String s
         // configure routing request
         dateTime = GlobalValidator.validateAndSetDefaultDateTime(dateTime, service);
         ConnectionQueryConfig config = Utils.createConfig(maxWalkingDuration, maxTransferNumber, maxTravelTime,
-                minTransferTime);
+                minTransferTime, wheelchairAccessible, bikeAllowed, travelModes, service);
 
         // determine routing case and get isolines
         try {
             if (sourceStop != null) {
-                return map(service.getIsoLines(sourceStop, dateTime, map(timeType), config), timeType,
-                        returnConnections);
+                return map(service.getIsoLines(sourceStop, dateTime, timeType, config), timeType, returnConnections);
             } else {
-                return map(service.getIsoLines(sourceCoordinate, dateTime, map(timeType), config), timeType,
+                return map(service.getIsoLines(sourceCoordinate, dateTime, timeType, config), timeType,
                         returnConnections);
             }
         } catch (ConnectionRoutingException e) {
@@ -156,17 +167,25 @@ private static class Utils {
 
         private static ConnectionQueryConfig createConfig(@Nullable Integer maxWalkingDuration,
                                                           @Nullable Integer maxTransferNumber,
-                                                          @Nullable Integer maxTravelTime, int minTransferTime) {
+                                                          @Nullable Integer maxTravelTime, int minTransferTime,
+                                                          boolean wheelchairAccessible, boolean bikeAllowed,
+                                                          @Nullable EnumSet<TravelMode> travelModes,
+                                                          PublicTransitService service) {
 
             // replace null values with integer max value
             maxWalkingDuration = setToMaxIfNull(maxWalkingDuration);
             maxTransferNumber = setToMaxIfNull(maxTransferNumber);
             maxTravelTime = setToMaxIfNull(maxTravelTime);
 
+            if (travelModes == null || travelModes.isEmpty()) {
+                travelModes = EnumSet.allOf(TravelMode.class);
+            }
+
             // validate and create config
             RoutingRequestValidator.validateQueryParams(maxWalkingDuration, maxTransferNumber, maxTravelTime,
-                    minTransferTime);
-            return new ConnectionQueryConfig(maxWalkingDuration, minTransferTime, maxTransferNumber, maxTravelTime);
+                    minTransferTime, wheelchairAccessible, bikeAllowed, travelModes, service);
+            return new ConnectionQueryConfig(maxWalkingDuration, minTransferTime, maxTransferNumber, maxTravelTime,
+                    wheelchairAccessible, bikeAllowed, travelModes);
         }
 
         private static int setToMaxIfNull(Integer value) {

src/main/java/ch/naviqore/app/controller/RoutingRequestValidator.java

@@ -1,12 +1,16 @@
 package ch.naviqore.app.controller;
 
+import ch.naviqore.service.PublicTransitService;
+import ch.naviqore.service.TravelMode;
 import ch.naviqore.utils.spatial.GeoCoordinate;
 import lombok.AccessLevel;
 import lombok.NoArgsConstructor;
 import org.jetbrains.annotations.Nullable;
 import org.springframework.http.HttpStatus;
 import org.springframework.web.server.ResponseStatusException;
 
+import java.util.EnumSet;
+
 @NoArgsConstructor(access = AccessLevel.NONE)
 final class RoutingRequestValidator {
 
@@ -20,7 +24,8 @@ public static GeoCoordinate validateCoordinate(double latitude, double longitude
     }
 
     public static void validateQueryParams(int maxWalkingDuration, int maxTransferNumber, int maxTravelTime,
-                                           int minTransferTime) {
+                                           int minTransferTime, boolean wheelchairAccessible, boolean bikeAllowed,
+                                           EnumSet<TravelMode> travelModes, PublicTransitService service) {
         if (maxWalkingDuration < 0) {
             throw new ResponseStatusException(HttpStatus.BAD_REQUEST,
                     "Max walking duration must be greater than or equal to 0.");
@@ -36,6 +41,22 @@ public static void validateQueryParams(int maxWalkingDuration, int maxTransferNu
             throw new ResponseStatusException(HttpStatus.BAD_REQUEST,
                     "Min transfer time must be greater than or equal to 0.");
         }
+
+        // If the service does not support accessibility information, bike information, or travel mode information,
+        // only default values are allowed (i.e., false for wheelchairAccessible, false for bikeAllowed,
+        // and all travel modes).
+        if (wheelchairAccessible && !service.hasAccessibilityInformation()) {
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST,
+                    "Accessibility information is not available for this service.");
+        }
+        if (bikeAllowed && !service.hasBikeInformation()) {
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST,
+                    "Bike information is not available for this service.");
+        }
+        if (!travelModes.containsAll(EnumSet.allOf(TravelMode.class)) && !service.hasTravelModeInformation()) {
+            throw new ResponseStatusException(HttpStatus.BAD_REQUEST,
+                    "Service does not support travel mode information.");
+        }
     }
 
     public static void validateStopParameters(@Nullable String stopId, @Nullable Double latitude,

src/main/java/ch/naviqore/app/dto/DtoMapper.java

@@ -1,7 +1,6 @@
 package ch.naviqore.app.dto;
 
 import ch.naviqore.service.SearchType;
-import ch.naviqore.service.TimeType;
 import ch.naviqore.service.*;
 import lombok.AccessLevel;
 import lombok.NoArgsConstructor;
@@ -50,13 +49,6 @@ public static SearchType map(ch.naviqore.app.dto.SearchType searchType) {
         };
     }
 
-    public static TimeType map(ch.naviqore.app.dto.TimeType timeType) {
-        return switch (timeType) {
-            case DEPARTURE -> TimeType.DEPARTURE;
-            case ARRIVAL -> TimeType.ARRIVAL;
-        };
-    }
-
     public static Connection map(ch.naviqore.service.Connection connection) {
         List<Leg> legs = connection.getLegs().stream().map(leg -> leg.accept(new LegVisitorImpl())).toList();
         return new Connection(legs);
@@ -67,7 +59,7 @@ public static List<Connection> map(List<ch.naviqore.service.Connection> connecti
     }
 
     public static List<StopConnection> map(Map<ch.naviqore.service.Stop, ch.naviqore.service.Connection> connections,
-                                           ch.naviqore.app.dto.TimeType timeType, boolean returnConnections) {
+                                           TimeType timeType, boolean returnConnections) {
         List<StopConnection> arrivals = new ArrayList<>();
         for (Map.Entry<ch.naviqore.service.Stop, ch.naviqore.service.Connection> entry : connections.entrySet()) {
             arrivals.add(new StopConnection(entry.getKey(), entry.getValue(), timeType, returnConnections));

src/main/java/ch/naviqore/app/dto/RouterInfo.java

@@ -0,0 +1,14 @@
+package ch.naviqore.app.dto;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.ToString;
+
+@RequiredArgsConstructor
+@ToString
+@Getter
+public class RouterInfo {
+    final boolean supportsAccessibility;
+    final boolean supportsBikes;
+    final boolean supportsTravelModes;
+}

src/main/java/ch/naviqore/app/dto/StopConnection.java

@@ -1,5 +1,6 @@
 package ch.naviqore.app.dto;
 
+import ch.naviqore.service.TimeType;
 import lombok.*;
 
 import java.time.LocalDateTime;

src/main/java/ch/naviqore/app/service/PublicTransitSpringService.java

@@ -56,6 +56,21 @@ public Validity getValidity() {
         return delegate.getValidity();
     }
 
+    @Override
+    public boolean hasAccessibilityInformation() {
+        return delegate.hasAccessibilityInformation();
+    }
+
+    @Override
+    public boolean hasBikeInformation() {
+        return delegate.hasBikeInformation();
+    }
+
+    @Override
+    public boolean hasTravelModeInformation() {
+        return delegate.hasTravelModeInformation();
+    }
+
     @Override
     public List<Stop> getStops(String like, SearchType searchType) {
         return delegate.getStops(like, searchType);

src/main/java/ch/naviqore/raptor/QueryConfig.java

@@ -2,6 +2,9 @@
 
 import lombok.Getter;
 import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+import java.util.EnumSet;
 
 /**
  * Configuration to query connections or iso-lines. Default values are set to infinity or zero, which means that no
@@ -18,12 +21,23 @@ public class QueryConfig {
     private int maximumTransferNumber = INFINITY;
     private int maximumTravelTime = INFINITY;
 
+    @Setter
+    private boolean wheelchairAccessible = false;
+    @Setter
+    private boolean bikeAccessible = false;
+    @Setter
+    private EnumSet<TravelMode> allowedTravelModes = EnumSet.allOf(TravelMode.class);
+
     public QueryConfig(int maximumWalkingDuration, int minimumTransferDuration, int maximumTransferNumber,
-                       int maximumTravelTime) {
+                       int maximumTravelTime, boolean wheelchairAccessible, boolean bikeAccessible,
+                       EnumSet<TravelMode> allowedTravelModes) {
         this.setMaximumWalkingDuration(maximumWalkingDuration);
         this.setMinimumTransferDuration(minimumTransferDuration);
         this.setMaximumTransferNumber(maximumTransferNumber);
         this.setMaximumTravelTime(maximumTravelTime);
+        this.setWheelchairAccessible(wheelchairAccessible);
+        this.setBikeAccessible(bikeAccessible);
+        this.setAllowedTravelModes(allowedTravelModes);
     }
 
     public void setMaximumWalkingDuration(int maximumWalkingDuration) {

src/main/java/ch/naviqore/raptor/TravelMode.java

@@ -0,0 +1,11 @@
+package ch.naviqore.raptor;
+
+public enum TravelMode {
+    BUS,
+    TRAM,
+    RAIL,
+    SHIP,
+    SUBWAY,
+    AERIAL_LIFT,
+    FUNICULAR,
+}

src/main/java/ch/naviqore/raptor/router/Query.java

@@ -70,7 +70,7 @@ class Query {
         // set up footpath relaxer and route scanner and inject stop labels and times
         footpathRelaxer = new FootpathRelaxer(queryState, raptorData, config.getMinimumTransferDuration(),
                 config.getMaximumWalkingDuration(), timeType);
-        routeScanner = new RouteScanner(queryState, raptorData, config.getMinimumTransferDuration(), timeType,
+        routeScanner = new RouteScanner(queryState, raptorData, config, timeType,
                 referenceDate, raptorConfig.getDaysToScan());
     }
 

src/main/java/ch/naviqore/raptor/router/RaptorConfig.java

@@ -1,5 +1,6 @@
 package ch.naviqore.raptor.router;
 
+import ch.naviqore.raptor.QueryConfig;
 import ch.naviqore.utils.cache.EvictionCache;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
@@ -80,7 +81,7 @@ public String getServiceIdForDate(LocalDate date) {
         }
 
         @Override
-        public DayTripMask getDayTripMask(LocalDate date) {
+        public DayTripMask getDayTripMask(LocalDate date, QueryConfig queryConfig) {
             Map<String, RouteTripMask> tripMasks = new HashMap<>();
             for (Map.Entry<String, String[]> entry : tripIds.entrySet()) {
                 String routeId = entry.getKey();

src/main/java/ch/naviqore/raptor/router/RaptorRouter.java

@@ -49,7 +49,7 @@ class RaptorRouter implements RaptorAlgorithm, RaptorData {
 
     @Override
     public void prepareStopTimesForDate(LocalDate date) {
-        stopTimeProvider.getStopTimesForDate(date);
+        stopTimeProvider.getStopTimesForDate(date, new QueryConfig());
     }
 
     @Override

src/main/java/ch/naviqore/raptor/router/RaptorTripMaskProvider.java

@@ -1,5 +1,7 @@
 package ch.naviqore.raptor.router;
 
+import ch.naviqore.raptor.QueryConfig;
+
 import java.time.LocalDate;
 import java.util.Map;
 
@@ -32,14 +34,15 @@ public interface RaptorTripMaskProvider {
     String getServiceIdForDate(LocalDate date);
 
     /**
-     * Get the trip mask for a given date.
+     * Get the trip mask for a given date and query config.
      * <p>
-     * This method should return a map of route ids to trip masks for the given date.
+     * This method should return a map of route ids to trip masks for the given date and query config.
      *
-     * @param date the date for which the trip mask should be returned.
+     * @param date        the date for which the trip mask should be returned.
+     * @param queryConfig the query config for which the trip mask should be returned.
      * @return the raptor day mask of the day.
      */
-    DayTripMask getDayTripMask(LocalDate date);
+    DayTripMask getDayTripMask(LocalDate date, QueryConfig queryConfig);
 
     /**
      * This represents a service day trip mask for a given day.