org.transitime.db.structs

Class Trip

java.lang.Object

org.transitime.db.structs.Trip

All Implemented Interfaces:

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

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

Describes a GTFS trip but also includes travel time information.

Serializable since Hibernate requires such.

Implements Lifecycle so that can have the onLoad() callback be called when reading in data so that can intern() member strings. In order to do this the String members could not be declared as final since they are updated after the constructor is called.

Author:

SkiBu Smith

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.hibernate.classic.Lifecycle

NO_VETO, VETO

Constructor Summary

Constructors

Constructor and Description
Trip(int configRev, GtfsTrip gtfsTrip, java.lang.String properRouteId, java.lang.String routeShortName, TitleFormatter titleFormatter) Constructs Trip object from GTFS data.
Trip(Trip tripFromStopTimes, int frequenciesBasedStartTime) Creates a copy of the Trip object but adjusts the startTime, endTime, and scheduledTimesMap according to the frequenciesBasedStartTime.
Trip(Trip tripFromStopTimes, int frequenciesBasedStartTime, int frequenciesBasedEndTime) Creates a copy of the Trip object but adjusts the startTime, endTime, and scheduledTimesMap according to the frequenciesBasedStartTime.

Method Summary

Modifier and Type	Method and Description
void	addScheduleTimes(java.util.List<ScheduleTime> newScheduledTimesList) For adding ScheduleTimes for stops to a Trip.
static int	deleteFromRev(org.hibernate.Session session, int configRev) Deletes rev from the Trips table
boolean	equals(java.lang.Object obj) Required by Hibernate
Block	getBlock() Returns the Block that the Trip is associated with.
java.lang.String	getBlockId() The block_id is an optional element in GTFS trips.txt file.
int	getConfigRev()
java.lang.String	getDirectionId()
java.lang.Integer	getEndTime() Returns arrival time of last stop of trip.
java.lang.String	getHeadsign() The trip_headsign value from the trips.txt file.
java.lang.String	getId()
int	getIndexInBlock() Returns the index of the trip in the block.
double	getLength() Returns length of the trip from the first terminal to the last.
int	getNumberStopPaths() Returns number of stop paths defined for this trip.
Route	getRoute() Returns the Route object for this trip.
java.lang.String	getRouteId()
java.lang.String	getRouteName() Returns route name.
java.lang.String	getRouteShortName() Returns the routeShortName.
ScheduleTime	getScheduleTime(int stopPathIndex) Returns the ScheduleTime object for the stopPathIndex.
java.util.List<ScheduleTime>	getScheduleTimes()
java.lang.String	getServiceId()
java.lang.String	getShapeId()
java.lang.String	getShortName()
java.lang.Integer	getStartTime() Returns departure time of first stop of trip.
StopPath	getStopPath(int stopPathIndex) Returns the StopPath for the stopPathIndex specified
StopPath	getStopPath(java.lang.String stopId) Returns the StopPath specified by the stopId.
java.util.List<StopPath>	getStopPaths() Returns the List of the stop paths for the trip pattern
TravelTimesForTrip	getTravelTimes()
TravelTimesForStopPath	getTravelTimesForStopPath(int stopPathIndex) Returns the travel time info for the path specified by the stopPathIndex.
static Trip	getTrip(org.hibernate.Session session, int configRev, java.lang.String tripId) Returns specified Trip object for the specified configRev and tripId.
static Trip	getTripByShortName(org.hibernate.Session session, int configRev, java.lang.String tripShortName) Returns specified Trip object for the specified configRev and tripShortName.
TripPattern	getTripPattern()
static java.util.Map<java.lang.String,Trip>	getTrips(org.hibernate.Session session, int configRev) Returns map of Trip objects for the specified configRev.
int	hashCode() Required by Hibernate
boolean	isExactTimesHeadway()
boolean	isNoSchedule()
boolean	onDelete(org.hibernate.Session s) Implemented due to Lifecycle interface being implemented.
void	onLoad(org.hibernate.Session s, java.io.Serializable id) Callback due to implementing Lifecycle interface.
boolean	onSave(org.hibernate.Session s) Implemented due to Lifecycle interface being implemented.
boolean	onUpdate(org.hibernate.Session s) Implemented due to Lifecycle interface being implemented.
void	setTravelTimes(TravelTimesForTrip travelTimes) TravelTimesForTrip created after the Trip.
void	setTripPattern(TripPattern tripPattern) TripPattern is created after the Trip.
java.lang.String	toLongString() Similar to toString() but also includes full TripPattern and travelTimes
java.lang.String	toShortString() Similar to toString() but doesn't include scheduledTimesMap which can be quite verbose since it often contains times for many stops.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Trip

