org.opentripplanner.index.IndexAPI Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation
Show all versions of otp Show documentation
The OpenTripPlanner multimodal journey planning system
/* This program is free software: you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License
as published by the Free Software Foundation, either version 3 of
the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see routes = index.routeForId.values();
Agency agency = index.agenciesForFeedId.get(feedId).get(agencyId);
if (agency == null) return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
Collection agencyRoutes = new ArrayList<>();
for (Route route: routes) {
if (route.getAgency() == agency) {
agencyRoutes.add(route);
}
}
routes = agencyRoutes;
if (detail){
return Response.status(Status.OK).entity(routes).build();
}
else {
return Response.status(Status.OK).entity(RouteShort.list(routes)).build();
}
}
/** Return specific transit stop in the graph, by ID. */
@GET
@Path("/stops/{stopId}")
public Response getStop (@PathParam("stopId") String stopIdString) {
AgencyAndId stopId = GtfsLibrary.convertIdFromString(stopIdString);
Stop stop = index.stopForId.get(stopId);
if (stop != null) {
return Response.status(Status.OK).entity(stop).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
/** Return a list of all stops within a circle around the given coordinate. */
@GET
@Path("/stops")
public Response getStopsInRadius (
@QueryParam("minLat") Double minLat,
@QueryParam("minLon") Double minLon,
@QueryParam("maxLat") Double maxLat,
@QueryParam("maxLon") Double maxLon,
@QueryParam("lat") Double lat,
@QueryParam("lon") Double lon,
@QueryParam("radius") Double radius) {
/* When no parameters are supplied, return all stops. */
if (uriInfo.getQueryParameters().isEmpty()) {
Collection stops = index.stopForId.values();
return Response.status(Status.OK).entity(StopShort.list(stops)).build();
}
/* If any of the circle parameters are specified, expect a circle not a box. */
boolean expectCircle = (lat != null || lon != null || radius != null);
if (expectCircle) {
if (lat == null || lon == null || radius == null || radius < 0) {
return Response.status(Status.BAD_REQUEST).entity(MSG_400).build();
}
if (radius > MAX_STOP_SEARCH_RADIUS){
radius = MAX_STOP_SEARCH_RADIUS;
}
List stops = Lists.newArrayList();
Coordinate coord = new Coordinate(lon, lat);
for (TransitStop stopVertex : streetIndex.getNearbyTransitStops(
new Coordinate(lon, lat), radius)) {
double distance = SphericalDistanceLibrary.fastDistance(stopVertex.getCoordinate(), coord);
if (distance < radius) {
stops.add(new StopShort(stopVertex.getStop(), (int) distance));
}
}
return Response.status(Status.OK).entity(stops).build();
} else {
/* We're not circle mode, we must be in box mode. */
if (minLat == null || minLon == null || maxLat == null || maxLon == null) {
return Response.status(Status.BAD_REQUEST).entity(MSG_400).build();
}
if (maxLat <= minLat || maxLon <= minLon) {
return Response.status(Status.BAD_REQUEST).entity(MSG_400).build();
}
List stops = Lists.newArrayList();
Envelope envelope = new Envelope(new Coordinate(minLon, minLat), new Coordinate(maxLon, maxLat));
for (TransitStop stopVertex : streetIndex.getTransitStopForEnvelope(envelope)) {
stops.add(new StopShort(stopVertex.getStop()));
}
return Response.status(Status.OK).entity(stops).build();
}
}
@GET
@Path("/stops/{stopId}/routes")
public Response getRoutesForStop (@PathParam("stopId") String stopId) {
Stop stop = index.stopForId.get(GtfsLibrary.convertIdFromString(stopId));
if (stop == null) return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
Set routes = Sets.newHashSet();
for (TripPattern pattern : index.patternsForStop.get(stop)) {
routes.add(pattern.route);
}
return Response.status(Status.OK).entity(RouteShort.list(routes)).build();
}
@GET
@Path("/stops/{stopId}/patterns")
public Response getPatternsForStop (@PathParam("stopId") String stopIdString) {
AgencyAndId id = GtfsLibrary.convertIdFromString(stopIdString);
Stop stop = index.stopForId.get(id);
if (stop == null) return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
Collection patterns = index.patternsForStop.get(stop);
return Response.status(Status.OK).entity(PatternShort.list(patterns)).build();
}
/** Return upcoming vehicle arrival/departure times at the given stop.
*
* @param stopIdString Stop ID in Agency:Stop ID format
* @param startTime Start time for the search. Seconds from UNIX epoch
* @param timeRange Searches forward for timeRange seconds from startTime
* @param numberOfDepartures Number of departures to fetch per pattern
*/
@GET
@Path("/stops/{stopId}/stoptimes")
public Response getStoptimesForStop (@PathParam("stopId") String stopIdString,
@QueryParam("startTime") long startTime,
@QueryParam("timeRange") @DefaultValue("86400") int timeRange,
@QueryParam("numberOfDepartures") @DefaultValue("2") int numberOfDepartures,
@QueryParam("omitNonPickups") boolean omitNonPickups) {
Stop stop = index.stopForId.get(GtfsLibrary.convertIdFromString(stopIdString));
if (stop == null) return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
return Response.status(Status.OK).entity(index.stopTimesForStop(stop, startTime, timeRange, numberOfDepartures, omitNonPickups )).build();
}
/**
* Return upcoming vehicle arrival/departure times at the given stop.
* @param date in YYYYMMDD format
*/
@GET
@Path("/stops/{stopId}/stoptimes/{date}")
public Response getStoptimesForStopAndDate (@PathParam("stopId") String stopIdString,
@PathParam("date") String date,
@QueryParam("omitNonPickups") boolean omitNonPickups) {
Stop stop = index.stopForId.get(GtfsLibrary.convertIdFromString(stopIdString));
if (stop == null) return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
ServiceDate sd;
try {
sd = ServiceDate.parseString(date);
}
catch (ParseException e){
return Response.status(Status.BAD_REQUEST).entity(MSG_400).build();
}
List ret = index.getStopTimesForStop(stop, sd, omitNonPickups);
return Response.status(Status.OK).entity(ret).build();
}
/**
* Return the generated transfers a stop in the graph, by stop ID
*/
@GET
@Path("/stops/{stopId}/transfers")
public Response getTransfers(@PathParam("stopId") String stopIdString) {
Stop stop = index.stopForId.get(GtfsLibrary.convertIdFromString(stopIdString));
if (stop != null) {
// get the transfers for the stop
TransitStop v = index.stopVertexForStop.get(stop);
Collection transfers = Collections2.filter(v.getOutgoing(), new Predicate() {
@Override
public boolean apply(Edge edge) {
return edge instanceof SimpleTransfer;
}
});
Collection out = Collections2.transform(transfers, new Function () {
@Override
public Transfer apply(Edge edge) {
// TODO Auto-generated method stub
return new Transfer((SimpleTransfer) edge);
}
});
return Response.status(Status.OK).entity(out).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
/** Return a list of all routes in the graph. */
// with repeated hasStop parameters, replaces old routesBetweenStops
@GET
@Path("/routes")
public Response getRoutes (@QueryParam("hasStop") List stopIds) {
Collection routes = index.routeForId.values();
// Filter routes to include only those that pass through all given stops
if (stopIds != null) {
// Protective copy, we are going to calculate the intersection destructively
routes = Lists.newArrayList(routes);
for (String stopId : stopIds) {
Stop stop = index.stopForId.get(GtfsLibrary.convertIdFromString(stopId));
if (stop == null) return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
Set routesHere = Sets.newHashSet();
for (TripPattern pattern : index.patternsForStop.get(stop)) {
routesHere.add(pattern.route);
}
routes.retainAll(routesHere);
}
}
return Response.status(Status.OK).entity(RouteShort.list(routes)).build();
}
/** Return specific route in the graph, for the given ID. */
@GET
@Path("/routes/{routeId}")
public Response getRoute (@PathParam("routeId") String routeIdString) {
AgencyAndId routeId = GtfsLibrary.convertIdFromString(routeIdString);
Route route = index.routeForId.get(routeId);
if (route != null) {
return Response.status(Status.OK).entity(route).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
/** Return all stop patterns used by trips on the given route. */
@GET
@Path("/routes/{routeId}/patterns")
public Response getPatternsForRoute (@PathParam("routeId") String routeIdString) {
AgencyAndId routeId = GtfsLibrary.convertIdFromString(routeIdString);
Route route = index.routeForId.get(routeId);
if (route != null) {
Collection patterns = index.patternsForRoute.get(route);
return Response.status(Status.OK).entity(PatternShort.list(patterns)).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
/** Return all stops in any pattern on a given route. */
@GET
@Path("/routes/{routeId}/stops")
public Response getStopsForRoute (@PathParam("routeId") String routeIdString) {
AgencyAndId routeId = GtfsLibrary.convertIdFromString(routeIdString);
Route route = index.routeForId.get(routeId);
if (route != null) {
Set stops = Sets.newHashSet();
Collection patterns = index.patternsForRoute.get(route);
for (TripPattern pattern : patterns) {
stops.addAll(pattern.getStops());
}
return Response.status(Status.OK).entity(StopShort.list(stops)).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
/** Return all trips in any pattern on the given route. */
@GET
@Path("/routes/{routeId}/trips")
public Response getTripsForRoute (@PathParam("routeId") String routeIdString) {
AgencyAndId routeId = GtfsLibrary.convertIdFromString(routeIdString);
Route route = index.routeForId.get(routeId);
if (route != null) {
List trips = Lists.newArrayList();
Collection patterns = index.patternsForRoute.get(route);
for (TripPattern pattern : patterns) {
trips.addAll(pattern.getTrips());
}
return Response.status(Status.OK).entity(TripShort.list(trips)).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
// Not implemented, results would be too voluminous.
// @Path("/trips")
@GET
@Path("/trips/{tripId}")
public Response getTrip (@PathParam("tripId") String tripIdString) {
AgencyAndId tripId = GtfsLibrary.convertIdFromString(tripIdString);
Trip trip = index.tripForId.get(tripId);
if (trip != null) {
return Response.status(Status.OK).entity(trip).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
@GET
@Path("/trips/{tripId}/stops")
public Response getStopsForTrip (@PathParam("tripId") String tripIdString) {
AgencyAndId tripId = GtfsLibrary.convertIdFromString(tripIdString);
Trip trip = index.tripForId.get(tripId);
if (trip != null) {
TripPattern pattern = index.patternForTrip.get(trip);
Collection stops = pattern.getStops();
return Response.status(Status.OK).entity(StopShort.list(stops)).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
@GET
@Path("/trips/{tripId}/semanticHash")
public Response getSemanticHashForTrip (@PathParam("tripId") String tripIdString) {
AgencyAndId tripId = GtfsLibrary.convertIdFromString(tripIdString);
Trip trip = index.tripForId.get(tripId);
if (trip != null) {
TripPattern pattern = index.patternForTrip.get(trip);
String hashString = pattern.semanticHashString(trip);
return Response.status(Status.OK).entity(hashString).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
@GET
@Path("/trips/{tripId}/stoptimes")
public Response getStoptimesForTrip (@PathParam("tripId") String tripIdString) {
AgencyAndId tripId = GtfsLibrary.convertIdFromString(tripIdString);
Trip trip = index.tripForId.get(tripId);
if (trip != null) {
TripPattern pattern = index.patternForTrip.get(trip);
// Note, we need the updated timetable not the scheduled one (which contains no real-time updates).
Timetable table = index.currentUpdatedTimetableForTripPattern(pattern);
return Response.status(Status.OK).entity(TripTimeShort.fromTripTimes(table, trip)).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
/** Return geometry for the trip as a packed coordinate sequence */
@GET
@Path("/trips/{tripId}/geometry")
public Response getGeometryForTrip (@PathParam("tripId") String tripIdString) {
AgencyAndId tripId = GtfsLibrary.convertIdFromString(tripIdString);
Trip trip = index.tripForId.get(tripId);
if (trip != null) {
TripPattern tripPattern = index.patternForTrip.get(trip);
return getGeometryForPattern(tripPattern.code);
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
@GET
@Path("/patterns")
public Response getPatterns () {
Collection patterns = index.patternForId.values();
return Response.status(Status.OK).entity(PatternShort.list(patterns)).build();
}
@GET
@Path("/patterns/{patternId}")
public Response getPattern (@PathParam("patternId") String patternIdString) {
TripPattern pattern = index.patternForId.get(patternIdString);
if (pattern != null) {
return Response.status(Status.OK).entity(new PatternDetail(pattern)).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
@GET
@Path("/patterns/{patternId}/trips")
public Response getTripsForPattern (@PathParam("patternId") String patternIdString) {
TripPattern pattern = index.patternForId.get(patternIdString);
if (pattern != null) {
List trips = pattern.getTrips();
return Response.status(Status.OK).entity(TripShort.list(trips)).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
@GET
@Path("/patterns/{patternId}/stops")
public Response getStopsForPattern (@PathParam("patternId") String patternIdString) {
// Pattern names are graph-unique because we made them that way (did not read them from GTFS).
TripPattern pattern = index.patternForId.get(patternIdString);
if (pattern != null) {
List stops = pattern.getStops();
return Response.status(Status.OK).entity(StopShort.list(stops)).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
@GET
@Path("/patterns/{patternId}/semanticHash")
public Response getSemanticHashForPattern (@PathParam("patternId") String patternIdString) {
// Pattern names are graph-unique because we made them that way (did not read them from GTFS).
TripPattern pattern = index.patternForId.get(patternIdString);
if (pattern != null) {
String semanticHash = pattern.semanticHashString(null);
return Response.status(Status.OK).entity(semanticHash).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
/** Return geometry for the pattern as a packed coordinate sequence */
@GET
@Path("/patterns/{patternId}/geometry")
public Response getGeometryForPattern (@PathParam("patternId") String patternIdString) {
TripPattern pattern = index.patternForId.get(patternIdString);
if (pattern != null) {
EncodedPolylineBean geometry = PolylineEncoder.createEncodings(pattern.geometry);
return Response.status(Status.OK).entity(geometry).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
// TODO include pattern ID for each trip in responses
/**
* List basic information about all service IDs.
* This is a placeholder endpoint and is not implemented yet.
*/
@GET
@Path("/services")
public Response getServices() {
// TODO complete: index.serviceForId.values();
return Response.status(Status.OK).entity("NONE").build();
}
/**
* List details about a specific service ID including which dates it runs on. Replaces the old /calendar.
* This is a placeholder endpoint and is not implemented yet.
*/
@GET
@Path("/services/{serviceId}")
public Response getServices(@PathParam("serviceId") String serviceId) {
// TODO complete: index.serviceForId.get(serviceId);
return Response.status(Status.OK).entity("NONE").build();
}
/**
* Return all clusters of stops.
* A cluster is not the same thing as a GTFS parent station.
* Clusters are an unsupported experimental feature that was added to assist in "profile routing".
* As such the stop clustering method probably only works right with one or two GTFS data sets in the world.
*/
@GET
@Path("/clusters")
public Response getAllStopClusters () {
index.clusterStopsAsNeeded();
// use 'detail' field common to all API methods in this class
List scl = StopClusterDetail.list(index.stopClusterForId.values(), detail);
return Response.status(Status.OK).entity(scl).build();
}
/**
* Return a cluster of stops by its ID.
* A cluster is not the same thing as a GTFS parent station.
* Clusters are an unsupported experimental feature that was added to assist in "profile routing".
* As such the stop clustering method probably only works right with one or two GTFS data sets in the world.
*/
@GET
@Path("/clusters/{clusterId}")
public Response getStopCluster (@PathParam("clusterId") String clusterIdString) {
index.clusterStopsAsNeeded();
StopCluster cluster = index.stopClusterForId.get(clusterIdString);
if (cluster != null) {
return Response.status(Status.OK).entity(new StopClusterDetail(cluster, true)).build();
} else {
return Response.status(Status.NOT_FOUND).entity(MSG_404).build();
}
}
@POST
@Path("/graphql")
@Consumes(MediaType.APPLICATION_JSON)
public Response getGraphQL (HashMap queryParameters) {
String query = (String) queryParameters.get("query");
Object queryVariables = queryParameters.getOrDefault("variables", null);
String operationName = (String) queryParameters.getOrDefault("operationName", null);
Map variables;
if (queryVariables instanceof Map) {
variables = (Map) queryVariables;
} else if (queryVariables instanceof String && !((String) queryVariables).isEmpty()) {
try {
variables = deserializer.readValue((String) queryVariables, Map.class);
} catch (IOException e) {
LOG.error("Variables must be a valid json object");
return Response.status(Status.BAD_REQUEST).entity(MSG_400).build();
}
} else {
variables = new HashMap<>();
}
return index.getGraphQLResponse(query, variables, operationName);
}
@POST
@Path("/graphql")
@Consumes("application/graphql")
public Response getGraphQL (String query) {
return index.getGraphQLResponse(query, new HashMap<>(), null);
}
/** Represents a transfer from a stop */
private static class Transfer {
/** The stop we are connecting to */
public String toStopId;
/** the on-street distance of the transfer (meters) */
public double distance;
/** Make a transfer from a simpletransfer edge from the graph. */
public Transfer(SimpleTransfer e) {
toStopId = GtfsLibrary.convertIdToString(((TransitStop) e.getToVertex()).getStopId());
distance = e.getDistance();
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy