org.transitime.db.structs

Class TripPattern

java.lang.Object

org.transitime.db.structs.TripPattern

All Implemented Interfaces:

java.io.Serializable, org.hibernate.classic.Lifecycle

@Entity
public class TripPattern
extends java.lang.Object
implements java.io.Serializable, org.hibernate.classic.Lifecycle

A trip pattern, as obtained from stop_times.txt GTFS file. A trip pattern defines what stops are associated with a trip. Trip pattern reduces the amount of data needed to describe an agency since trips usually can share trip patterns.

Author:

SkiBu Smith

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	TRIP_PATTERN_ID_LENGTH

Fields inherited from interface org.hibernate.classic.Lifecycle

NO_VETO, VETO

Constructor Summary

Constructors

Constructor and Description
TripPattern(int configRev, java.lang.String shapeId, java.util.List<StopPath> stopPaths, Trip trip, GtfsData gtfsData) Create a TripPattern.

Method Summary

Modifier and Type	Method and Description
void	addTrip(Trip trip) When processing a new trip let the TripPattern know that this additional Trip refers to it.
static int	deleteFromRev(org.hibernate.Session session, int configRev) Deletes rev from the TripPattern_to_Path_joinTable, StopPaths, and TripPatterns tables.
boolean	equals(java.lang.Object obj)
int	getConfigRev()
java.lang.String	getDirectionId() Optional element direction_id specified in trips.txt GTFS file.
Extent	getExtent() The extent of all of the stops that make up the trip pattern
java.lang.String	getHeadsign() Usually from the trip_headsign from the trips.txt file
java.lang.String	getId()
double	getLength() Returns length of the trip from the first terminal to the last.
int	getNumberStopPaths() Returns the number of stopPaths/stops configured.
java.lang.String	getRouteId()
java.lang.String	getRouteShortName()
java.lang.String	getShapeId()
java.lang.String	getStopId(int i) Gets the stopId of the specified stop
java.util.List<java.lang.String>	getStopIds() Returns list of stop IDs for the stop paths for this trip pattern.
java.lang.String	getStopName(int i) Gets the name of the specified stop as obtained by a Core predictor.
StopPath	getStopPath(int index)
StopPath	getStopPath(java.lang.String stopId) Returns the StopPath for this TripPattern as specified by the stopId parameter.
java.lang.String	getStopPathId(int i) Gets the pathId of the specified stop
java.util.List<StopPath>	getStopPaths()
static java.util.List<TripPattern>	getTripPatterns(org.hibernate.Session session, int configRev) Returns list of TripPattern objects for the specified configRev
java.util.List<Trip>	getTrips() NOTE: the Trip List is not available when the object has been read from the database.
int	hashCode()
boolean	isStopAtOrAfterStop(java.lang.String stopId1, java.lang.String stopId2) Returns true if for this TripPattern that stopId2 is after stopId1.
boolean	onDelete(org.hibernate.Session arg0)
void	onLoad(org.hibernate.Session arg0, java.io.Serializable arg1)
boolean	onSave(org.hibernate.Session arg0)
boolean	onUpdate(org.hibernate.Session arg0)
boolean	servesStop(java.lang.String stopId) Returns true if this trip pattern includes the specified stopId.
java.lang.String	toShortString() For when don't want to display the entire contents of TripPattern, which can be pretty large because contains list of stops and trips.
java.lang.String	toString()
java.lang.String	toStringListingTripIds() A short version of the Trip string.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

TRIP_PATTERN_ID_LENGTH

public static final int TRIP_PATTERN_ID_LENGTH

See Also:

Constant Field Values

Constructor Detail

TripPattern

public TripPattern(int configRev,
                   java.lang.String shapeId,
                   java.util.List<StopPath> stopPaths,
                   Trip trip,
                   GtfsData gtfsData)

Create a TripPattern. For when processing GTFS data. Note: The name comes from the trip trip_headsign data. If not set then uses name of last stop for trip.

Parameters:

configRev -

shapeId - Part of what identifies the trip pattern

stopPaths - Part of what identifies the trip pattern

trip - For supplying additional info

gtfsData - So can access stop data for determining extent of trip pattern.

Method Detail

deleteFromRev

public static int deleteFromRev(org.hibernate.Session session,
                                int configRev)
                         throws org.hibernate.HibernateException

Deletes rev from the TripPattern_to_Path_joinTable, StopPaths, and TripPatterns tables.

Parameters:

session -

configRev -

Returns:

Number of rows deleted

Throws:

org.hibernate.HibernateException

