org.opentripplanner.routing.graphfinder.GraphFinder Maven / Gradle / Ivy

Go to download

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

The OpenTripPlanner multimodal journey planning system

There is a newer version: 2.6.0

package org.opentripplanner.routing.graphfinder;

import org.opentripplanner.model.FeedScopedId;
import org.opentripplanner.model.TransitMode;
import org.opentripplanner.routing.RoutingService;
import org.opentripplanner.routing.graph.Graph;

import java.util.List;

/**
 * Common interface between different types of GraphFinders, currently two types exist, one which
 * traverses the street network, and one which doesn't.
 */
public interface GraphFinder {

  /**
   * Search closest stops from a given coordinate, extending up to a specified max radius.
   *
   * @param lat Origin latitude
   * @param lon Origin longitude
   * @param radiusMeters Search radius from the origin in meters
   */
  List findClosestStops(double lat, double lon, double radiusMeters);

  /**
   * Search closest places, including stops, bike rental stations, bike and car parking etc, from a
   * given coordinate, extending up to a specified max radius.
   *
   * @param lat Origin latitude
   * @param lon Origin longitude
   * @param radiusMeters Search radius from the origin in meters
   * @param maxResults Maximum number of results to return within the search radius.
   * @param filterByModes A list of TransitModes for which to find Stops and PatternAtStops. Use null to disable the filtering.
   * @param filterByPlaceTypes A list of PlaceTypes to search for. Use null to disable the filtering, and search for all types.
   * @param filterByStops A list of Stop ids for which to find Stops and PatternAtStops. Use null to disable the filtering.
   * @param filterByRoutes A list of Route ids used for filtering Stops. Only the stops which are served by the route are returned. Use null to disable the filtering.
   * @param filterByBikeRentalStations A list of BikeRentalStation ids to use in filtering. Use null to disable the filtering.
   * @param filterByBikeParks A list of BikePark ids to use in filtering. Use null to disable the filtering.
   * @param filterByCarParks A list of CarPark ids to use in filtering. Use null to disable the filtering.
   * @param routingService A RoutingService used in finding information about the various places.
   */
  List findClosestPlaces(
      double lat, double lon, double radiusMeters, int maxResults, List filterByModes,
      List filterByPlaceTypes, List filterByStops,
      List filterByRoutes, List filterByBikeRentalStations,
      List filterByBikeParks, List filterByCarParks, RoutingService routingService
  );

  /**
   * Get a new GraphFinder instance depending on whether the graph includes a street network or not.
   */
  static GraphFinder getInstance(Graph graph) {
    return graph.hasStreets ? new StreetGraphFinder(graph) : new DirectGraphFinder(graph);
  }
}