org.transitime.gtfs

Class GtfsData

java.lang.Object

org.transitime.gtfs.GtfsData

public class GtfsData
extends java.lang.Object

Contains all the GTFS data processed into Java lists and such. Also combines in info from supplemental routes.txt file if there is one.

Author:

SkiBu Smith

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor and Description

GtfsData(int configRev, java.lang.String notes, java.util.Date zipFileLastModifiedTime, boolean shouldStoreNewRevs, java.lang.String projectId, java.lang.String gtfsDirectoryName, java.lang.String supplementDir, boolean shouldCombineShortAndLongNamesForRoutes, double pathOffsetDistance, double maxStopToPathDistance, double maxDistanceForEliminatingVertices, int defaultWaitTimeAtStopMsec, double maxSpeedKph, double maxTravelTimeSegmentLength, boolean trimPathBeforeFirstStopOfTrip, TitleFormatter titleFormatter) Constructor

Method Summary

Modifier and Type	Method and Description
java.util.List<Agency>	getAgencies()
java.lang.String	getAgencyId()
java.util.List<Block>	getBlocks()
java.util.List<CalendarDate>	getCalendarDates()
java.util.List<Calendar>	getCalendars()
ConfigRevision	getConfigRevision() Returns information about the current revision.
java.util.List<FareAttribute>	getFareAttributes()
java.util.List<FareRule>	getFareRules()
java.util.Collection<Frequency>	getFrequencies() Returns collection of all the Frequency objects.
java.util.List<Frequency>	getFrequencyList(java.lang.String tripId)
GtfsRoute	getGtfsRoute(java.lang.String routeId)
java.util.Map<java.lang.String,GtfsRoute>	getGtfsRoutesMap()
GtfsStop	getGtfsStop(java.lang.String stopId)
java.util.List<GtfsStopTime>	getGtfsStopTimesForTrip(java.lang.String tripId) Returns list of GtfsStopTimes for the trip specified
GtfsTrip	getGtfsTrip(java.lang.String tripId)
StopPath	getPath(java.lang.String tripPatternId, java.lang.String pathId) Returns the StopPath for the specified tripPatternId and pathId.
static java.lang.String	getPathMapKey(java.lang.String tripPatternId, java.lang.String pathId) For use with pathsMap member.
java.util.Collection<StopPath>	getPaths()
java.lang.String	getProperIdOfRoute(java.lang.String routeId) If a route is configured to be a sub-route of a parent then this method will return the route ID of the parent route.
java.util.List<Route>	getRoutes()
Stop	getStop(java.lang.String stopId) Gets the Stop from the stopsMap.
java.util.Collection<Stop>	getStops()
java.util.List<Transfer>	getTransfers()
TripPattern	getTripPattern(java.lang.String tripPatternId) Returns the specified trip pattern.
TripPattern	getTripPatternByTripId(java.lang.String tripId)
java.util.Map<TripPatternKey,TripPattern>	getTripPatternMap()
java.util.Collection<TripPattern>	getTripPatterns()
java.util.List<TripPattern>	getTripPatterns(java.lang.String routeId)
java.util.Collection<Trip>	getTrips()
boolean	isStopTimesReadIn() Returns true if GTFS stop times read in and are available
boolean	isTripFrequencyBased(java.lang.String tripId) Returns true if according to frequency.txt GTFS file that specified trip is frequencies based and doesn't have exact_times set.
boolean	isTripPatternIdAlreadyUsed(java.lang.String tripPatternId)
boolean	isTripsReadIn()
void	outputPathsAndStopsForGraphing(java.lang.String routeId) Outputs data for specified route grouped by trip pattern.
void	processData() Does all the work.
void	putPath(java.lang.String tripPatternId, java.lang.String pathId, StopPath path) Adds the StopPath object to the pathMap.
static boolean	routeNotFiltered(java.lang.String routeId) Returns true if the routeId isn't supposed to be filtered out, as specified by the transitime.gtfs.routeIdRegExPattern property.
static boolean	tripNotFiltered(java.lang.String tripId) Returns true if the tripId isn't supposed to be filtered out, as specified by the transitime.gtfs.tripIdRegExPattern property.

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static final org.slf4j.Logger logger

Constructor Detail

GtfsData

public GtfsData(int configRev,
                java.lang.String notes,
                java.util.Date zipFileLastModifiedTime,
                boolean shouldStoreNewRevs,
                java.lang.String projectId,
                java.lang.String gtfsDirectoryName,
                java.lang.String supplementDir,
                boolean shouldCombineShortAndLongNamesForRoutes,
                double pathOffsetDistance,
                double maxStopToPathDistance,
                double maxDistanceForEliminatingVertices,
                int defaultWaitTimeAtStopMsec,
                double maxSpeedKph,
                double maxTravelTimeSegmentLength,
                boolean trimPathBeforeFirstStopOfTrip,
                TitleFormatter titleFormatter)

Constructor

Parameters:

configRev -

notes -

zipFileLastModifiedTime -

shouldStoreNewRevs -

projectId -

gtfsDirectoryName -

supplementDir -

shouldCombineShortAndLongNamesForRoutes -

pathOffsetDistance -

maxStopToPathDistance -

maxDistanceForEliminatingVertices -

defaultWaitTimeAtStopMsec -

maxSpeedKph -

maxTravelTimeSegmentLength -

trimPathBeforeFirstStopOfTrip -

titleFormatter -

Method Detail

getAgencyId

public java.lang.String getAgencyId()

Returns:

projectId

getGtfsRoutesMap

public java.util.Map<java.lang.String,GtfsRoute> getGtfsRoutesMap()

getGtfsRoute

