com.conveyal.gtfs.model

Class Entity

java.lang.Object

com.conveyal.gtfs.model.Entity

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Agency, Calendar, CalendarDate, FareAttribute, FareRule, FeedInfo, Frequency, Pattern, PatternStop, Route, ScheduleException, ShapePoint, Stop, StopTime, Transfer, Trip

public abstract class Entity
extends Object
implements Serializable

An abstract base class that represents a row in a GTFS table, e.g. a Stop, Trip, or Agency. One concrete subclass is defined for each table in a GTFS feed.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Entity.Loader<E extends Entity>
static class	Entity.Writer<E extends Entity> Write this entity to a CSV file.

Field Summary

Fields

Modifier and Type	Field and Description
static double	DOUBLE_MISSING
int	id Represents the csv line for feeds that have been loaded from a zip file.
static int	INT_MISSING

Constructor Summary

Constructors

Constructor and Description
Entity()

Method Summary

Modifier and Type	Method and Description
String	getId() This method should be overridden by each Entity subtype to return the proper key field for that subtype.
Integer	getSequenceNumber() This method should be overridden by each Entity subtype to return the proper sequence field for that subtype.
static String	human(long n)
static void	setDoubleParameter(PreparedStatement statement, int oneBasedIndex, double value)
static void	setIntParameter(PreparedStatement statement, int oneBasedIndex, int value)
abstract void	setStatementParameters(PreparedStatement statement, boolean setDefaultId) This method should be overridden by each Entity subtybe to handle setting parameters for a prepared statement created from the entity table constants defined in Table.

Methods inherited from class java.lang.Object

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

Field Detail

INT_MISSING

public static final int INT_MISSING

See Also:

Constant Field Values

DOUBLE_MISSING

public static final double DOUBLE_MISSING

See Also:

Constant Field Values

id

public int id

Represents the csv line for feeds that have been loaded from a zip file. Otherwise it is simply a unique ID.

Constructor Detail

Entity

public Entity()

Method Detail

getId

public String getId()

This method should be overridden by each Entity subtype to return the proper key field for that subtype.

Returns:

a key that according to the GTFS spec should uniquely identify this entity, either alone or together with a sequence number. For example stop_times and shapes have no single field that uniquely identifies a row, and the stop_sequence or shape_pt_sequence must also be considered.

getSequenceNumber

public Integer getSequenceNumber()

This method should be overridden by each Entity subtype to return the proper sequence field for that subtype.

Returns:

the integer second element of a compound key, for those elements that require one.

setStatementParameters

public abstract void setStatementParameters(PreparedStatement statement,
                                            boolean setDefaultId)
                                     throws SQLException

This method should be overridden by each Entity subtybe to handle setting parameters for a prepared statement created from the entity table constants defined in Table.

Throws:

SQLException

setIntParameter

public static void setIntParameter(PreparedStatement statement,
                                   int oneBasedIndex,
                                   int value)
                            throws SQLException

Throws:

SQLException

setDoubleParameter

public static void setDoubleParameter(PreparedStatement statement,
                                      int oneBasedIndex,
                                      double value)
                               throws SQLException

Throws:

SQLException

human

public static final String human(long n)