org.transitime.db.structs

Class TravelTimesForTrip

java.lang.Object

org.transitime.db.structs.TravelTimesForTrip

All Implemented Interfaces:

java.io.Serializable

@Entity
public class TravelTimesForTrip
extends java.lang.Object
implements java.io.Serializable

Keeps track of travel times for a trip. Can be shared amongst trips if the travel times are similar. But need separate travel times for every trip pattern.

Author:

SkiBu Smith

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TravelTimesForTrip(int configRev, int travelTimesRev, Trip trip) Simple constructor.

Method Summary

Modifier and Type	Method and Description
void	add(TravelTimesForStopPath travelTimesForPath) For when creating a new TravelTimesForTrip.
static int	deleteFromRev(org.hibernate.Session session, int configRev) Deletes data from the TravelTimesForTrip and the TravelTimesForTrip_to_TravelTimesForPath_jointable.
boolean	equals(java.lang.Object obj) Needed because of Hibernate and also because want to cache TravelTimesForTrip and to do so need to store the objects as keys in a map and need hashCode() and equals() for doing that properly.
int	getConfigRev() Getter Methods
int	getTravelTimeRev()
TravelTimesForStopPath	getTravelTimesForStopPath(int index)
java.util.List<TravelTimesForStopPath>	getTravelTimesForStopPaths()
static java.util.Map<java.lang.String,java.util.List<TravelTimesForTrip>>	getTravelTimesForTrips(org.hibernate.Session session, int travelTimesRev) Returns Map keyed by tripPatternId of Lists of TravelTimesForTrip.
java.lang.String	getTripCreatedForId()
java.lang.String	getTripPatternId()
int	hashCode() Needed because of Hibernate and also because want to cache TravelTimesForTrip and to do so need to store the objects as keys in a map and need hashCode() and equals() for doing that properly.
int	numberOfStopPaths()
boolean	purelyScheduleBased() Returns true if every single stop path travel time is schedule based.
java.lang.String	toString()
java.lang.String	toStringWithNewlines() Similar to toString() but puts each travelTimesForStopPath on a separate line to try to make the output more readable.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TravelTimesForTrip

public TravelTimesForTrip(int configRev,
                          int travelTimesRev,
                          Trip trip)

Simple constructor.

Parameters:

configRev -

travelTimesRev -

trip - So can determine trip pattern ID and set which trip this was created for.

Method Detail

add

public void add(TravelTimesForStopPath travelTimesForPath)

For when creating a new TravelTimesForTrip. This method is for adding each TravelTimesForStopPath.

Parameters:

travelTimesForPath -

deleteFromRev

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

Deletes data from the TravelTimesForTrip and the TravelTimesForTrip_to_TravelTimesForPath_jointable.

Parameters:

session -

configRev -

Returns:

Throws:

org.hibernate.HibernateException

getTravelTimesForTrips

public static java.util.Map<java.lang.String,java.util.List<TravelTimesForTrip>> getTravelTimesForTrips(org.hibernate.Session session,
                                                                                                        int travelTimesRev)
                                                                                                 throws org.hibernate.HibernateException

Returns Map keyed by tripPatternId of Lists of TravelTimesForTrip. Since there are usually multiple trips per trip pattern the Map contains a List of TravelTimesForTrip instead of just a single one.

Parameters:

session -

travelTimesRev -

Returns:

Map keyed by tripPatternId of Lists of TripPatterns

Throws:

org.hibernate.HibernateException

purelyScheduleBased

public boolean purelyScheduleBased()

Returns true if every single stop path travel time is schedule based.

Returns:

hashCode

public int hashCode()

Needed because of Hibernate and also because want to cache TravelTimesForTrip and to do so need to store the objects as keys in a map and need hashCode() and equals() for doing that properly.

Note that not comparing tripCreatedForId. This is VERY IMPORTANT because when caching TravelTimesForTrip don't need to the tripCreatedForId to match. This is the only way that can used cached values for other trips when processing historic travel data.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Needed because of Hibernate and also because want to cache TravelTimesForTrip and to do so need to store the objects as keys in a map and need hashCode() and equals() for doing that properly.

Note that not comparing tripCreatedForId. This is VERY IMPORTANT because when caching TravelTimesForTrip don't need to the tripCreatedForId to match. This is the only way that can used cached values for other trips when processing historic travel data.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringWithNewlines

public java.lang.String toStringWithNewlines()

Similar to toString() but puts each travelTimesForStopPath on a separate line to try to make the output more readable.

Returns:

getConfigRev

public int getConfigRev()

Getter Methods

getTravelTimeRev

public int getTravelTimeRev()

getTripPatternId

public java.lang.String getTripPatternId()

getTripCreatedForId

public java.lang.String getTripCreatedForId()

getTravelTimesForStopPaths

public java.util.List<TravelTimesForStopPath> getTravelTimesForStopPaths()

getTravelTimesForStopPath

public TravelTimesForStopPath getTravelTimesForStopPath(int index)

numberOfStopPaths

public int numberOfStopPaths()

Returns:

Number of stopPaths in trip