public Trip(int configRev,
            GtfsTrip gtfsTrip,
            java.lang.String properRouteId,
            java.lang.String routeShortName,
            TitleFormatter titleFormatter)

Constructs Trip object from GTFS data.

Does not set startTime nor endTime. Those are set separately using addScheduleTimes(). Also doesn't set travel times. Those are set separately using setTravelTimes().

Parameters:

configRev -

gtfsTrip - The GTFS data describing the trip

properRouteId - The routeId, but can actually be the ID of the parent route.

routeShortName - Needed to provide a route identifier that is consistent over schedule changes.

titleFormatter - So can fix titles associated with trip

Trip

public Trip(Trip tripFromStopTimes,
            int frequenciesBasedStartTime)

Creates a copy of the Trip object but adjusts the startTime, endTime, and scheduledTimesMap according to the frequenciesBasedStartTime. This is used when the frequencies.txt file specifies exact_times for a trip.

Parameters:

tripFromStopTimes -

frequenciesBasedStartTime -

Trip

public Trip(Trip tripFromStopTimes,
            int frequenciesBasedStartTime,
            int frequenciesBasedEndTime)

Creates a copy of the Trip object but adjusts the startTime, endTime, and scheduledTimesMap according to the frequenciesBasedStartTime. This is used when the frequencies.txt specifies a time range for a trip but where exact_times is false. This is for noSchedule routes where vehicle is expected to continuously run on a route without a schedule.

Parameters:

tripFromStopTimes -

frequenciesBasedStartTime -

frequenciesBasedEndTime -

Method Detail

addScheduleTimes

public void addScheduleTimes(java.util.List<ScheduleTime> newScheduledTimesList)

For adding ScheduleTimes for stops to a Trip. Updates scheduledTimesMap, startTime, and endTime.

Parameters:

newScheduledTimesList -

Throws:

java.lang.ArrayIndexOutOfBoundsException - If not enough space allocated for serialized schedule times in scheduledTimesMap column

setTripPattern

public void setTripPattern(TripPattern tripPattern)

TripPattern is created after the Trip. Therefore it cannot be set in constructor and instead needs this set method.

Parameters:

tripPattern -

setTravelTimes

public void setTravelTimes(TravelTimesForTrip travelTimes)

TravelTimesForTrip created after the Trip. Therefore it cannot be set in constructor and instead needs this set method.

Parameters:

travelTimes -

getTrips

public static java.util.Map<java.lang.String,Trip> getTrips(org.hibernate.Session session,
                                                            int configRev)
                                                     throws org.hibernate.HibernateException

Returns map of Trip objects for the specified configRev. The map is keyed on the trip IDs.

Parameters:

session -

configRev -

Returns:

Throws:

org.hibernate.HibernateException

getTrip

public static Trip getTrip(org.hibernate.Session session,
                           int configRev,
                           java.lang.String tripId)
                    throws org.hibernate.HibernateException

Returns specified Trip object for the specified configRev and tripId.

Parameters:

session -

configRev -

tripId -

Returns:

Throws:

org.hibernate.HibernateException

getTripByShortName

public static Trip getTripByShortName(org.hibernate.Session session,
                                      int configRev,
                                      java.lang.String tripShortName)
                               throws org.hibernate.HibernateException

Returns specified Trip object for the specified configRev and tripShortName.

Parameters:

session -

configRev -

tripShortName -

Returns:

The Trip or null if no such trip

Throws:

org.hibernate.HibernateException

deleteFromRev

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

Deletes rev from the Trips table

Parameters:

session -

configRev -

Returns:

Number of rows deleted

Throws:

org.hibernate.HibernateException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toLongString

public java.lang.String toLongString()

Similar to toString() but also includes full TripPattern and travelTimes

Returns:

toShortString

public java.lang.String toShortString()

Similar to toString() but doesn't include scheduledTimesMap which can be quite verbose since it often contains times for many stops.

Returns:

hashCode

public int hashCode()

Required by Hibernate

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Required by Hibernate

Overrides:

equals in class java.lang.Object

getStartTime

public java.lang.Integer getStartTime()

Returns departure time of first stop of trip. Gtfs requires departure time of first stop of trip and arrival time of last stop of trip to be set, even for unscheduled blocks. That way they can determine running time of trip.

Returns:

departure time of first stop of trip. Time is seconds into the day. Can be null.

getEndTime

