org.opentripplanner.routing.graph

Class GraphIndex

java.lang.Object

org.opentripplanner.routing.graph.GraphIndex

public class GraphIndex
extends Object

This class contains all the transient indexes of graph elements -- those that are not serialized with the graph. Caching these maps is essentially an optimization, but a big one. The index is bootstrapped from the graph's list of edges.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GraphIndex.StopAndDistance

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Map<String,Agency>>	agenciesForFeedId
Map<String,FeedInfo>	feedInfoForId
Map<FeedScopedId,org.locationtech.jts.geom.Geometry>	flexAreasById
Graph	graph
graphql.GraphQL	graphQL
LuceneIndex	luceneIndex
static int	MAX_WALK_METERS maximum distance to walk after leaving transit in Analyst
int	overnightBreak Used for finding first/last trip of the day.
Map<String,TripPattern>	patternForId
Map<Trip,TripPattern>	patternForTrip
com.google.common.collect.Multimap<String,TripPattern>	patternsForFeedId
com.google.common.collect.Multimap<Route,TripPattern>	patternsForRoute
com.google.common.collect.Multimap<Stop,TripPattern>	patternsForStop
Map<FeedScopedId,Route>	routeForId
Map<FeedScopedId,String>	serviceForId
Map<String,StopCluster>	stopClusterForId
Map<Stop,StopCluster>	stopClusterForStop
Map<FeedScopedId,Stop>	stopForId
com.google.common.collect.Multimap<String,Stop>	stopsForParentStation
Map<Stop,TransitStop>	stopVertexForStop
com.google.common.collect.Multimap<StopCluster,ProfileTransfer>	transfersFromStopCluster
Map<FeedScopedId,Trip>	tripForId
Map<String,Vertex>	vertexForId

Constructor Summary

Constructors

Constructor and Description
GraphIndex(Graph graph)

Method Summary

Modifier and Type	Method and Description
void	clusterStopsAsNeeded() Stop clustering is slow to perform and only used in profile routing for the moment.
Timetable	currentUpdatedTimetableForTripPattern(TripPattern tripPattern) Get the most up-to-date timetable for the given TripPattern, as of right now.
List<GraphIndex.StopAndDistance>	findClosestStopsByWalking(double lat, double lon, int radius)
Map<StopCluster,Double>	findNearbyStopClusters(StopCluster sc, double radius) Find transfer candidates for profile routing.
Agency	getAgencyWithoutFeedId(String agencyId) Fetch an agency by its string ID, ignoring the fact that this ID should be scoped by a feedId.
Set<Agency>	getAllAgencies() Construct a set of all Agencies in this graph, spanning across all feed IDs.
javax.ws.rs.core.Response	getGraphQLResponse(String query, Map<String,Object> variables, String operationName)
List<StopTimesInPattern>	getStopTimesForStop(Stop stop, ServiceDate serviceDate, boolean omitNonPickups) Get a list of all trips that pass through a stop during a single ServiceDate.
StopTreeCache	getStopTreeCache() Fetch a cache of nearby intersection distances for every transit stop in this graph, lazy-building as needed.
void	initializeProfileTransfers() Initialize transfer data needed for profile routing.
Set<Route>	routesForStop(Stop stop) Dynamically generate the set of Routes passing though a Stop on demand.
BitSet	servicesRunning(org.joda.time.LocalDate date) Wraps the other servicesRunning whose parameter is an OBA ServiceDate.
BitSet	servicesRunning(ServiceDate date) An OBA Service Date is a local date without timezone, only year month and day.
Collection<StopTimesInPattern>	stopTimesForStop(Stop stop, boolean omitNonPickups) Fetch upcoming vehicle departures from a stop.
List<StopTimesInPattern>	stopTimesForStop(Stop stop, long startTime, int timeRange, int numberOfDepartures, boolean omitNonPickups) Fetch upcoming vehicle departures from a stop.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAX_WALK_METERS

public static final int MAX_WALK_METERS

maximum distance to walk after leaving transit in Analyst

See Also:

Constant Field Values

vertexForId

public final Map<String,Vertex> vertexForId

agenciesForFeedId

public final Map<String,Map<String,Agency>> agenciesForFeedId

feedInfoForId

public final Map<String,FeedInfo> feedInfoForId

stopForId

public final Map<FeedScopedId,Stop> stopForId

tripForId

public final Map<FeedScopedId,Trip> tripForId

routeForId

public final Map<FeedScopedId,Route> routeForId

serviceForId

public final Map<FeedScopedId,String> serviceForId

patternForId

public final Map<String,TripPattern> patternForId

stopVertexForStop

public final Map<Stop,TransitStop> stopVertexForStop

patternForTrip

public final Map<Trip,TripPattern> patternForTrip

patternsForFeedId

public final com.google.common.collect.Multimap<String,TripPattern> patternsForFeedId

patternsForRoute

public final com.google.common.collect.Multimap<Route,TripPattern> patternsForRoute

patternsForStop

public final com.google.common.collect.Multimap<Stop,TripPattern> patternsForStop

stopsForParentStation

