org.transitime.gtfs

Class DbConfig

java.lang.Object

org.transitime.gtfs.DbConfig

public class DbConfig
extends java.lang.Object

Reads all the configuration data from the database. The data is based on GTFS but is heavily processed into things like TripPatterns and better Paths to make the data far easier to use.

DbConfig is intended for the core application such that the necessary top level data can be read in at system startup. This doesn't read in all the low-level data such as paths and travel times. Those items are very voluminous and are therefore lazy loaded.

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
DbConfig(java.lang.String agencyId) Constructor

Method Summary

Modifier and Type	Method and Description
java.util.List<Agency>	getAgencies()
Block	getBlock(java.lang.String serviceId, java.lang.String blockId) Returns the block specified by the service and block ID parameters.
java.util.List<Block>	getBlocks() Returns unmodifiable list of blocks for the agency.
java.util.Collection<Block>	getBlocks(java.lang.String serviceId) Returns unmodifiable collection of blocks associated with the specified serviceId.
java.util.Collection<Block>	getBlocksForAllServiceIds(java.lang.String blockId) Returns blocks for the specified blockId for all service IDs.
java.util.List<Block>	getBlocksForRoute(java.lang.String routeId) Returns List of Blocks associated with the routeId for all service IDs.
java.util.List<Block>	getBlocksForRoute(java.lang.String serviceId, java.lang.String routeId) Returns List of Blocks associated with the serviceId and routeId.
java.util.List<CalendarDate>	getCalendarDates() Returns list of all calendar dates from the GTFS calendar_dates.txt file.
java.util.List<CalendarDate>	getCalendarDatesForNow() Returns CalendarDate for the current day.
java.util.List<Calendar>	getCalendars() Returns list of all calendars
int	getConfigRev() Returns the database revision of the configuration data that was read in.
java.util.List<Calendar>	getCurrentCalendars() Returns list of calendars that are currently active
java.util.List<java.lang.String>	getCurrentServiceIds() Returns list of service IDs that are currently active
Agency	getFirstAgency() There can be multiple agencies but usually there will be just one.
Route	getRouteById(java.lang.String routeId) Returns the Route with the specified routeId.
Route	getRouteByShortName(java.lang.String routeShortName) Returns the Route with the specified routeShortName
java.util.List<Route>	getRoutes() Returns ordered list of routes.
java.util.Map<java.lang.String,Route>	getRoutesByRouteIdMap() Returns Map of routesMap keyed on the routeId.
java.util.List<java.lang.String>	getServiceIds() Returns list of all service IDs
Stop	getStop(java.lang.String stopId) Returns the Stop with the specified stopId.
Trip	getTrip(java.lang.String tripId) For more quickly getting a trip.
java.util.List<TripPattern>	getTripPatternsForRoute(java.lang.String routeId) Returns the list of trip patterns associated with the specified route.
java.util.Map<java.lang.String,Trip>	getTrips() Returns cached map of all Trips.
Trip	getTripUsingTripShortName(java.lang.String tripShortName) For more quickly getting a trip.
static void	main(java.lang.String[] args) For debugging.
void	read(int configRev) Initiates the reading of the configuration data from the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbConfig

public DbConfig(java.lang.String agencyId)

Constructor

Parameters:

agencyId -

Method Detail

read

public void read(int configRev)

Initiates the reading of the configuration data from the database. Calls actuallyReadData() which does all the work.

Parameters:

configRev -

getBlocksForRoute

public java.util.List<Block> getBlocksForRoute(java.lang.String serviceId,
                                               java.lang.String routeId)

Returns List of Blocks associated with the serviceId and routeId.

Parameters:

serviceId - Specified service ID that want blocks for. Can set to null to blocks for all service IDs for the route.

routeId -

Returns:

List of Blocks. Null of no blocks for the serviceId and routeId

getBlocksForRoute

public java.util.List<Block> getBlocksForRoute(java.lang.String routeId)

Returns List of Blocks associated with the routeId for all service IDs.

Parameters:

routeId -

Returns:

getTripPatternsForRoute

public java.util.List<TripPattern> getTripPatternsForRoute(java.lang.String routeId)