getTripPatterns

public static java.util.List<TripPattern> getTripPatterns(org.hibernate.Session session,
                                                          int configRev)
                                                   throws org.hibernate.HibernateException

Returns list of TripPattern objects for the specified configRev

Parameters:

session -

configRev -

Returns:

Throws:

org.hibernate.HibernateException

addTrip

public void addTrip(Trip trip)

When processing a new trip let the TripPattern know that this additional Trip refers to it.

Parameters:

gtfsTrip -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toShortString

public java.lang.String toShortString()

For when don't want to display the entire contents of TripPattern, which can be pretty large because contains list of stops and trips.

Returns:

A short version of the TripPattern object

toStringListingTripIds

public java.lang.String toStringListingTripIds()

A short version of the Trip string. Only includes the name and a list of the trip ids.

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

servesStop

public boolean servesStop(java.lang.String stopId)

Returns true if this trip pattern includes the specified stopId.

Parameters:

stopId -

Returns:

getStopPath

public StopPath getStopPath(java.lang.String stopId)

Returns the StopPath for this TripPattern as specified by the stopId parameter. Uses a map so is reasonably fast. Synchronized to make sure that only a single thread can initialize the transient map.

Parameters:

stopId -

Returns:

The StopPath specified by the stop ID, or null if this TripPattern does not contain that stop.

isStopAtOrAfterStop

public boolean isStopAtOrAfterStop(java.lang.String stopId1,
                                   java.lang.String stopId2)

Returns true if for this TripPattern that stopId2 is after stopId1. If either stopId1 or stopId2 are not in the trip pattern then false is returned.

Parameters:

stopId1 -

stopId2 -

Returns:

True if stopId2 is after stopId1

getConfigRev

public int getConfigRev()

Returns:

the configRev

getStopPaths

public java.util.List<StopPath> getStopPaths()

Returns:

the List of the stop paths for the trip pattern

getStopIds

public java.util.List<java.lang.String> getStopIds()

Returns list of stop IDs for the stop paths for this trip pattern.

Returns:

getLength

public double getLength()

Returns length of the trip from the first terminal to the last.

Returns:

getStopPath

public StopPath getStopPath(int index)

Parameters:

index -

Returns:

The specified StopPath or null if index out of range

getNumberStopPaths

public int getNumberStopPaths()

Returns the number of stopPaths/stops configured.

Returns:

getStopId

public java.lang.String getStopId(int i)

Gets the stopId of the specified stop

Parameters:

i -

Returns:

getStopName

public java.lang.String getStopName(int i)

Gets the name of the specified stop as obtained by a Core predictor. Cannot be used with other applications.

Parameters:

i -

Returns:

getStopPathId

public java.lang.String getStopPathId(int i)

Gets the pathId of the specified stop

Parameters:

i -

Returns:

getShapeId

public java.lang.String getShapeId()

Returns:

shapeId which is the shape_id from the trip used to create this trip pattern.

getId

public java.lang.String getId()

Returns:

the id which is of the form "stopId1_to_stopIds"

getRouteId

public java.lang.String getRouteId()

Returns:

routeId, the id of the route

getRouteShortName

public java.lang.String getRouteShortName()

Returns:

routeShortName, which varies less across schedule changes than the routeId

getHeadsign

public java.lang.String getHeadsign()

Usually from the trip_headsign from the trips.txt file

Returns:

name, the title of the trip pattern

getDirectionId

public java.lang.String getDirectionId()

Optional element direction_id specified in trips.txt GTFS file.

Returns:

direction_id. Will be null if not specified in GTFS data

getTrips

public java.util.List<Trip> getTrips()

NOTE: the Trip List is not available when the object has been read from the database. It is only available while actually processing the GTFS data.

Returns:

trips, the list of the trips that use the trip pattern

getExtent

public Extent getExtent()

The extent of all of the stops that make up the trip pattern

Returns:

extent

onDelete

public boolean onDelete(org.hibernate.Session arg0)
                 throws org.hibernate.CallbackException

Specified by:

onDelete in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException

onLoad

public void onLoad(org.hibernate.Session arg0,
                   java.io.Serializable arg1)

Specified by:

onLoad in interface org.hibernate.classic.Lifecycle

onSave

public boolean onSave(org.hibernate.Session arg0)
               throws org.hibernate.CallbackException

Specified by:

onSave in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException

onUpdate

public boolean onUpdate(org.hibernate.Session arg0)
                 throws org.hibernate.CallbackException

Specified by:

onUpdate in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException