- This project uses Jenkins.
The following is a link to the continuous integration system used by the project:
-No notifiers are defined. Please check back at a later date.
- ![[Error]](images/icon_error_sml.gif){kind=icon} |
-At least one dependency has a differing version of the dependency or has SNAPSHOT dependencies. |
| Number of modules: | -9 |
|---|---|
| Number of dependencies (NOD): | -78 |
| Number of unique artifacts (NOA): | -86 |
| Number of version-conflicting artifacts (NOC): | -5 |
| Number of SNAPSHOT artifacts (NOS): | -0 |
| Convergence (NOD/NOA): | - 90 % |
| Ready for release (100% convergence and no SNAPSHOTS): | - Error You do not have 100% convergence. |
|
-
-
|
|
-
-
|
|
-
-
|
|
-
-
|
|
-
-
|
- <dependency> - <groupId>org.onebusaway</groupId> - <artifactId>onebusaway-gtfs-modules</artifactId> - <version>1.4.16-SNAPSHOT</version> - <type>pom</type> -</dependency>
<dependency org="org.onebusaway" name="onebusaway-gtfs-modules" rev="1.4.16-SNAPSHOT"> - <artifact name="onebusaway-gtfs-modules" type="pom" /> -</dependency>
@Grapes( -@Grab(group='org.onebusaway', module='onebusaway-gtfs-modules', version='1.4.16-SNAPSHOT') -)
compile 'org.onebusaway:onebusaway-gtfs-modules:1.4.16-SNAPSHOT'
libraryDependencies += "org.onebusaway" % "onebusaway-gtfs-modules" % "1.4.16-SNAPSHOT"
[org.onebusaway/onebusaway-gtfs-modules "1.4.16-SNAPSHOT"]
- The following is a list of compile dependencies in the DependencyManagement of this project. These dependencies can be included in the submodules to compile and run the submodule:
-| GroupId | -ArtifactId | -Version | -Type | -License |
|---|---|---|---|---|
| com.sun.xml.bind | -jaxb-core | -2.3.0 | -jar | -CDDL+GPL License |
| com.sun.xml.bind | -jaxb-impl | -2.3.0 | -jar | -CDDL+GPL License |
| javax.xml.bind | -jaxb-api | -2.3.0 | -jar | -CDDL 1.1, GPL2 w/ CPE |
| org.onebusaway | -onebusaway-collections | -1.2.8 | -jar | -The Apache Software License, Version 2.0 |
| org.onebusaway | -onebusaway-csv-entities | -1.1.7 | -jar | -The Apache Software License, Version 2.0 |
| org.slf4j | -slf4j | -2.0.6 | -jar | -- |
| org.slf4j | -slf4j-api | -2.0.6 | -jar | -MIT License |
| org.slf4j | -slf4j-simple | -2.0.6 | -jar | -MIT License |
The following is a list of test dependencies in the DependencyManagement of this project. These dependencies can be included in the submodules to compile and run unit tests for the submodule:
-| GroupId | -ArtifactId | -Version | -Type | -License |
|---|---|---|---|---|
| junit | -junit | -4.4 | -jar | -Common Public License Version 1.0 |
| org.mockito | -mockito-core | -1.8.0 | -jar | -The MIT License |
- The following is the distribution management information used by this project.
s3://repo.camsys-apps.com/releases/
s3://repo.camsys-apps.com/snapshots/
scp://developer.onebusaway.org/var/www/sites/developer/modules/onebusaway-gtfs-modules/1.4.16-SNAPSHOT
- We provide a Java library for reading and writing GTFS feeds, including database support.
-Current Version: 1.4.16-SNAPSHOT
-Details on all releases can be found in the Release Notes.
-The library is broken up into a few key modules:
-onebusaway-gtfs - The core library for reading and writing GTFSonebusaway-gtfs-hibernate - Support for Hibernate database persistence of GTFS dataonebusaway-gtfs-hibernate-cli - Command-line utilty for loading GTFS feeds into a database - see the full documentation. onebusaway-gtfs-transformer - Tools for transforming GTFS dataonebusaway-gtfs-transformer-cli - Command-line utility for transforming GTFS - see the full documentation.onebusaway-gtfs-merge - Tools for merging GTFS dataonebusaway-gtfs-merge-cli - Command-line utility for merging GTFS feeds - see the full documentation.You can access the latest Javadoc for the library. Also, see example source code below.
The library is available as a Maven module. Simply add the following dependencies:
-<dependencies> - <!-- Core GTFS Library --> - <dependency> - <groupId>org.onebusaway</groupId> - <artifactId>onebusaway-gtfs</artifactId> - <version>1.4.16-SNAPSHOT</version> - </dependency> - <!-- Optional Hibernate GTFS Database Persistence --> - <dependency> - <groupId>org.onebusaway</groupId> - <artifactId>onebusaway-gtfs-hibernate</artifactId> - <version>1.4.16-SNAPSHOT</version> - </dependency> - <!-- Optional GTFS Transformation Library --> - <dependency> - <groupId>org.onebusaway</groupId> - <artifactId>onebusaway-gtfs-transformer</artifactId> - <version>1.4.16-SNAPSHOT</version> - </dependency> -</dependencies>
To use a SNAPSHOT version of the library, you'll need to add a reference to the OneBusAway Maven repository.
Let's introduce basic code for reading a GTFS feed and handling the resulting entities:
-public class GtfsReaderExampleMain {
-
- public static void main(String[] args) throws IOException {
-
- if (args.length != 1) {
- System.err.println("usage: gtfs_feed_path");
- System.exit(-1);
- }
-
- GtfsReader reader = new GtfsReader();
- reader.setInputLocation(new File(args[0]));
-
- /**
- * You can register an entity handler that listens for new objects as they
- * are read
- */
- reader.addEntityHandler(new GtfsEntityHandler());
-
- /**
- * Or you can use the internal entity store, which has references to all the
- * loaded entities
- */
- GtfsDaoImpl store = new GtfsDaoImpl();
- reader.setEntityStore(store);
-
- reader.run();
-
- // Access entities through the store
- for (Route route : store.getAllRoutes()) {
- System.out.println("route: " + route.getShortName());
- }
- }
-
- private static class GtfsEntityHandler implements EntityHandler {
-
- public void handleEntity(Object bean) {
- if (bean instanceof Stop) {
- Stop stop = (Stop) bean;
- System.out.println("stop: " + stop.getName());
- }
- }
- }
-}Notice that the GtfsReader does the bulk of the work of reading the GTFS feed. The general pattern is to create the reader, set the input file, and call `run()` to start the reading process. You can manage the resulting GTFS entities in a couple of ways:
-public class GtfsWriterExampleMain {
-
- public static void main(String[] args) throws IOException {
-
- if (args.length != 1) {
- System.err.println("usage: gtfs_feed_path");
- System.exit(-1);
- }
-
-
- GtfsWriter writer = new GtfsWriter();
- writer.setOutputLocation(new File(args[0]));
-
- Agency agency = new Agency();
- agency.setName("My agency!");
-
- writer.handleEntity(agency);
-
- Route route = new Route();
- route.setShortName("A");
- route.setAgency(agency);
-
- writer.handleEntity(route);
-
- writer.close();
- }
-}The class org.onebusaway.gtfs.examples.GtfsHibernateReaderExampleMain in the onebusaway-gtfs-hibernate/src/test/java directory includes basic code for reading a GTFS feed into a database and querying the resulting entities.
The sample code has been summarized for length and clarity:
-public class GtfsHibernateReaderExampleMain {
-
- public static void main(String[] args) throws IOException {
-
- // Check args and construct application resource paths
- ...
-
- HibernateGtfsFactory factory = createHibernateGtfsFactory(resource);
-
- GtfsReader reader = new GtfsReader();
- reader.setInputLocation(new File(args[0]));
-
- GtfsMutableRelationalDao dao = factory.getDao();
- reader.setEntityStore(dao);
- reader.run();
-
- Collection<Stop> stops = dao.getAllStops();
-
- for (Stop stop : stops)
- System.out.println(stop.getName());
-
- ...
- }
-
- // Other methods
- private static HibernateGtfsFactory createHibernateGtfsFactory(String resource) {
-
- Configuration config = new Configuration();
-
- if (resource.startsWith(KEY_CLASSPATH)) {
- resource = resource.substring(KEY_CLASSPATH.length());
- config = config.configure(resource);
- } else if (resource.startsWith(KEY_FILE)) {
- resource = resource.substring(KEY_FILE.length());
- config = config.configure(new File(resource));
- } else {
- config = config.configure(new File(resource));
- }
-
- SessionFactory sessionFactory = config.buildSessionFactory();
- return new HibernateGtfsFactory(sessionFactory);
- }
-}This code is roughly similar to the example reader code for onebusaway-gtfs, with the main difference being the use of HibernateGtfsFactory, which is a convenience factory for creating database-aware DAOs.
By default, the example above is setup to run with an in-memory HSQLDB database. Obviously, it'd be great to configure it to use a different database and you totally can. See http://hibernate.org/ for more documentation on configuring Hibernate, but also check out the default hibernate config file used in the example above. It's located in the following directory:
-onebusaway-gtfs-hibernate/src/test/resources/org/onebusaway/gtfs/examples/hibernate-configuration-examples.xml
The contents look like:
-<?xml version='1.0' encoding='utf-8'?> -<hibernate-configuration> - <session-factory> - <!-- Database connection settings --> - <property name="connection.driver_class">org.hsqldb.jdbcDriver</property> - <property name="connection.url">jdbc:hsqldb:mem:org_onebusaway_temporary</property> - <property name="connection.username">sa</property> - <property name="connection.password"></property> - - <!-- SQL dialect --> - <property name="dialect">org.hibernate.dialect.HSQLDialect</property> - - <!-- More config options removed for brevity --> - </session-factory> -</hibernate-configuration>
Here you can configure the data source used for the database connection along with the Hibernate dialect.
Does your GTFS feed have custom fields not defined by the core onebusaway-gtfs library? It's possible to read and write this data without modify OBA source code using the "extensions" mechanism. Consider a stops.txt file with a custom extra_stop_info field:
stop_id,stop_name,stop_lat,stop_lon,extra_stop_info -123,Some Station,47.0,-122.0,This is a cool transit station
The extra_stop_info field isn't included in the the Stop data model by default. So instead, we define a special StopExtension Java bean type with the new field:
public static class StopExtension {
- @CsvField(optional = true)
- private String extraStopInfo;
-
- public String getExtraStopInfo() { ... }
- public void setExtraStopInfo(String info) { ... }
-}We can now register our class as an extension of the default stop data model:
-DefaultEntitySchemaFactory factory = GtfsEntitySchemaFactory.createEntitySchemaFactory(); -factory.addExtension(Stop.class, StopExtension.class); - -GtfsReader reader = new GtfsReader(); -reader.setEntitySchemaFactory(factory);
Now when you read your GTFS feed with the GtfsReader instance, StopExtension objects will automatically be created, populated, and attached to stops as they are read:
Stop stop = dao.getStopForId(...); -StopExtension extension = stop.getExtension(StopExtension.class); -System.out.println(extension.getExtraStopInfo());
For more information on defining the mapping from GTFS fields to Java beans, see documentation for the onebusaway-csv-entities project, including the @CsvField annotation documentation.
- These are the mailing lists that have been established for this project. For each list, there is a subscribe, unsubscribe, and an archive link.
-| Name | -Subscribe | -Unsubscribe | -Post | -Archive |
|---|---|---|---|---|
| onebusaway-users | -- | -- | -- | -groups.google.com |
| onebusaway-developers | -- | -- | -- | -groups.google.com |
| onebusaway-api | -- | -- | -- | -groups.google.com |
| onebusaway-issues | -- | -- | -- | -groups.google.com |
| onebusaway-commits | -- | -- | -- | -groups.google.com |
| onebusaway-ci | -- | -- | -- | -groups.google.com |
- This project has declared the following modules:
-| Name | -Description |
|---|---|
| onebusaway-gtfs | -A Java library for reading and writing General Transit Feed Spec feeds |
| onebusaway-gtfs-hibernate | -A Java library for reading and writing General Transit Feed Spec feeds into a database |
| onebusaway-gtfs-hibernate-cli | -A command-line utility for loading GTFS data into a database. |
| onebusaway-gtfs-transformer | -A Java library for transforming Google Transit Feed Spec feeds |
| onebusaway-gtfs-transformer-cli | -A Java application for transforming Google Transit Feed Spec feeds |
| onebusaway-gtfs-transformer-cli-aws | -A Java application for transforming Google Transit Feed Spec feeds with AWS extensions |
| onebusaway-gtfs-merge | -A tool for merging GTFS feeds. |
| onebusaway-gtfs-merge-cli | -Command-line interface to the GTFS merge tool. |
- The onebusaway-gtfs-hibernate-cli command-line utility is a simple command-line tool for loading a GTFS feed into a database.
You can download the application here:
-You'll need a Java 11 runtime installed to run the client. To run the application:
-java -classpath onebusaway-gtfs-hiberante-cli.jar:your-database-jdbc.jar \ - org.onebusaway.gtfs.GtfsDatabaseLoaderMain \ - --driverClass=... \ - --url=... \ - --username=... \ - --password=... \ - gtfs_path
Note that the utility doesn't include any JDBC client jars for any databases by default. You will need to download an appropriate JDBC client for your database and include it on the classpath when running the utilty. You will also need to specify the appropriate JDBC driver class and url for your database using the command-line arguments specified below.
--driverClass=... : JDBC driver class for your JDBC provider (eg. "org.hsqldb.jdbcDriver")--url=... : JDBC connection url for your database (eg. "jdbc:hsqldb:mem:temp_db")--username=... : JDBC connection username--password=... : JDBC connection password
- NOTE: This tool is a work in progress! This documentation may not be up-to-date.
-The onebusaway-gtfs-merge-cli command-line application is a simple command-line tool for merging GTFS feeds.
You can download the application Maven Central.
-Go tohttps://repo1.maven.org/maven2/org/onebusaway/onebusaway-gtfs-merge-cli/. Select the version you want and get the URL for the largest jar file. An example would be https://repo1.maven.org/maven2/org/onebusaway/onebusaway-gtfs-merge-cli/3.2.2/onebusaway-gtfs-merge-cli-3.2.2.jar
You'll need a Java 11 runtime installed to run the client. To run the application:
-java -jar onebusaway-gtfs-merge-cli.jar [--args] input_gtfs_path_a input_gtfs_path_b ... output_gtfs_path
Note: Merging large GTFS feeds is often processor and memory intensive. You'll likely need to increase the max amount of memory allocated to Java with an option like -Xmx1G (adjust the limit as needed). I also recommend adding the -server argument if you are running the Oracle or OpenJDK, as it can really increase performance.
The merge application supports a number of options and arguments for configuring the application's behavior. The general pattern is to specify options for each type of file in a GTFS feed using the --file option, specifying specific options for each file type after the --file option. Here's a quick example:
--file=routes.txt --duplicateDetection=identity --file=calendar.txt --logDroppedDuplicates ...
The merge application supports merging the following files:
-agency.txtstops.txtroutes.txttrips.txt and stop_times.txtcalendar.txt and calendar_dates.txt shapes.txtfare_attributes.txtfare_rules.txtfrequencies.txttransfers.txtYou can specify merge options for each of these files using the --file=gtfs_file.txt option. File types listed together (eg. trips.txt>> and <<<stop_times.txt) are handled by the same merge strategy, so specifying options for either will have the same effect. For details on options you might specify, read on.
The main issue to considering when merging GTFS feeds is the handling of duplicate entries between the two feeds, including how to identify duplicates and what to do with duplicates when they are found.
We support a couple of methods for determining when entries from two different feeds are actually duplicates. By default, the merge tool will attempt to automatically determine the best merge strategy to use. You can also control the specific strategy used on a per-file basis using the --duplicateDetection argument. You can specify any of the following strategies for duplicate detection.
--duplicateDetection=identity - If two entries have the same id (eg. stop id, route id, trip id), then they are considered the same. This is the more strict matching policy.--duplicateDetection=fuzzy - If two entries have common elements (eg. stop name or location, route short name, trip stop sequence), then they are considered the same. This is the more lenient matching policy, and is highly dependent on the type of GTFS entry being matched.--duplicateDetection=none - Entries between two feeds are never considered to be duplicates, even if they have the same id or similar properties.Sometimes your feed might have unexpected duplicates. You can tell the merge tool to log duplicates it finds or even immediately exit with the following arguments:
---logDroppedDuplicates - log a message when a duplicate is found--errorOnDroppedDuplicates - throw an exception when a duplicate is found, stopping the programAgencies often schedule major changes to their system around a particular date, with one GTFS feed for before the service change and a different GTFS feed for after. We'd like to be able to merge these disjoint feeds into one feed with continuous coverage.
-In our example, an agency produces two feeds where the entries in agency.txt and stops.txt are exactly the same, so the default policy of identifying and dropping duplicates will work fine there. The routes.txt file is a bit trickier, since the route ids are different between the two feeds but the entries are largely the same. We will use fuzzy duplicate detection to match the routes between the two feeds.
The next issue is the calendar.txt file. The agency uses the same service_id values in both feeds (eg. WEEK, SAT, SUN) with different start and end dates in the two feeds. If the default policy of dropping duplicate entries was used, we'd lose the dates in one of the service periods. Instead, we rename duplicates such that the service ids from the second feed will be renamed to b-WEEK, b-SAT, etc. and all trips.txt entries in the second feed will be updated appropriately. The result is that trips from the first and second feed will both have the proper calendar entries in the merged feed.
Putting it all together, here is what the command-line options for the application would look like:
---file=routes.txt --fuzzyDuplicates --file=calendar.txt --renameDuplicates
- The onebusaway-gtfs-transformer-cli command-line application is a simple command-line tool for transforming GTFS feeds.
You can download the application Maven Central.
-Go to https://repo1.maven.org/maven2/org/onebusaway/onebusaway-gtfs-transformer-cli/and select the largest jar file from the version you would like to use, for example https://repo1.maven.org/maven2/org/onebusaway/onebusaway-gtfs-transformer-cli/2.0.0/onebusaway-gtfs-transformer-cli-2.0.0.jar
To run the application:
-java -jar onebusaway-gtfs-transformer-cli.jar [-args] input_gtfs_path ... output_gtfs_path
input_gtfs_path and output_gtfs_path can be either a directory containing a GTFS feed or a .zip file.Note: Transforming large GTFS feeds is processor and memory intensive. You'll likely need to increase the max amount of memory allocated to Java with an option like -Xmx1G or greater. Adding the -server argument if you are running the Oracle or OpenJDK can also increase performance.
--transform=... : specify a transformation to apply to the input GTFS feed (see syntax below)--agencyId=id : specify a default agency id for the input GTFS feed--overwriteDuplicates : specify that duplicate GTFS entities should overwrite each other when readTransforms are specified as snippets of example. A simple example to remove a stop might look like:
-{"op":"remove","match":{"file":"stops.txt","stop_name":"Stop NameP"}}You can pass those snippets to the application in a couple of ways. The simplest is directly on the command line.
---transform='{...}'You can have multiple --transform arguments to specify multiple transformations. However, if you have a LOT of transformations that you wish to apply, it can be easier to put them in a file, with a JSON snippet per line. Then specify the file on the command-line:
--transform=path/to/local-file
You can even specify a URL where the transformations will be read:
---transform=http://server/path
We provide a number of configurable transformations out-of-the-box that can do simple operations like adding, updating, retaining, and removing GTFS entities. Many of the transforms accept a "`match`" term that controls how the rule matches against entities:
-{"op":..., "match":{"file":"routes.txt", "route_short_name":"574"}}Here, the match snippet at minimum requires a `file` property that specifies the type of GTFS entity to match. Any file name defined in the GTFS specification can be used.
-You can specify additional properties and values to match against as needed. Again, use the field names defined for each file name in the GTFS specification. For example, the snippet above will match any entry in `routes.txt` with a `route_short_name` value of `574`.
Property matching also supports regular expressions that allow you to match property values conforming to a regexp pattern. For example, the snippet below will match any entry in `stops.txt` with a `stop_id` starting with `de:08`.
-{"op":..., "match":{"file":"stops.txt", "stop_id":"m/^de:08.*/"}}Property matching also supports compound property expressions that allow you to match across GTFS relational references. Let's look at a simple example:
-{"op":..., "match":{"file":"trips.txt", "route.route_short_name":"10"}}Here the special `routes` property references the route entry associated with each trip, allowing you to match the properties of the route. You can even chain references, like `route.agency` to match against the agency associated with the trip. Here is the full list of supported compound property references:
-{"op":..., "match":{"file":"routes.txt", "agency.name":"Metro"}}
-{"op":..., "match":{"file":"trips.txt", "route.route_short_name":"10"}}
-{"op":..., "match":{"file":"stop_times.txt", "stop.stop_id":"153"}}
-{"op":..., "match":{"file":"stop_times.txt", "trip.route.route_type":3}}
-{"op":..., "match":{"file":"frequencies.txt", "trip.service_id":"WEEKDAY"}}
-{"op":..., "match":{"file":"transfers.txt", "fromStop.stop_id":"173"}}
-{"op":..., "match":{"file":"transfers.txt", "toStop.stop_id":"173"}}
-{"op":..., "match":{"file":"fare_rules.txt", "fare.currencyType":"USD"}}
-{"op":..., "match":{"file":"fare_rules.txt", "route.route_short_name":"10"}}The compound property expressions shown above are all for 1-to-1 relations, but matching also supports a limited form of multi-value matching for 1-to-N relations. Let's look at a simple example:
-{"op":..., "match":{"file":"routes.txt", "any(trips.trip_headsign)":"Downtown"}}Notice the addition of `any(...)` around the property name. Here we are using a special `trips` property that expands to include all trips associated with each route. Now, if *any* trip belonging to the route has the specified `trip_headsign` value, then the route matches. Here is the full list of supported multi-value property matches:
-{"op":..., "match":{"file":"agency.txt", "any(routes.X)":"Y"}}
-{"op":..., "match":{"file":"routes.txt", "any(trips.X)":"Y"}}
-{"op":..., "match":{"file":"trips.txt", "any(stop_times.X)":"Y"}}There are a number of GTFS entites that are more effectively collections identified by a common key. For example, shape points in `shapes.txt` linked by a common `shape_id` value or `calendar.txt` and `calendar_dates.txt` entries linked by a common `service_id` value. You can use a special `collection `match clause to match against the entire collection.
-{"op":..., "match":{"collection":"shape", "shape_id":"XYZ"}}
-{"op":..., "match":{"collection":"calendar", "service_id":"XYZ"}}You can use the calendar collection matches, for example, to retain a calendar, including all `calendar.txt`, `calendar_dates.txt`, and `trip.txt` entries that reference the specified `service_id` value. This convenient short-hand is easier than writing the equivalent expression using references to the three file types separately.
Create and add a new entity to the feed.
-{"op":"add","obj":{"file":"agency.txt", "agency_id":"ST", "agency_name":"Sound Transit",
-"agency_url":"http://www.soundtransit.org", "agency_timezone":"America/Los_Angeles"}}You can update arbitrary fields of a GTFS entity.
-{"op":"update", "match":{"file":"routes.txt", "route_short_name":"574"}, "update":{"agency_id":"ST"}}Normally, update values are used as-is. However, we support a number of special update operations:
{"op":"update", "match":{"file":"trips.txt"}, "update":{"trip_short_name":"s/North/N/"}}By using s/.../.../ syntax in the update value, the update will perform a find-replace operation on the specified property value. Consider the following example:
{"op":"update", "match":{"file":"trips.txt"}, "update":{"trip_short_name":"s/North/N/"}}Here, a trip with a headsign of North Seattle will be updated to N Seattle.
By using path(...) syntax in the update value, the expression will be treated as a compound Java bean properties path expression. This path expression will be evaluated against the target entity to produce the update value. Consider the following example:
{"op":"update", "match":{"file":"trips.txt"}, "update":{"trip_short_name":"path(route.longName)"}}Here, the trip_short_name field is updated for each trip in the feed. The value will be copied from the route_long_name field of each trip's associated route.
We also provide a powerful mechanism for selecting just a sub-set of a feed. You can apply retain operations to entities you wish to keep and all the supporting entities referenced by the retained entity will be retained as well. Unreferenced entities will be pruned.
-In the following example, only route B15 will be retained, along with all the stops, trips, stop times, shapes, and agencies linked to directly by that route.
-{"op":"retain", "match":{"file":"routes.txt", "route_short_name":"B15"}}By default, we retain across block_id values specified in trips.txt. That means if a particular trip is retained (perhaps because its parent route is retained), and the trip specifies a block_id, then all the trips referencing that block_id will be retained as well, along with their own routes, stop times, and shapes. This can potentially lead to unexpected results if you retain one route and suddenly see other routes included because they are linked by block_id.
-You can disable this feature by specifying retainBlocks: false in the JSON transformer snippet. Here is an example:
{"op":"retain","match":{"file":"routes.txt", "route_short_name":"B15"}, "retainBlocks":false}You can remove a specific entity from a feed.
-{"op":"remove", "match":{"file":"stops.txt", "stop_name":"Stop Name"}}Note that removing an entity has a cascading effect. If you remove a trip, all the stop times that depend on that trip will also be removed. If you remove a route, all the trips and stop times for that route will be removed.
You can remove stop times from the beginning or end of a trip using the "trim_trip" operation. Example:
-{"op":"trim_trip", "match":{"file":"trips.txt", "route_id":"R10"}, "from_stop_id":"138S"}For any trip belonging to the specified route and passing through the specified stop, all stop times from the specified stop onward will be removed from the trip. You can also remove stop times from the beginning of the trip as well:
-{"op":"trim_trip", "match":{"file":"trips.txt", "route_id":"R10"}, "to_stop_id":"138S"}Or both:
-{"op":"trim_trip", "match":{"file":"trips.txt", "route_id":"R10"}, "to_stop_id":"125S", "from_stop_id":"138S"}You can generate stop time entries for a trip. Example:
-{"op":"stop_times_factory", "trip_id":"TRIP01", "start_time":"06:00:00", "end_time":"06:20:00", "stop_ids":["S01", "S02", "S03"]}A series of entries in `stop_times.txt` will be generated for the specified trip, traveling along the specified sequence of stops. The departure time for the first stop will be set from the `start_time` field, the arrival time for the last stop will be set from the `end_time` field, and the times for intermediate stops will be interpolated based on their distance along the trip.
Sometimes you need to extend the service dates in a GTFS feed, perhaps in order to temporarily extend an expired feed. Extending the feed by hand can be a tedious task, especially when the feed uses a complex combination of `calendar.txt` and `calendar_dates.txt` entries. Fortunately, the GTFS tranformer tool supports a `calendar_extension` operation that can help simplify the work. Example:
-{"op":"calendar_extension", "end_date":"20130331"}The operation requires just one argument by default: `end_date` to specify the new end-date for the feed. The operation does its best to intelligently extend each service calendar, as identified by a `service_id` in `calendar.txt` or `calendar_dates.txt`. There are a few wrinkles to be aware of, however.
-Extending a `calendar.txt` entry is usually just a matter of setting a new `end_date` value in the feed. Extending a service calendar represented only through `calendar_dates.txt` entries is a bit more complex. For such a service calendar, we attempt to determine which days of the week are typically active for the calendar and extend only those. For example, is the calendar is always active on Saturday but has one or two Sunday entries, we will only add entries for Saturday when extending the calendar.
-Also note that we will not extend "inactive" service calendars. A service calendar is considered inactive if its last active service date is already in the past. By default, any calendar that's been expired for more than two weeks is considered inactive. This helps handle feeds that have merged two service periods in one feed. For example, one calendar active from June 1 - July 31 and a second calendar active from August 1 to September 31. If it's the last week of September and you are extending the feed, you typically only mean to extend the second service calendar. You can control this inactive calendar cutoff with an optional argument:
-{"op":"calendar_extension", "end_date":"20130331", "inactive_calendar_cutoff":"20121031"}Calendars that have expired before the specified date will be considered inactive and won't be extended.
-Note: We don't make any effort to extend canceled service dates, as specified in `calendar_dates.txt` for holidays and other special events. It's too tricky to automatically determine how they should be handled. You may need to still handle those manually.
Finds GTFS service_ids that have the exact same set of active days and consolidates each set of duplicated ids to a single service_id entry.
-{"op":"deduplicate_service_ids"}Some agencies model their transit schedule favoring multiple entries in calendar_dates.txt as opposed to a more concise entry in calendar.txt. A smaller number of agencies take this scheme even further, creating trips.txt entries for each service date, even when the underlying trips are exactly the same. This can cause the size of the GTFS to grow dramatically as trips and stop times are duplicated.
-We provide a simple transformer that can attempt to detect these duplicate trips, remove them, and simplify the underlying calendar entries to match. To run it, apply the following transform:
-{"op":"calendar_simplification"}The transform takes additional optional arguments to control its behavior:
-OriginalTripId_merged_1234567. We attempt to set the trip id back to OrginalTripId where appropriate.Some agencies have trips that they model as starting BEFORE midnight on a given service date. For these agencies, it would be convenient to represent these trips with negative arrival and departure times in stop_times.txt. The GTFS spec and many GTFS consumers do not support negative stop times, however.
-To help these agencies, we provide a transform to "fix" GTFS feeds with negative stop times by identifying such trips, shifting the arrival and departure times to make them positive, and updating the service calendar entries for these trips such that the resulting schedule is semantically the same.
-To run it, apply the following transform:
-{"op":"shift_negative_stop_times"}A note on negative stop times: When writing negative stop times, the negative value ONLY applies to the hour portion of the time. Here are a few examples:
-Stop_times which do not allow pick up or drop off are also known as non-revenue stops. Some GTFS consumers display these stops as if they were stops that passengers can use, at which point it is helpful to remove them.
-To remove them, apply the following transform:
-{"op":"remove_non_revenue_stops"}Terminals (the first and last stop_time of a trip) can be excluded from removal with the following transform:
-{"op":"remove_non_revenue_stops_excluding_terminals"}}Certain feeds contain unhelpful or incorrect trip_headsign. They can be replaced with the last stop's stop_name.
-{"op":"last_stop_to_headsign"}We also allow you to specify arbitrary transformations as well. Here, you specify your transformation class and we will automatically instantiate it for use in the transform pipeline.
-{"op":"transform", "class":"some.class.implementing.GtfsTranformStrategy"}We additionally provide a mechanism for setting additional properties of the transform. For all additional properties specified in the JSON snippet, we will attempt to set that Java bean property value on the instantiated transformation object. See for example:
-{"op":"transform", "class":"org.onebusaway.gtfs_transformer.updates.ShapeTransformStrategy", "shape_id":"6010031", \
-"shape":"wjb~G|abmVpAz]v_@@?wNE_GDaFs@?@dFX`GGjN__@A"}Here, we set additional properties on the `ShapeTransformStrategy`, making it possible to reuse and configure a generic transformer to your needs.
We can apply a modification that retains certain GTFS entities and all other entities required directly or indirectly by those entities. For example, create a file with the following contents (call it modifications.txt, as an example):
-{"op":"retain", "match":{"file":"routes.txt", "route_short_name":"B15"}}
-{"op":"retain", "match":{"file":"routes.txt", "route_short_name":"B62"}}
-{"op":"retain", "match":{"file":"routes.txt", "route_short_name":"B63"}}
-{"op":"retain", "match":{"file":"routes.txt", "route_short_name":"BX19"}}
-{"op":"retain", "match":{"file":"routes.txt", "route_short_name":"Q54"}}
-{"op":"retain", "match":{"file":"routes.txt", "route_short_name":"S53"}}Then run:
-java -jar onebusaway-gtfs-transformer-cli.jar --transform=modifications.txt source-gtfs.zip target-gtfs.zip
The resulting GTFS will have the retained only the routes with the matching short names and all other entities required to support those routes.
Consider an existing feed with a number of routes and stops. We can add an entirely new route, with trips and stop-times and frequency-based service, using the transform. This can be handy to add temporary service to an existing feed.
-{"op":"add", "obj":{"file":"routes.txt", "route_id":"r0", "route_long_name":"Temporary Shuttle", "route_type":3}}
-
-{"op":"add", "obj":{"file":"calendar.txt", "service_id":"WEEKDAY", "start_date":"20120601", "end_date":"20130630", "monday":1, "tuesday":1, "wednesday":1, "thursday":1, "friday":1}}
-
-{"op":"add", "obj":{"file":"trips.txt", "trip_id":"t0", "route_id":"r0", "service_id":"WEEKDAY", "trip_headsign":"Inbound"}}
-{"op":"add", "obj":{"file":"trips.txt", "trip_id":"t1", "route_id":"r0", "service_id":"WEEKDAY", "trip_headsign":"Outbound"}}
-
-{"op":"add","obj":{"file":"frequencies.txt","trip_id":"t0","start_time":"06:00:00","end_time":"22:00:00","headway_secs":900}}
-{"op":"add","obj":{"file":"frequencies.txt","trip_id":"t1","start_time":"06:00:00","end_time":"22:00:00","headway_secs":900}}
-
-{"op":"stop_times_factory", "trip_id":"t0", "start_time":"06:00:00", "end_time":"06:20:00", "stop_ids":["s0", "s1", "s2", "s3"]}
-{"op":"stop_times_factory", "trip_id":"t1", "start_time":"06:00:00", "end_time":"06:20:00", "stop_ids":["s3", "s2", "s1", "s0"]}
- | GroupId | -ArtifactId | -Version |
|---|---|---|
| org.apache.maven.plugins | -maven-antrun-plugin | -1.3 |
| org.apache.maven.plugins | -maven-assembly-plugin | -2.5.5 |
| org.apache.maven.plugins | -maven-clean-plugin | -2.6.1 |
| org.apache.maven.plugins | -maven-compiler-plugin | -3.8.0 |
| org.apache.maven.plugins | -maven-dependency-plugin | -2.10 |
| org.apache.maven.plugins | -maven-deploy-plugin | -2.8.2 |
| org.apache.maven.plugins | -maven-gpg-plugin | -1.1 |
| org.apache.maven.plugins | -maven-install-plugin | -2.5.2 |
| org.apache.maven.plugins | -maven-jar-plugin | -2.6 |
| org.apache.maven.plugins | -maven-javadoc-plugin | -2.7 |
| org.apache.maven.plugins | -maven-project-info-reports-plugin | -2.4 |
| org.apache.maven.plugins | -maven-release-plugin | -2.5.3 |
| org.apache.maven.plugins | -maven-resources-plugin | -2.7 |
| org.apache.maven.plugins | -maven-shade-plugin | -1.7.1 |
| org.apache.maven.plugins | -maven-site-plugin | -3.7.1 |
| org.apache.maven.plugins | -maven-source-plugin | -2.4 |
| org.apache.maven.plugins | -maven-surefire-plugin | -2.22.1 |
| org.apache.maven.plugins | -maven-war-plugin | -2.6 |
- | GroupId | -ArtifactId | -Version |
|---|---|---|
| com.mycila | -license-maven-plugin | -2.11 |
| org.apache.maven.plugins | -maven-clean-plugin | -2.6.1 |
| org.apache.maven.plugins | -maven-compiler-plugin | -3.10.1 |
| org.apache.maven.plugins | -maven-deploy-plugin | -2.8.2 |
| org.apache.maven.plugins | -maven-install-plugin | -2.5.2 |
| org.apache.maven.plugins | -maven-jar-plugin | -3.0.1 |
| org.apache.maven.plugins | -maven-javadoc-plugin | -3.4.1 |
| org.apache.maven.plugins | -maven-release-plugin | -2.5.3 |
| org.apache.maven.plugins | -maven-site-plugin | -3.12.1 |
| GroupId | -ArtifactId | -Version |
|---|---|---|
| org.apache.maven.plugins | -maven-project-info-reports-plugin | -3.4.2 |
- This document provides an overview of the various documents and links that are part of this project's general information. All of this content is automatically generated by Maven on behalf of the project.
| Document | -Description |
|---|---|
| CI Management | -This document lists the continuous integration management system of this project for building and testing code on a frequent, regular basis. |
| Dependency Convergence | -This document presents the convergence of dependency versions across the entire project, and its sub modules. |
| Dependency Information | -This document describes how to include this project as a dependency using various dependency management tools. |
| Dependency Management | -This document lists the dependencies that are defined through dependencyManagement. |
| Distribution Management | -This document provides informations on the distribution management of this project. |
| About | -A collection of GTFS libraries and tools. |
| Issue Management | -This document provides information on the issue management system used in this project. |
| Licenses | -This document lists the project license(s). |
| Mailing Lists | -This document provides subscription and archive information for this project's mailing lists. |
| Project Modules | -This document lists the modules (sub-projects) of this project. |
| Plugin Management | -This document lists the plugins that are defined through pluginManagement. |
| Plugins | -This document lists the build plugins and the report plugins used by this project. |
| Source Code Management | -This document lists ways to access the online source repository. |
| Summary | -This document lists other related information of this project |
| Team | -This document provides information on the members of this project. These are the individuals who have contributed to the project in one form or another. |
- route_sort_order field in routes.txt.pathway_type field in pathways.txt.timepoint field in stop_times.txt - issuepath" expressions in GTFS transformer update ops - issuesubstitute" expressions in GTFS transformer update ops - issuetimepoint field in stop_times.txt.bikes_allowed field in both routes.txt and trips.txt, with 0 = undefined, 1 = bikes allowed, 2 = bikes NOT allowed. Matches the wheel-chair accessibility semantics.calendar.txt and calendar_dates.txt entries, combining service_ids that resolve to the exact same set of service dates.onebusaway-gtfs-hibernate-cli, a utility for loading GTFS into a database - detailsstops.txt platform_code field - issuestop_times.txt, along with a "shift_negative_stop_times" GTFS transformer operation for normalizing feeds with negative stop-times.RemoveRepeatedStopTimesInSameTripStrategy, a GTFS transformer strategy - javadocstops.txt stop_timezone field - issueroute_short_name and route_long_name in routes.txt output - issueagency_fare_url fieldexact_times fieldgetStopsForStation method to GtfsRelationalDao (see discussion)makeReadOnly method to CalendarServiceDatagetAllShapeIds method to GtfsRelationalDaojourneyDuration property to FareAttribute onebusaway-gtfs-transformer-cli.onebusaway-gtfs-transformer-cli.
- This project uses Git to manage its source code. Instructions on Git use can be found at https://git-scm.com/documentation.
The following is a link to a browsable version of the source repository:
-The source can be checked out anonymously from Git with this command (See https://git-scm.com/docs/git-clone):
-$ git clone https://github.com/OneBusAway/onebusaway-gtfs-modules.git
Only project developers can access the Git tree via this method (See https://git-scm.com/docs/git-clone).
-$ git clone ssh://git@github.com/OneBusAway/onebusaway-gtfs-modules.git
Refer to the documentation of the SCM used for more information about access behind a firewall.
- | Field | -Value |
|---|---|
| Name | -onebusaway-gtfs-modules |
| Description | -A collection of GTFS libraries and tools. |
| Homepage | -https://github.com/OneBusAway/onebusaway-gtfs-modules/wiki/ |
| Field | -Value |
|---|---|
| Name | -OneBusAway |
| URL | -http://onebusaway.org/ |
| Field | -Value |
|---|---|
| GroupId | -org.onebusaway |
| ArtifactId | -onebusaway-gtfs-modules |
| Version | -1.4.16-SNAPSHOT |
| Type | -pom |
- A successful project requires many people to play many roles. Some members write code or documentation, while others are valuable as testers, submitting patches and suggestions.
-The project team is comprised of Members and Contributors. Members have direct access to the source of a project and actively evolve the code-base. Contributors improve the project through submission of patches and suggestions to the Members. The number of Contributors to the project is unbounded. Get involved today. All contributions to the project are greatly appreciated.
The following is a list of developers with commit privileges that have directly contributed to the project in one way or another.
-| Image | -Id | -Name | -|
|---|---|---|---|
 |
-bdferris | -Brian Ferris | -bdferris@onebusaway.org |
 |
-sheldonabrown | -Sheldon A. Brown | -sheldonb@gmail.com |
There are no contributors listed for this project. Please check back again later.