org.opentripplanner.standalone.config.buildconfig.TransferRequestConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of application Show documentation

The newest version!

package org.opentripplanner.standalone.config.buildconfig;

import static org.opentripplanner.standalone.config.framework.json.OtpVersion.V2_1;

import java.util.List;
import org.opentripplanner.routing.api.request.RouteRequest;
import org.opentripplanner.standalone.config.framework.json.NodeAdapter;
import org.opentripplanner.standalone.config.routerequest.RouteRequestConfig;

public class TransferRequestConfig {

  public static List map(NodeAdapter root, String transferRequestsName) {
    return root
      .of(transferRequestsName)
      .since(V2_1)
      .summary("Routing requests to use for pre-calculating stop-to-stop transfers.")
      .description(
        """
        It will use the street network if OSM data has already been loaded into the graph. Otherwise it
        will use straight-line distance between stops.

        If not set, the default behavior is to generate stop-to-stop transfers using the default request
        with street mode set to WALK. Use this to change the default or specify more than one way to
        transfer.

        **Example**

        ```JSON
        // build-config.json
        {
          "transferRequests": [
            { "modes": "WALK" },
            { "modes": "WALK", "wheelchairAccessibility": { "enabled": true }}
          ]
        }
        ```
        """
      )
      .asObjects(List.of(new RouteRequest()), RouteRequestConfig::mapRouteRequest);
  }
}