Returns the list of trip patterns associated with the specified route. Reads the trip patterns from the database and stores them in cache so that subsequent calls get them directly from the cache. The first time this is called it can take a few seconds. Therefore this is not done at startup since want startup to be quick.

Parameters:

routeId -

Returns:

List of TripPatterns for the route, or null if no such route

getTrips

public java.util.Map<java.lang.String,Trip> getTrips()

Returns cached map of all Trips. Can be slow first time accessed because it can take a while to read in all trips including all sub-data.

Returns:

getTrip

public Trip getTrip(java.lang.String tripId)

For more quickly getting a trip. If trip not already read in yet it only reads in the specific trip from the db, not all trips like getTrips().

Parameters:

tripId -

Returns:

The trip, or null if no such trip

getTripUsingTripShortName

public Trip getTripUsingTripShortName(java.lang.String tripShortName)

For more quickly getting a trip. If trip not already read in yet it only reads in the specific trip from the db, not all trips like getTrips().

Parameters:

tripShortName -

Returns:

getBlock

public Block getBlock(java.lang.String serviceId,
                      java.lang.String blockId)

Returns the block specified by the service and block ID parameters.

Parameters:

serviceId - Specified which service class to look for block. If null then will use the first service class for the current time that has the specified block.

blockId - Specifies which block to return

Returns:

The block for the service and block IDs specified, or null if no such block.

getBlocksForAllServiceIds

public java.util.Collection<Block> getBlocksForAllServiceIds(java.lang.String blockId)

Returns blocks for the specified blockId for all service IDs.

Parameters:

blockId - Which blocks to return

Returns:

Collection of blocks

getBlocks

public java.util.Collection<Block> getBlocks(java.lang.String serviceId)

Returns unmodifiable collection of blocks associated with the specified serviceId.

Parameters:

serviceId -

Returns:

Blocks associated with service ID. If no blocks then an empty collection is returned instead of null.

getBlocks

public java.util.List<Block> getBlocks()

Returns unmodifiable list of blocks for the agency.

Returns:

blocks for the agency

getRoutesByRouteIdMap

public java.util.Map<java.lang.String,Route> getRoutesByRouteIdMap()

Returns Map of routesMap keyed on the routeId.

Returns:

getRoutes

public java.util.List<Route> getRoutes()

Returns ordered list of routes.

Returns:

getRouteById

public Route getRouteById(java.lang.String routeId)

Returns the Route with the specified routeId.

Parameters:

routeId -

Returns:

The Route specified by the ID, or null if no such route

getRouteByShortName

public Route getRouteByShortName(java.lang.String routeShortName)

Returns the Route with the specified routeShortName

Parameters:

routeShortName -

Returns:

The route, or null if route doesn't exist

getStop

public Stop getStop(java.lang.String stopId)

Returns the Stop with the specified stopId.

Parameters:

stopId -

Returns:

getCalendars

public java.util.List<Calendar> getCalendars()

Returns list of all calendars

Returns:

calendars

getCurrentCalendars

public java.util.List<Calendar> getCurrentCalendars()

Returns list of calendars that are currently active

Returns:

current calendars

getCalendarDates

public java.util.List<CalendarDate> getCalendarDates()

Returns list of all calendar dates from the GTFS calendar_dates.txt file.

Returns:

list of calendar dates

getCalendarDatesForNow

public java.util.List<CalendarDate> getCalendarDatesForNow()

Returns CalendarDate for the current day. This method is pretty quick since it looks through a hashmap, instead of doing a linear search through a possibly very large number of dates.

Returns:

CalendarDate for current day if there is one, otherwise null.

getServiceIds

public java.util.List<java.lang.String> getServiceIds()

Returns list of all service IDs

Returns:

service IDs

getCurrentServiceIds

public java.util.List<java.lang.String> getCurrentServiceIds()

Returns list of service IDs that are currently active

Returns:

current service IDs

getFirstAgency

public Agency getFirstAgency()

There can be multiple agencies but usually there will be just one. For getting timezone and such want to be able to easily access the main agency, hence this method.

Returns:

getAgencies

public java.util.List<Agency> getAgencies()

getConfigRev

public int getConfigRev()

Returns the database revision of the configuration data that was read in.

Returns:

The db rev

main

public static void main(java.lang.String[] args)

For debugging.

Parameters:

args -