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.

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,org.onebusaway.gtfs.model.Agency>	agencyForId
Graph	graph
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<org.onebusaway.gtfs.model.Trip,TripPattern>	patternForTrip
com.google.common.collect.Multimap<org.onebusaway.gtfs.model.Agency,TripPattern>	patternsForAgency
com.google.common.collect.Multimap<org.onebusaway.gtfs.model.Route,TripPattern>	patternsForRoute
com.google.common.collect.Multimap<org.onebusaway.gtfs.model.Stop,TripPattern>	patternsForStop
Map<org.onebusaway.gtfs.model.AgencyAndId,org.onebusaway.gtfs.model.Route>	routeForId
Map<String,org.onebusaway.gtfs.model.Route>	routeForIdWithoutAgency
Map<org.onebusaway.gtfs.model.AgencyAndId,String>	serviceForId
Map<String,StopCluster>	stopClusterForId
Map<org.onebusaway.gtfs.model.Stop,StopCluster>	stopClusterForStop
Map<org.onebusaway.gtfs.model.AgencyAndId,org.onebusaway.gtfs.model.Stop>	stopForId
Map<String,org.onebusaway.gtfs.model.Stop>	stopForIdWithoutAgency
com.google.common.collect.Multimap<String,org.onebusaway.gtfs.model.Stop>	stopsForParentStation
Map<org.onebusaway.gtfs.model.Stop,TransitStop>	stopVertexForStop
com.google.common.collect.Multimap<StopCluster,ProfileTransfer>	transfersFromStopCluster
Map<org.onebusaway.gtfs.model.AgencyAndId,org.onebusaway.gtfs.model.Trip>	tripForId
Map<String,org.onebusaway.gtfs.model.Trip>	tripForIdWithoutAgency
Map<String,Vertex>	vertexForId

Constructor Summary

Constructors

Constructor and Description
GraphIndex(Graph graph)

Method Summary

Modifier and Type	Method and Description
void	clusterStops() FIXME OBA parentStation field is a string, not an AgencyAndId, so it has no agency/feed scope But the DC regional graph has no parent stations pre-defined, so no use dealing with them for now.
void	clusterStopsAsNeeded() Stop clustering is slow to perform and only used in profile routing for the moment.
Map<StopCluster,Double>	findNearbyStopClusters(StopCluster sc, double radius) Find transfer candidates for profile routing.
List<StopTimesInPattern>	getStopTimesForStop(org.onebusaway.gtfs.model.Stop stop, org.onebusaway.gtfs.model.calendar.ServiceDate serviceDate) 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<org.onebusaway.gtfs.model.Route>	routesForStop(org.onebusaway.gtfs.model.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(org.onebusaway.gtfs.model.calendar.ServiceDate date) An OBA Service Date is a local date without timezone, only year month and day.
Collection<StopTimesInPattern>	stopTimesForStop(org.onebusaway.gtfs.model.Stop stop) Fetch upcoming vehicle departures from a stop.
List<StopTimesInPattern>	stopTimesForStop(org.onebusaway.gtfs.model.Stop stop, long startTime, int timeRange, int numberOfDepartures) 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

agencyForId

public final Map<String,org.onebusaway.gtfs.model.Agency> agencyForId

stopForId

public final Map<org.onebusaway.gtfs.model.AgencyAndId,org.onebusaway.gtfs.model.Stop> stopForId

tripForId

public final Map<org.onebusaway.gtfs.model.AgencyAndId,org.onebusaway.gtfs.model.Trip> tripForId

routeForId

public final Map<org.onebusaway.gtfs.model.AgencyAndId,org.onebusaway.gtfs.model.Route> routeForId

serviceForId

public final Map<org.onebusaway.gtfs.model.AgencyAndId,String> serviceForId

patternForId

public final Map<String,TripPattern> patternForId

stopVertexForStop

public final Map<org.onebusaway.gtfs.model.Stop,TransitStop> stopVertexForStop

patternForTrip

public final Map<org.onebusaway.gtfs.model.Trip,TripPattern> patternForTrip

patternsForAgency

public final com.google.common.collect.Multimap<org.onebusaway.gtfs.model.Agency,TripPattern> patternsForAgency

patternsForRoute

public final com.google.common.collect.Multimap<org.onebusaway.gtfs.model.Route,TripPattern> patternsForRoute

patternsForStop

public final com.google.common.collect.Multimap<org.onebusaway.gtfs.model.Stop,TripPattern> patternsForStop

stopsForParentStation

public final com.google.common.collect.Multimap<String,org.onebusaway.gtfs.model.Stop> stopsForParentStation

stopClusterForStop

public final Map<org.onebusaway.gtfs.model.Stop,StopCluster> stopClusterForStop

stopClusterForId

public final Map<String,StopCluster> stopClusterForId

luceneIndex

public LuceneIndex luceneIndex

transfersFromStopCluster

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

routeForIdWithoutAgency

public Map<String,org.onebusaway.gtfs.model.Route> routeForIdWithoutAgency

tripForIdWithoutAgency

public Map<String,org.onebusaway.gtfs.model.Trip> tripForIdWithoutAgency

stopForIdWithoutAgency

public Map<String,org.onebusaway.gtfs.model.Stop> stopForIdWithoutAgency

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

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.

servicesRunning

public BitSet servicesRunning(org.onebusaway.gtfs.model.calendar.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<org.onebusaway.gtfs.model.Route> routesForStop(org.onebusaway.gtfs.model.Stop stop)

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

stopTimesForStop

public Collection<StopTimesInPattern> stopTimesForStop(org.onebusaway.gtfs.model.Stop stop)

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(org.onebusaway.gtfs.model.Stop stop,
                                                 long startTime,
                                                 int timeRange,
                                                 int numberOfDepartures)

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

Returns:

getStopTimesForStop

public List<StopTimesInPattern> getStopTimesForStop(org.onebusaway.gtfs.model.Stop stop,
                                                    org.onebusaway.gtfs.model.calendar.ServiceDate serviceDate)

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.

clusterStops

public void clusterStops()

FIXME OBA parentStation field is a string, not an AgencyAndId, so it has no agency/feed scope But the DC regional graph has no parent stations pre-defined, so no use dealing with them for now. However Trimet stops have "landmark" or Transit Center parent stations, so we don't use the parent stop field. Ideally in the future stop clusters will replicate and/or share implementation with GTFS parent stations. We can't use a similarity comparison, we need exact matches. This is because many street names differ by only one letter or number, e.g. 34th and 35th or Avenue A and Avenue B. Therefore normalizing the names before the comparison is essential. The agency must provide either parent station information or a well thought out stop naming scheme to cluster stops -- no guessing is reasonable without that information.