public final com.google.common.collect.Multimap<String,Stop> stopsForParentStation

stopClusterForStop

public final Map<Stop,StopCluster> stopClusterForStop

stopClusterForId

public final Map<String,StopCluster> stopClusterForId

flexAreasById

public final Map<FeedScopedId,org.locationtech.jts.geom.Geometry> flexAreasById

luceneIndex

public LuceneIndex luceneIndex

transfersFromStopCluster

public com.google.common.collect.Multimap<StopCluster,ProfileTransfer> transfersFromStopCluster

graph

public Graph graph

overnightBreak

public final int overnightBreak

Used for finding first/last trip of the day. This is the time at which service ends for the day.

See Also:

Constant Field Values

graphQL

public graphql.GraphQL graphQL

Constructor Detail

GraphIndex

public GraphIndex(Graph graph)

Method Detail

clusterStopsAsNeeded

public void clusterStopsAsNeeded()

Stop clustering is slow to perform and only used in profile routing for the moment. Therefore it is not done automatically, and any method requiring stop clusters should call this method to ensure that the necessary indexes are lazy-initialized.

initializeProfileTransfers

public void initializeProfileTransfers()

Initialize transfer data needed for profile routing. Find the best transfers between each pair of patterns that pass near one another.

findNearbyStopClusters

public Map<StopCluster,Double> findNearbyStopClusters(StopCluster sc,
                                                      double radius)

Find transfer candidates for profile routing. TODO replace with an on-street search using the existing profile router functions.

findClosestStopsByWalking

public List<GraphIndex.StopAndDistance> findClosestStopsByWalking(double lat,
                                                                  double lon,
                                                                  int radius)

servicesRunning

public BitSet servicesRunning(ServiceDate date)

An OBA Service Date is a local date without timezone, only year month and day.

servicesRunning

public BitSet servicesRunning(org.joda.time.LocalDate date)

Wraps the other servicesRunning whose parameter is an OBA ServiceDate. Joda LocalDate is a similar class.

routesForStop

public Set<Route> routesForStop(Stop stop)

Dynamically generate the set of Routes passing though a Stop on demand.

stopTimesForStop

public Collection<StopTimesInPattern> stopTimesForStop(Stop stop,
                                                       boolean omitNonPickups)

Fetch upcoming vehicle departures from a stop. Fetches two departures for each pattern during the next 24 hours as default

stopTimesForStop

public List<StopTimesInPattern> stopTimesForStop(Stop stop,
                                                 long startTime,
                                                 int timeRange,
                                                 int numberOfDepartures,
                                                 boolean omitNonPickups)

Fetch upcoming vehicle departures from a stop. It goes though all patterns passing the stop for the previous, current and next service date. It uses a priority queue to keep track of the next departures. The queue is shared between all dates, as services from the previous service date can visit the stop later than the current service date's services. This happens eg. with sleeper trains. TODO: Add frequency based trips

Parameters:

stop - Stop object to perform the search for

startTime - Start time for the search. Seconds from UNIX epoch

timeRange - Searches forward for timeRange seconds from startTime

numberOfDepartures - Number of departures to fetch per pattern

omitNonPickups - If true, do not include vehicles that will not pick up passengers.

Returns:

getStopTimesForStop

public List<StopTimesInPattern> getStopTimesForStop(Stop stop,
                                                    ServiceDate serviceDate,
                                                    boolean omitNonPickups)

Get a list of all trips that pass through a stop during a single ServiceDate. Useful when creating complete stop timetables for a single day.

Parameters:

stop - Stop object to perform the search for

serviceDate - Return all departures for the specified date

Returns:

getStopTreeCache

public StopTreeCache getStopTreeCache()

Fetch a cache of nearby intersection distances for every transit stop in this graph, lazy-building as needed.

currentUpdatedTimetableForTripPattern

public Timetable currentUpdatedTimetableForTripPattern(TripPattern tripPattern)

Get the most up-to-date timetable for the given TripPattern, as of right now. There should probably be a less awkward way to do this that just gets the latest entry from the resolver without making a fake routing request.

getGraphQLResponse

public javax.ws.rs.core.Response getGraphQLResponse(String query,
                                                    Map<String,Object> variables,
                                                    String operationName)

getAgencyWithoutFeedId

public Agency getAgencyWithoutFeedId(String agencyId)

Fetch an agency by its string ID, ignoring the fact that this ID should be scoped by a feedId. This is a stopgap (i.e. hack) method for fetching agencies where no feed scope is available. I am creating this method only to allow merging pull request #2032 which adds GraphQL. Note that if the same agency ID is defined in several feeds, this will return one of them at random. That is obviously not the right behavior. The problem is that agencies are not currently keyed on an FeedScopedId object, but on separate feedId and id Strings. A real fix will involve replacing or heavily modifying the OBA GTFS loader, which is now possible since we have forked it.

getAllAgencies

public Set<Agency> getAllAgencies()

Construct a set of all Agencies in this graph, spanning across all feed IDs. I am creating this method only to allow merging pull request #2032 which adds GraphQL. This should probably be done some other way, see javadoc on getAgencyWithoutFeedId.