Table (gtfs-lib 5.0.2 API)

java.lang.Object
- com.conveyal.gtfs.loader.Table

```
public class Table
extends Object
```
This groups a table name with a description of the fields in the table. It can be normative (expressing the specification for a CSV table in GTFS) or descriptive (providing the schema of an RDBMS table). TODO associate Table with EntityPopulator (combine read and write sides)

Field Summary

Fields
Modifier and Type	Field and Description
`static Table`	`AGENCY`
`static Table`	`CALENDAR`
`static Table`	`CALENDAR_DATES`
`static Table`	`FARE_ATTRIBUTES`
`static Table`	`FARE_RULES`
`static Table`	`FEED_INFO`
`Field[]`	`fields`
`static Table`	`FREQUENCIES`
`boolean`	`hasUniqueKeyField` Indicates whether the table has unique key field.
`String`	`name`
`static Table`	`PATTERN_STOP`
`static Table`	`PATTERNS`
`static Table`	`ROUTES`
`static Table`	`SCHEDULE_EXCEPTIONS`
`static Table`	`SHAPES`
`static Table`	`STOP_TIMES`
`static Table`	`STOPS`
`static Table[]`	`tablesInOrder` List of tables in order needed for checking referential integrity during load stage.
`static Table`	`TRANSFERS`
`static Table`	`TRIPS`

Constructor Summary

Constructors
Constructor and Description

Table(String name, Class<? extends Entity> entityClass, Requirement required, Field... fields)

