com.conveyal.gtfs.model

Class Entity.Loader<E extends Entity>

java.lang.Object

com.conveyal.gtfs.model.Entity.Loader<E>

Direct Known Subclasses:

Agency.Loader, Calendar.Loader, CalendarDate.Loader, FareAttribute.Loader, FareRule.Loader, FeedInfo.Loader, Frequency.Loader, Route.Loader, ShapePoint.Loader, Stop.Loader, StopTime.Loader, Transfer.Loader, Trip.Loader

Enclosing class:

Entity

public abstract static class Entity.Loader<E extends Entity>
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected GTFSFeed	feed
protected Set<String>	missingRequiredColumns
protected com.csvreader.CsvReader	reader
protected int	row
protected String	tableName

Constructor Summary

Constructors

Constructor and Description
Loader(GTFSFeed feed, String tableName)

Method Summary

Modifier and Type	Method and Description
protected boolean	checkRangeInclusive(double min, double max, double actual)
protected LocalDate	getDateField(String column, boolean required) Fetch the given column of the current row, and interpret it as a date in the format YYYYMMDD.
protected double	getDoubleField(String column, boolean required, double min, double max)
protected int	getIntField(String column, boolean required, int min, int max)
protected int	getIntField(String column, boolean required, int min, int max, int defaultValue)
protected <K,V> V	getRefField(String column, boolean required, Map<K,V> target) Used to check referential integrity.
protected String	getStringField(String column, boolean required)
protected int	getTimeField(String column, boolean required) Fetch the given column of the current row, and interpret it as a time in the format HH:MM:SS.
protected URL	getUrlField(String column, boolean required) Fetch the given column of the current row, and interpret it as a URL.
protected abstract boolean	isRequired()
protected abstract void	loadOneRow() Implemented by subclasses to read one row, produce one GTFS entity, and store that entity in a map.
void	loadTable(ZipFile zip) The main entry point into an Entity.Loader.

Methods inherited from class java.lang.Object

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

Field Detail

feed

protected final GTFSFeed feed

tableName

protected final String tableName

missingRequiredColumns

protected final Set<String> missingRequiredColumns

reader

protected com.csvreader.CsvReader reader

row

protected int row

Constructor Detail

Loader

public Loader(GTFSFeed feed,
              String tableName)

Method Detail

checkRangeInclusive

protected boolean checkRangeInclusive(double min,
                                      double max,
                                      double actual)

Returns:

whether the number actual is in the range [min, max]

getStringField

protected String getStringField(String column,
                                boolean required)
                         throws IOException

Returns:

the given column from the current row as a deduplicated String.

Throws:

IOException

getIntField

protected int getIntField(String column,
                          boolean required,
                          int min,
                          int max)
                   throws IOException

Throws:

IOException

getIntField

protected int getIntField(String column,
                          boolean required,
                          int min,
                          int max,
                          int defaultValue)
                   throws IOException

Throws:

IOException

getTimeField

protected int getTimeField(String column,
                           boolean required)
                    throws IOException

Fetch the given column of the current row, and interpret it as a time in the format HH:MM:SS.

Returns:

the time value in seconds since midnight

Throws:

IOException

getDateField

protected LocalDate getDateField(String column,
                                 boolean required)
                          throws IOException

Fetch the given column of the current row, and interpret it as a date in the format YYYYMMDD. While Postgres has a date type, SQLite does not have any date types, let alone a specific timezone free one.

Returns:

the date value as Java LocalDate, or null if it could not be parsed.

Throws:

IOException

getUrlField

protected URL getUrlField(String column,
                          boolean required)
                   throws IOException

Fetch the given column of the current row, and interpret it as a URL.

Returns:

the URL, or null if the field was missing or empty.

Throws:

IOException

getDoubleField

protected double getDoubleField(String column,
                                boolean required,
                                double min,
                                double max)
                         throws IOException

Throws:

IOException

getRefField

protected <K,V> V getRefField(String column,
                              boolean required,
                              Map<K,V> target)
                       throws IOException

Used to check referential integrity. Return value is not used, but could allow entities to point to each other directly rather than using indirection through string-keyed maps.

Throws:

IOException

isRequired

protected abstract boolean isRequired()

loadOneRow

protected abstract void loadOneRow()
                            throws IOException

Implemented by subclasses to read one row, produce one GTFS entity, and store that entity in a map.

Throws:

IOException

loadTable

public void loadTable(ZipFile zip)
               throws IOException

The main entry point into an Entity.Loader. Interprets each row of a CSV file within a zip file as a sinle GTFS entity, and loads them into a table.

Parameters:

zip - the zip file from which to read a table

Throws:

IOException