public GtfsRoute getGtfsRoute(java.lang.String routeId)

Parameters:

routeId -

Returns:

the GtfsRoute from the trips.txt file for the specified routeId, null if that route Id not defined in the file.

getGtfsTrip

public GtfsTrip getGtfsTrip(java.lang.String tripId)

Parameters:

tripId -

Returns:

the GtfsTrip from the trips.txt file for the specified tripId, null if that trip Id not defined in the file.

isStopTimesReadIn

public boolean isStopTimesReadIn()

Returns true if GTFS stop times read in and are available

Returns:

getGtfsStopTimesForTrip

public java.util.List<GtfsStopTime> getGtfsStopTimesForTrip(java.lang.String tripId)

Returns list of GtfsStopTimes for the trip specified

Parameters:

tripId -

Returns:

getTrips

public java.util.Collection<Trip> getTrips()

Returns:

Collection of all the Trip objects

isTripsReadIn

public boolean isTripsReadIn()

Returns:

True if tripsMap read in and is usable

getGtfsStop

public GtfsStop getGtfsStop(java.lang.String stopId)

getStops

public java.util.Collection<Stop> getStops()

getStop

public Stop getStop(java.lang.String stopId)

Gets the Stop from the stopsMap.

Parameters:

stopId -

Returns:

The Stop for the specified stopId

getTripPatterns

public java.util.Collection<TripPattern> getTripPatterns()

Returns:

Collection of all TripPatterns

getTripPatterns

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

Parameters:

routeId -

Returns:

List of TripPatterns for the routeId

getTripPatternByTripId

public TripPattern getTripPatternByTripId(java.lang.String tripId)

Parameters:

tripId - The trip ID to return the TripPattern for

Returns:

The TripPattern for the specified trip ID

isTripPatternIdAlreadyUsed

public boolean isTripPatternIdAlreadyUsed(java.lang.String tripPatternId)

getTripPatternMap

public java.util.Map<TripPatternKey,TripPattern> getTripPatternMap()

getTripPattern

public TripPattern getTripPattern(java.lang.String tripPatternId)

Returns the specified trip pattern. Not very efficient because does a linear search through the set of trip patterns but works well enough for debugging.

Parameters:

tripPatternId -

Returns:

getPathMapKey

public static java.lang.String getPathMapKey(java.lang.String tripPatternId,
                                             java.lang.String pathId)

For use with pathsMap member.

Parameters:

tripPatternId -

pathId -

Returns:

getPath

public StopPath getPath(java.lang.String tripPatternId,
                        java.lang.String pathId)

Returns the StopPath for the specified tripPatternId and pathId. Can't just use pathId since lots of trip patterns will traverse the same stops, resulting in identical pathIds. And don't want to make the pathIds themselves unique because then wouldn't be able to reuse travel time data as much.

Parameters:

tripPatternId -

pathId -

Returns:

getPaths

public java.util.Collection<StopPath> getPaths()

Returns:

Collection of all the Paths

putPath

public void putPath(java.lang.String tripPatternId,
                    java.lang.String pathId,
                    StopPath path)

Adds the StopPath object to the pathMap.

Parameters:

tripPatternId -

pathId -

path -

getRoutes

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

Returns:

List of routes that can be stored in db. The result is not ordered by route_order since that isn't needed as part of processing GTFS data.

getProperIdOfRoute

public java.lang.String getProperIdOfRoute(java.lang.String routeId)

If a route is configured to be a sub-route of a parent then this method will return the route ID of the parent route. Otherwise returns null.

Parameters:

routeId -

Returns:

route ID of parent route if there is one. Otherwise, null.

getBlocks

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

getAgencies

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

isTripFrequencyBased

public boolean isTripFrequencyBased(java.lang.String tripId)

Returns true if according to frequency.txt GTFS file that specified trip is frequencies based and doesn't have exact_times set. Note that if exact_times is set then a schedule is used. It is just that the schedule is based on the frequencies and start time of trip.

Parameters:

tripId -

Returns:

true if frequency based trip

getFrequencyList

public java.util.List<Frequency> getFrequencyList(java.lang.String tripId)

Parameters:

tripId -

Returns:

The Frequency list specified by tripId param

getFrequencies

public java.util.Collection<Frequency> getFrequencies()

Returns collection of all the Frequency objects. This method goes through the internal frequencyMap and compiles the collection each time this member is called.

Returns:

getCalendars

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

getCalendarDates

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

getFareAttributes

public java.util.List<FareAttribute> getFareAttributes()

getFareRules

public java.util.List<FareRule> getFareRules()

getTransfers

public java.util.List<Transfer> getTransfers()

getConfigRevision

public ConfigRevision getConfigRevision()

Returns information about the current revision.

Returns:

outputPathsAndStopsForGraphing

public void outputPathsAndStopsForGraphing(java.lang.String routeId)

Outputs data for specified route grouped by trip pattern. The resulting data can be visualized on a map by cutting and pasting it in to http://www.gpsvisualizer.com/map_input .

Parameters:

routeId -

tripNotFiltered

public static boolean tripNotFiltered(java.lang.String tripId)

Returns true if the tripId isn't supposed to be filtered out, as specified by the transitime.gtfs.tripIdRegExPattern property.

Parameters:

tripId -

Returns:

True if trip not to be filtered out

routeNotFiltered

public static boolean routeNotFiltered(java.lang.String routeId)

Returns true if the routeId isn't supposed to be filtered out, as specified by the transitime.gtfs.routeIdRegExPattern property.

Parameters:

routeId -

Returns:

True if route not to be filtered out

processData

public void processData()

Does all the work. Processes the data and store it in internal structures