public java.lang.Integer getEndTime()

Returns arrival time of last stop of trip. Gtfs requires departure time of first stop of trip and arrival time of last stop of trip to be set, even for unscheduled blocks. That way they can determine running time of trip.

Returns:

arrival time of last stop of trip. Time is seconds into the day. Can be null.

getConfigRev

public int getConfigRev()

Returns:

the configRev

getId

public java.lang.String getId()

Returns:

the tripId

getShortName

public java.lang.String getShortName()

Returns:

the tripShortName

getRouteId

public java.lang.String getRouteId()

Returns:

the routeId

getRouteShortName

public java.lang.String getRouteShortName()

Returns the routeShortName. If it is null then returns the full route name.

Returns:

the routeShortName

getRoute

public Route getRoute()

Returns the Route object for this trip. This object is determined and cached when first accessed. Uses value read in from database using Core, which means that it won't be available when processing GTFS data since that doesn't have core object.

Returns:

The route or null if no Core object available

getRouteName

public java.lang.String getRouteName()

Returns route name. Gets it from the Core database configuration. If Core database configuration not available such as when processing GTFS data then will return null.

Returns:

The route name or null if Core object not available

getDirectionId

public java.lang.String getDirectionId()

Returns:

the directionId

isNoSchedule

public boolean isNoSchedule()

Returns:

noSchedule

isExactTimesHeadway

public boolean isExactTimesHeadway()

Returns:

exactTimesHeadway

getServiceId

public java.lang.String getServiceId()

Returns:

the serviceId

getHeadsign

public java.lang.String getHeadsign()

The trip_headsign value from the trips.txt file. But it has been processed by the TitleFormatter to correct capitalization and such.

Returns:

the name

getBlockId

public java.lang.String getBlockId()

The block_id is an optional element in GTFS trips.txt file. If it is available it is used. But if it is not then the trip_id is used as next best thing.

Returns:

blockId

getBlock

public Block getBlock()

Returns the Block that the Trip is associated with. Only valid when running the core application where can use Core.getInstance(). Otherwise returns null.

Returns:

getIndexInBlock

public int getIndexInBlock()

Returns the index of the trip in the block. Uses DbConfig from the core project to determine the Block. If not part of the core project the Block info is not available and -1 is returned.

Returns:

The index of the trip in the block or -1 if block info not available.

getShapeId

public java.lang.String getShapeId()

Returns:

the shapeId

getTripPattern

public TripPattern getTripPattern()

Returns:

the tripPattern

getScheduleTime

public ScheduleTime getScheduleTime(int stopPathIndex)

Returns the ScheduleTime object for the stopPathIndex. Will return null if there are no schedule times associated with that stop for this trip. Useful for determining schedule adherence.

Parameters:

stopPathIndex -

Returns:

getScheduleTimes

public java.util.List<ScheduleTime> getScheduleTimes()

Returns:

list of schedule times for the trip

getTravelTimes

public TravelTimesForTrip getTravelTimes()

Returns:

the travelTimes

getTravelTimesForStopPath

public TravelTimesForStopPath getTravelTimesForStopPath(int stopPathIndex)

Returns the travel time info for the path specified by the stopPathIndex.

Parameters:

stopPathIndex -

Returns:

getLength

public double getLength()

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

Returns:

getStopPaths

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

Returns the List of the stop paths for the trip pattern

Returns:

getStopPath

public StopPath getStopPath(int stopPathIndex)

Returns the StopPath for the stopPathIndex specified

Parameters:

stopPathIndex -

Returns:

the path specified or null if index out of range

getStopPath

public StopPath getStopPath(java.lang.String stopId)

Returns the StopPath specified by the stopId.

Parameters:

stopId -

Returns:

The specified StopPath, or null if the stop is not part of this trip pattern.

getNumberStopPaths

public int getNumberStopPaths()

Returns number of stop paths defined for this trip.

Returns:

Number of stop paths

onLoad

public void onLoad(org.hibernate.Session s,
                   java.io.Serializable id)
            throws org.hibernate.CallbackException

Callback due to implementing Lifecycle interface. Used to compact string members by interning them.

Specified by:

onLoad in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException

onSave

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

Implemented due to Lifecycle interface being implemented. Not actually used.

Specified by:

onSave in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException

onUpdate

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

Implemented due to Lifecycle interface being implemented. Not actually used.

Specified by:

onUpdate in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException

onDelete

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

Implemented due to Lifecycle interface being implemented. Not actually used.

Specified by:

onDelete in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException