GTFSFeed (gtfs-lib 5.0.2 API)

java.lang.Object
- com.conveyal.gtfs.GTFSFeed

All Implemented Interfaces:

Closeable, AutoCloseable, Cloneable
```
public class GTFSFeed
extends Object
implements Cloneable, Closeable
```
All entities must be from a single feed namespace. Composed of several GTFSTables.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`GTFSFeed.FirstAndLastStopsDoNotHaveTimes` Thrown when we cannot interpolate stop times because the first or last stops do not have times

Field Summary

Fields
Modifier and Type	Field and Description
`Map<String,Agency>`	`agency`
`long`	`checksum` CRC32 of the GTFS file this was loaded from
`NavigableSet<GTFSError>`	`errors`
`com.google.common.eventbus.EventBus`	`eventBus`
`Map<String,Fare>`	`fares`
`String`	`feedId`
`Map<String,FeedInfo>`	`feedInfo`
`NavigableSet<org.mapdb.Fun.Tuple2<String,Frequency>>`	`frequencies`
`Map<String,Pattern>`	`patterns`
`Map<String,Route>`	`routes`
`org.mapdb.BTreeMap<String,Service>`	`services`
`ConcurrentNavigableMap<org.mapdb.Fun.Tuple2<String,Integer>,ShapePoint>`	`shape_points`
`org.mapdb.BTreeMap<org.mapdb.Fun.Tuple2,StopTime>`	`stop_times`
`Map<String,Stop>`	`stops`
`Map<String,Transfer>`	`transfers`
`Set<String>`	`transitIds`
`Map<String,String>`	`tripPatternMap`
`org.mapdb.BTreeMap<String,Trip>`	`trips`

Constructor Summary

Constructors
Constructor and Description
`GTFSFeed()` Create a GTFS feed in a temp file
`GTFSFeed(String dbFile)` Create a GTFS feed connected to a particular DB, which will be created if it does not exist.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GTFSFeed`	`clone()` Cloning can be useful when you want to make only a few modifications to an existing feed.
`void`	`close()`
`protected void`	`finalize()`
`void`	`findPatterns()` MapDB-based implementation to find patterns.
`static GTFSFeed`	`fromFile(String file)` Static factory method returning a new instance of GTFSFeed containing the contents of the GTFS file at the supplied filesystem path.
`static GTFSFeed`	`fromFile(String file, String feedId)` Static factory method returning a new instance of GTFSFeed containing the contents of the GTFS file at the supplied filesystem path.
`com.vividsolutions.jts.geom.Polygon`	`getConvexHull()`
`FeedInfo`	`getFeedInfo()`
`Collection<Frequency>`	`getFrequencies(String trip_id)`
`Iterable<StopTime>`	`getInterpolatedStopTimesForTrip(String trip_id)` For the given trip ID, fetch all the stop times in order, and interpolate stop-to-stop travel times.
`List<String>`	`getOrderedStopListForTrip(String trip_id)`
`Iterable<StopTime>`	`getOrderedStopTimesForTrip(String trip_id)` For the given trip ID, fetch all the stop times in order of increasing stop_sequence.
`Shape`	`getShape(String shape_id)` Get the shape for the given shape ID
`com.vividsolutions.jts.index.strtree.STRtree`	`getSpatialIndex()` TODO rename getStopSpatialIndex to make it clear what the index contains.
`com.vividsolutions.jts.geom.LineString`	`getStraightLineForStops(String trip_id)`
`double`	`getTripDistance(String trip_id, boolean straightLine)` Get the length of a trip in meters.
`com.vividsolutions.jts.geom.LineString`	`getTripGeometry(String trip_id)` Returns a trip geometry object (LineString) for a given trip id.
`double`	`getTripSpeed(String trip_id)` Get trip speed (using trip shape if available) in meters per second.
`double`	`getTripSpeed(String trip_id, boolean straightLine)` Get trip speed in meters per second.
`boolean`	`hasFeedInfo()`
`void`	`loadFromFile(ZipFile zip)`
`void`	`loadFromFile(ZipFile zip, String fid)` The order in which we load the tables is important for two reasons.
`void`	`toFile(String file)`
`FeedLoadResult`	`toSQL(DataSource dataSource)`
`void`	`validate()`
`void`	`validate(boolean repair, Validator... validators)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - feedId
```
public String feedId
```
  - agency
```
public final Map<String,Agency> agency
```
  - feedInfo
```
public final Map<String,FeedInfo> feedInfo
```
  - frequencies
```
public final NavigableSet<org.mapdb.Fun.Tuple2<String,Frequency>> frequencies
```
  - routes
```
public final Map<String,Route> routes
```
  - stops
```
public final Map<String,Stop> stops
```
  - transfers
```
public final Map<String,Transfer> transfers
```
  - trips
```
public final org.mapdb.BTreeMap<String,Trip> trips
```
  - transitIds
```
public final Set<String> transitIds
```
  - checksum
```
public long checksum
```
    CRC32 of the GTFS file this was loaded from
  - shape_points
```
public final ConcurrentNavigableMap<org.mapdb.Fun.Tuple2<String,Integer>,ShapePoint> shape_points
```
  - stop_times
```
public final org.mapdb.BTreeMap<org.mapdb.Fun.Tuple2,StopTime> stop_times
```
  - fares
```
public final Map<String,Fare> fares
```
  - services
```
public final org.mapdb.BTreeMap<String,Service> services
```
  - errors
```
public final NavigableSet<GTFSError> errors
```
  - patterns
```
public final Map<String,Pattern> patterns
```
  - tripPatternMap
```
public final Map<String,String> tripPatternMap
```
  - eventBus
```
public transient com.google.common.eventbus.EventBus eventBus
```
- Constructor Detail
  - GTFSFeed
```
public GTFSFeed()
```
    Create a GTFS feed in a temp file
  - GTFSFeed
```
public GTFSFeed(String dbFile)
         throws IOException,
                ExecutionException
```
    Create a GTFS feed connected to a particular DB, which will be created if it does not exist.
    
    Throws:
    
    IOException
    
    ExecutionException
- Method Detail
  - loadFromFile
```
public void loadFromFile(ZipFile zip,
                         String fid)
                  throws Exception
```
    The order in which we load the tables is important for two reasons. 1. We must load feed_info first so we know the feed ID before loading any other entities. This could be relaxed by having entities point to the feed object rather than its ID String. 2. Referenced entities must be loaded before any entities that reference them. This is because we check referential integrity while the files are being loaded. This is done on the fly during loading because it allows us to associate a line number with errors in objects that don't have any other clear identifier. Interestingly, all references are resolvable when tables are loaded in alphabetical order.
    
    Throws:
    
    Exception
  - loadFromFile
```
public void loadFromFile(ZipFile zip)
                  throws Exception
```
    Throws:
    
    Exception
  - toSQL
```
public FeedLoadResult toSQL(DataSource dataSource)
```
  - toFile
```
public void toFile(String file)
```
  - validate
```
public void validate(boolean repair,
                     Validator... validators)
```
  - validate
```
public void validate()
```
  - fromFile
```
public static GTFSFeed fromFile(String file)
```
    Static factory method returning a new instance of GTFSFeed containing the contents of the GTFS file at the supplied filesystem path.
  - fromFile
```
public static GTFSFeed fromFile(String file,
                                String feedId)
```
    Static factory method returning a new instance of GTFSFeed containing the contents of the GTFS file at the supplied filesystem path. Forces the feedId to the supplied value if the parameter is non-null.
  - hasFeedInfo
```
public boolean hasFeedInfo()
```
  - getFeedInfo
```
public FeedInfo getFeedInfo()
```
  - getOrderedStopTimesForTrip
```
public Iterable<StopTime> getOrderedStopTimesForTrip(String trip_id)
```
    For the given trip ID, fetch all the stop times in order of increasing stop_sequence. This is an efficient iteration over a tree map.
  - getSpatialIndex
```
public com.vividsolutions.jts.index.strtree.STRtree getSpatialIndex()
```
    TODO rename getStopSpatialIndex to make it clear what the index contains.
  - getShape
```
public Shape getShape(String shape_id)
```
    Get the shape for the given shape ID
  - findPatterns
```
public void findPatterns()
```
    MapDB-based implementation to find patterns. FIXME: Remove and make pattern finding happen during validation? We want to share the pattern finder between the two implementations (MapDB and RDBMS), apply the same validation process to both kinds of storage, and produce Patterns in the same way in both cases, during validation. This prevents us from iterating over every stopTime twice, since we're already iterating over all of them in validation. However, in this case it might not be costly to simply retrieve the stop times from the stop_times map.
  - getInterpolatedStopTimesForTrip
```
public Iterable<StopTime> getInterpolatedStopTimesForTrip(String trip_id)
                                                   throws GTFSFeed.FirstAndLastStopsDoNotHaveTimes
```
    For the given trip ID, fetch all the stop times in order, and interpolate stop-to-stop travel times.
    
    Throws:
    
    GTFSFeed.FirstAndLastStopsDoNotHaveTimes
  - getFrequencies
```
public Collection<Frequency> getFrequencies(String trip_id)
```
  - getOrderedStopListForTrip
```
public List<String> getOrderedStopListForTrip(String trip_id)
```
  - getStraightLineForStops
```
public com.vividsolutions.jts.geom.LineString getStraightLineForStops(String trip_id)
```
  - getTripGeometry
```
public com.vividsolutions.jts.geom.LineString getTripGeometry(String trip_id)
```
    Returns a trip geometry object (LineString) for a given trip id. If the trip has a shape reference, this will be used for the geometry. Otherwise, the ordered stoptimes will be used.
    
    Parameters:
    
    trip_id - trip id of desired trip geometry
    
    Returns:
    
    the LineString representing the trip geometry.
    
    See Also:
    
    LineString
  - getTripDistance
```
public double getTripDistance(String trip_id,
                              boolean straightLine)
```
    Get the length of a trip in meters.
  - getTripSpeed
```
public double getTripSpeed(String trip_id)
```
    Get trip speed (using trip shape if available) in meters per second.
  - getTripSpeed
```
public double getTripSpeed(String trip_id,
                           boolean straightLine)
```
    Get trip speed in meters per second.
  - getConvexHull
```
public com.vividsolutions.jts.geom.Polygon getConvexHull()
```
  - clone
```
public GTFSFeed clone()
```
    Cloning can be useful when you want to make only a few modifications to an existing feed. Keep in mind that this is a shallow copy, so you'll have to create new maps in the clone for tables you want to modify.
    
    Overrides:
    
    clone in class Object
  - finalize
```
protected void finalize()
                 throws IOException
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    IOException
  - close
```
public void close()
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable

Class GTFSFeed

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

feedId

agency

feedInfo

frequencies

routes

stops

transfers

trips

transitIds

checksum

shape_points

stop_times

fares

services

errors

patterns

tripPatternMap

eventBus

Constructor Detail

GTFSFeed

GTFSFeed

Method Detail

loadFromFile

loadFromFile

toSQL

toFile

validate

validate

fromFile

fromFile

hasFeedInfo

getFeedInfo

getOrderedStopTimesForTrip

getSpatialIndex

getShape

findPatterns

getInterpolatedStopTimesForTrip

getFrequencies

getOrderedStopListForTrip

getStraightLineForStops

getTripGeometry

getTripDistance

getTripSpeed

getTripSpeed

getConvexHull

clone

finalize

close