Constructors
Constructor and Description
`Table(String name, Class<? extends Entity> entityClass, Requirement required, Field... fields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Table`	`addPrimaryKey()` Fluent method that indicates that the integer ID field should be made a primary key.
`static String`	`commaSeparatedNames(List<Field> fieldsToJoin)` Join a list of fields with a comma + space separator.
`static String`	`commaSeparatedNames(List<Field> fieldsToJoin, String prefix, boolean csvOutput)` Prepend a prefix string to each field and join them with a comma + space separator.
`void`	`createIndexes(Connection connection, String namespace)` Create indexes for table using shouldBeIndexed(), key field, and/or sequence field.
`boolean`	`createSqlTable(Connection connection)`
`boolean`	`createSqlTable(Connection connection, boolean makeIdSerial)`
`boolean`	`createSqlTable(Connection connection, String namespace, boolean makeIdSerial)`
`boolean`	`createSqlTable(Connection connection, String namespace, boolean makeIdSerial, String[] primaryKeyFields)` Create an SQL table with all the fields specified by this table object, plus an integer CSV line number field in the first position.
`boolean`	`createSqlTableFrom(Connection connection, String tableToClone)` Creates a SQL table from the table to clone.
`List<Field>`	`editorFields()` Get only those fields included in the official GTFS specification for this table or used by the editor.
`String`	`generateDeleteSql(String namespace)`
`String`	`generateDeleteSql(String namespace, String fieldName)` Generate delete SQL string.
`String`	`generateInsertSql()` Create an SQL table that will insert a value into all the fields specified by this table object, plus an integer CSV line number field in the first position.
`String`	`generateInsertSql(boolean setDefaultId)`
`String`	`generateInsertSql(String namespace, boolean setDefaultId)` Create SQL string for use in insert statement.
`String`	`generateJoinSql(String optionalSelect, Table joinTable, String namespace)`
`String`	`generateJoinSql(String optionalSelect, Table joinTable, String joinType, String namespace, String fieldName, boolean prefixTableName)` Constructs a join clause to use in conjunction with `generateJoinSql(com.conveyal.gtfs.loader.Table, java.lang.String, java.lang.String, boolean)`.
`String`	`generateJoinSql(Table joinTable, String namespace)`
`String`	`generateJoinSql(Table joinTable, String namespace, String fieldName, boolean prefixTableName)`
`String`	`generateSelectAllExistingFieldsSql(Connection connection, String namespace)` Generate a select statement from the columns that actually exist in the database table.
`String`	`generateSelectAllSql(String namespace)` Shorthand wrapper for calling `generateSelectSql(String, Requirement)`.
`String`	`generateSelectSql(String namespace, Requirement minimumRequirement)` Generate select all SQL string.
`String`	`generateUpdateSql(String namespace, int id)` Create SQL string for use in update statement.
`com.csvreader.CsvReader`	`getCsvReader(ZipFile zipFile, SQLErrorStorage sqlErrorStorage)` In GTFS feeds, all files are supposed to be in the root of the zip file, but feed producers often put them in a subdirectory.
`Class<? extends Entity>`	`getEntityClass()`
`Field`	`getFieldForName(String name)`
`int`	`getFieldIndex(String name)` Finds the index of the field for this table given a string name.
`Field[]`	`getFieldsFromFieldHeaders(String[] headers, SQLErrorStorage errorStorage)` For an array of field headers, returns the matching set of `Field`s for a `Table`.
`String`	`getIndexFields()` Gets index fields for the spec table.
`int`	`getKeyFieldIndex(Field[] fields)` Returns the index of the key field within the array of fields provided for a given table.
`String`	`getKeyFieldName()` Gets the key field for the table.
`String`	`getOrderFieldName()` Returns field name that defines order for grouped entities or that defines the compound key field (e.g., transfers#to_stop_id).
`Table`	`getParentTable()`
`Table`	`hasCompoundKey()` Fluent method to set whether the table has a compound key, e.g., transfers#to_stop_id.
`boolean`	`hasField(String name)` Whether a field with the provided name exists in the table's list of fields.
`boolean`	`isCascadeDeleteRestricted()`
`boolean`	`isRequired()`
`boolean`	`isSpecTable()` Checks whether the table is part of the GTFS specification, i.e., it is not an internal table used for the editor (e.g., Patterns or PatternStops).
`Table`	`keyFieldIsNotUnique()` Fluent method to de-set the hasUniqueKeyField flag for tables which the first field should not be considered a primary key.
`List<Field>`	`requiredFields()` Get only those fields marked as required in the official GTFS specification for this table.
`Table`	`restrictDelete()` Fluent method that restricts deletion of an entity in this table if there are references to it elsewhere.
`List<Field>`	`specFields()` Get only those fields included in the official GTFS specification for this table, i.e., filter out fields used in the editor or extensions.

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

- Field Detail
  - name
```
public final String name
```
  - fields
```
public final Field[] fields
```
  - hasUniqueKeyField
```
public boolean hasUniqueKeyField
```
    Indicates whether the table has unique key field.
  - AGENCY
```
public static final Table AGENCY
```
  - CALENDAR
```
public static final Table CALENDAR
```
  - SCHEDULE_EXCEPTIONS
```
public static final Table SCHEDULE_EXCEPTIONS
```
  - CALENDAR_DATES
```
public static final Table CALENDAR_DATES
```
  - FARE_ATTRIBUTES
```
public static final Table FARE_ATTRIBUTES
```
  - FEED_INFO
```
public static final Table FEED_INFO
```
  - ROUTES
```
public static final Table ROUTES
```
  - FARE_RULES
```
public static final Table FARE_RULES
```
  - SHAPES
```
public static final Table SHAPES
```
  - PATTERNS
```
public static final Table PATTERNS
```
  - STOPS
```
public static final Table STOPS
```
  - PATTERN_STOP
```
public static final Table PATTERN_STOP
```
  - TRANSFERS
```
public static final Table TRANSFERS
```
  - TRIPS
```
public static final Table TRIPS
```
  - STOP_TIMES
```
public static final Table STOP_TIMES
```
  - FREQUENCIES
```
public static final Table FREQUENCIES
```
  - tablesInOrder
```
public static final Table[] tablesInOrder
```
    List of tables in order needed for checking referential integrity during load stage.
- Constructor Detail
  - Table
```
public Table(String name,
             Class<? extends Entity> entityClass,
             Requirement required,
             Field... fields)
```
- Method Detail
  - restrictDelete
```
public Table restrictDelete()
```
    Fluent method that restricts deletion of an entity in this table if there are references to it elsewhere. For example, a calendar that has trips referencing it must not be deleted.
  - keyFieldIsNotUnique
```
public Table keyFieldIsNotUnique()
```
    Fluent method to de-set the hasUniqueKeyField flag for tables which the first field should not be considered a primary key.
  - hasCompoundKey
```
public Table hasCompoundKey()
```
    Fluent method to set whether the table has a compound key, e.g., transfers#to_stop_id.
  - addPrimaryKey
```
public Table addPrimaryKey()
```
    Fluent method that indicates that the integer ID field should be made a primary key. This should generally only be used for tables that would ever need to be queried on the unique integer ID (which represents row number for tables directly after csv load). For example, we may need to query for a stop or route by unique ID in order to update or delete it. (Whereas querying for a specific stop time vs. a set of stop times would rarely if ever be needed.)
  - editorFields
```
public List<Field> editorFields()
```
    Get only those fields included in the official GTFS specification for this table or used by the editor.
  - requiredFields
```
public List<Field> requiredFields()
```
    Get only those fields marked as required in the official GTFS specification for this table.
  - specFields
```
public List<Field> specFields()
```
    Get only those fields included in the official GTFS specification for this table, i.e., filter out fields used in the editor or extensions.
  - isCascadeDeleteRestricted
```
public boolean isCascadeDeleteRestricted()
```
  - createSqlTable
```
public boolean createSqlTable(Connection connection)
```
  - createSqlTable
```
public boolean createSqlTable(Connection connection,
                              boolean makeIdSerial)
```
  - createSqlTable
```
public boolean createSqlTable(Connection connection,
                              String namespace,
                              boolean makeIdSerial)
```
  - createSqlTable
```
public boolean createSqlTable(Connection connection,
                              String namespace,
                              boolean makeIdSerial,
                              String[] primaryKeyFields)
```
    Create an SQL table with all the fields specified by this table object, plus an integer CSV line number field in the first position.
  - generateInsertSql
```
public String generateInsertSql()
```
    Create an SQL table that will insert a value into all the fields specified by this table object, plus an integer CSV line number field in the first position.
  - generateInsertSql
```
public String generateInsertSql(boolean setDefaultId)
```
  - generateInsertSql
```
public String generateInsertSql(String namespace,
                                boolean setDefaultId)
```
    Create SQL string for use in insert statement. Note, this filters table's fields to only those used in editor.
  - getCsvReader
```
public com.csvreader.CsvReader getCsvReader(ZipFile zipFile,
                                            SQLErrorStorage sqlErrorStorage)
```
    In GTFS feeds, all files are supposed to be in the root of the zip file, but feed producers often put them in a subdirectory. This function will search subdirectories if the entry is not found in the root. It records an error if the entry is in a subdirectory (as long as errorStorage is not null). It then creates a CSV reader for that table if it's found.
  - commaSeparatedNames
```
public static String commaSeparatedNames(List<Field> fieldsToJoin)
```
    Join a list of fields with a comma + space separator.
  - commaSeparatedNames
```
public static String commaSeparatedNames(List<Field> fieldsToJoin,
                                         String prefix,
                                         boolean csvOutput)
```
    Prepend a prefix string to each field and join them with a comma + space separator. Also, if an export to GTFS is being performed, certain fields need a translation from the database format to the GTFS format. Otherwise, the fields are assumed to be asked in order to do a database-to-database export and so the verbatim values of the fields are needed.
  - generateUpdateSql
```
public String generateUpdateSql(String namespace,
                                int id)
```
    Create SQL string for use in update statement. Note, this filters table's fields to only those used in editor.
  - generateSelectSql
```
public String generateSelectSql(String namespace,
                                Requirement minimumRequirement)
```
    Generate select all SQL string. The minimum requirement parameter is used to determine which fields ought to be included in the select statement. For example, if "OPTIONAL" is passed in, both optional and required fields are included in the select. If "EDITOR" is the minimum requirement, editor, optional, and required fields will all be included.
  - generateSelectAllSql
```
public String generateSelectAllSql(String namespace)
```
    Shorthand wrapper for calling generateSelectSql(String, Requirement). Note: this does not prefix field names with the namespace, so cannot serve as a replacement for generateSelectAllExistingFieldsSql(java.sql.Connection, java.lang.String).
  - generateSelectAllExistingFieldsSql
```
public String generateSelectAllExistingFieldsSql(Connection connection,
                                                 String namespace)
                                          throws SQLException
```
    Generate a select statement from the columns that actually exist in the database table. This method is intended to be used when exporting to a GTFS and eventually generates the select all with each individual field and applicable transformations listed out.
    
    Throws:
    
    SQLException
  - generateJoinSql
```
public String generateJoinSql(Table joinTable,
                              String namespace,
                              String fieldName,
                              boolean prefixTableName)
```
  - generateJoinSql
```
public String generateJoinSql(String optionalSelect,
                              Table joinTable,
                              String namespace)
```
  - generateJoinSql
```
public String generateJoinSql(Table joinTable,
                              String namespace)
```
  - generateJoinSql
```
public String generateJoinSql(String optionalSelect,
                              Table joinTable,
                              String joinType,
                              String namespace,
                              String fieldName,
                              boolean prefixTableName)
```
    Constructs a join clause to use in conjunction with generateJoinSql(com.conveyal.gtfs.loader.Table, java.lang.String, java.lang.String, boolean). By default the join type is "INNER JOIN" and the join field is whatever the table instance's key field is. Both of those defaults can be overridden with the other overloaded methods.
    
    Parameters:
    
    optionalSelect - optional select query to pre-select the join table
    
    joinTable - the Table to join with
    
    joinType - type of join (e.g., INNER JOIN, OUTER LEFT JOIN, etc.)
    
    namespace - feedId (or schema prefix)
    
    fieldName - the field to join on (default's to key field)
    
    prefixTableName - whether to prefix this table's name with the schema (helpful if this join follows a previous join that renamed the table by dropping the schema/namespace
    
    Returns:
    
    a fully formed join clause that can be appended to a select statement
  - generateDeleteSql
```
public String generateDeleteSql(String namespace)
```
  - generateDeleteSql
```
public String generateDeleteSql(String namespace,
                                String fieldName)
```
    Generate delete SQL string.
  - getFieldForName
```
public Field getFieldForName(String name)
```
    Parameters:
    
    name - a column name from the header of a CSV file
    
    Returns:
    
    the Field object from this table with the given name. If there is no such field defined, create a new Field object for this name.
  - getKeyFieldName
```
public String getKeyFieldName()
```
    Gets the key field for the table. Calling this on a table that has no key field is meaningless. WARNING: this MUST be called on a spec table (i.e., one of the constant tables defined in this class). Otherwise, it could return a non-key field. FIXME: Should this return null if hasUniqueKeyField is false? Not sure what might break if we change this...
  - getOrderFieldName
```
public String getOrderFieldName()
```
    Returns field name that defines order for grouped entities or that defines the compound key field (e.g., transfers#to_stop_id). WARNING: this field must be in the 1st position (base zero) of the fields array; hence, this MUST be called on a spec table (i.e., one of the constant tables defined in this class). Otherwise, it could return null even if the table has an order field defined.
  - getIndexFields
```
public String getIndexFields()
```
    Gets index fields for the spec table. WARNING: this MUST be called on a spec table (i.e., one of the constant tables defined in this class). Otherwise, it could return fields that should not be indexed.
    
    Returns:
  - getEntityClass
```
public Class<? extends Entity> getEntityClass()
```
  - getFieldIndex
```
public int getFieldIndex(String name)
```
    Finds the index of the field for this table given a string name.
    
    Returns:
    
    the index of the field or -1 if no match is found
  - hasField
```
public boolean hasField(String name)
```
    Whether a field with the provided name exists in the table's list of fields.
  - isRequired
```
public boolean isRequired()
```
  - isSpecTable
```
public boolean isSpecTable()
```
    Checks whether the table is part of the GTFS specification, i.e., it is not an internal table used for the editor (e.g., Patterns or PatternStops).
  - createIndexes
```
public void createIndexes(Connection connection,
                          String namespace)
                   throws SQLException
```
    Create indexes for table using shouldBeIndexed(), key field, and/or sequence field. WARNING: this MUST be called on a spec table (i.e., one of the constant tables defined in this class). Otherwise, the getIndexFields method could return fields that should not be indexed. FIXME: add foreign reference indexes?
    
    Throws:
    
    SQLException
  - createSqlTableFrom
```
public boolean createSqlTableFrom(Connection connection,
                                  String tableToClone)
```
    Creates a SQL table from the table to clone. This uses the SQL syntax "create table x as y" not only copies the table structure, but also the data from the original table. Creating table indexes is not handled by this method.
  - getParentTable
```
public Table getParentTable()
```
  - getFieldsFromFieldHeaders
```
public Field[] getFieldsFromFieldHeaders(String[] headers,
                                         SQLErrorStorage errorStorage)
```
    For an array of field headers, returns the matching set of Fields for a Table. If errorStorage is not null, errors related to unexpected or duplicate header names will be stored.
  - getKeyFieldIndex
```
public int getKeyFieldIndex(Field[] fields)
```
    Returns the index of the key field within the array of fields provided for a given table.
    
    Parameters:
    
    fields - array of fields (intended to be derived from the headers of a csv text file)

Class Table

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

fields

hasUniqueKeyField

AGENCY

CALENDAR

SCHEDULE_EXCEPTIONS

CALENDAR_DATES

FARE_ATTRIBUTES

FEED_INFO

ROUTES

FARE_RULES

SHAPES

PATTERNS

STOPS

PATTERN_STOP

TRANSFERS

TRIPS

STOP_TIMES

FREQUENCIES

tablesInOrder

Constructor Detail

Table

Method Detail

restrictDelete

keyFieldIsNotUnique

hasCompoundKey

addPrimaryKey

editorFields

requiredFields

specFields

isCascadeDeleteRestricted

createSqlTable

createSqlTable

createSqlTable

createSqlTable

generateInsertSql

generateInsertSql

generateInsertSql

getCsvReader

commaSeparatedNames

commaSeparatedNames

generateUpdateSql

generateSelectSql

generateSelectAllSql

generateSelectAllExistingFieldsSql

generateJoinSql

generateJoinSql

generateJoinSql

generateJoinSql

generateDeleteSql

generateDeleteSql

getFieldForName

getKeyFieldName

getOrderFieldName

getIndexFields

getEntityClass

getFieldIndex

hasField

isRequired

isSpecTable

createIndexes

createSqlTableFrom

getParentTable

getFieldsFromFieldHeaders

getKeyFieldIndex