com.conveyal.gtfs.loader

Class ReferenceTracker

java.lang.Object

com.conveyal.gtfs.loader.ReferenceTracker

public class ReferenceTracker
extends Object

This class is used while loading GTFS to track the unique keys that are encountered in a GTFS feed. It has two sets of strings that it tracks, one for single field keys (e.g., route_id or stop_id) and one for keys that are compound, usually made up of a string ID with a sequence field (e.g., trip_id + stop_sequence for tracking unique stop times).

NOTE: Its methods should remain public because they are used during external processes that validate or otherwise iterate over each line of a GTFS file and need to check for reference validity (e.g., while merging GTFS feeds this is used to determine ID conflicts).

Field Summary

Fields

Modifier and Type	Field and Description
Set<String>	transitIds
Set<String>	transitIdsWithSequence

Constructor Summary

Constructors

Constructor and Description
ReferenceTracker()

Method Summary

Modifier and Type	Method and Description
Set<NewGTFSError>	checkReferencesAndUniqueness(String keyValue, int lineNumber, Field field, String value, Table table) During table load, checks the uniqueness of the entity ID and that references are valid.
Set<NewGTFSError>	checkReferencesAndUniqueness(String keyValue, int lineNumber, Field field, String value, Table table, String keyField, String orderField) During table load, checks the uniqueness of the entity ID and that references are valid.

Methods inherited from class java.lang.Object

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

Field Detail

transitIds

public final Set<String> transitIds

transitIdsWithSequence

public final Set<String> transitIdsWithSequence

Constructor Detail

ReferenceTracker

public ReferenceTracker()

Method Detail

checkReferencesAndUniqueness

public Set<NewGTFSError> checkReferencesAndUniqueness(String keyValue,
                                                      int lineNumber,
                                                      Field field,
                                                      String value,
                                                      Table table)

During table load, checks the uniqueness of the entity ID and that references are valid. NOTE: This method defaults the key field and order field names to this table's values.

Parameters:

keyValue - key value for the record being checked

lineNumber - line number of the record being checked

field - field currently being checked

value - value that corresponds to field

table - table currently being checked

Returns:

any duplicate or bad reference errors.

checkReferencesAndUniqueness

public Set<NewGTFSError> checkReferencesAndUniqueness(String keyValue,
                                                      int lineNumber,
                                                      Field field,
                                                      String value,
                                                      Table table,
                                                      String keyField,
                                                      String orderField)

During table load, checks the uniqueness of the entity ID and that references are valid. These references are stored in the provided reference tracker. Any non-unique IDs or invalid references will store an error. NOTE: this instance of checkReferencesAndUniqueness allows for arbitrarily setting the keyField and orderField, which is helpful for checking uniqueness of fields that are not the standard primary key (e.g., route_short_name).