org.transitime.db.structs

Class Route

java.lang.Object

org.transitime.db.structs.Route

All Implemented Interfaces:

java.io.Serializable

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

For storing in db information for a route. Based on GTFS information from routes.txt and other files.

Author:

SkiBu Smith

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Route(int configRev, GtfsRoute gtfsRoute, java.util.List<TripPattern> tripPatternsForRoute, TitleFormatter titleFormatter, boolean shouldCombineShortAndLongNamesForRoutes) Constructor.

Method Summary

Modifier and Type	Method and Description
static int	deleteFromRev(org.hibernate.Session session, int configRev) Deletes rev from the Routes table
boolean	equals(java.lang.Object obj) Needed because have a composite ID for Hibernate storage
java.lang.String	getColor()
int	getConfigRev()
java.lang.String	getDescription()
java.util.List<java.lang.String>	getDirectionIds() Returns list of direction IDs for the route.
Extent	getExtent()
java.lang.String	getId()
TripPattern	getLongestTripPatternForDirection(java.lang.String directionId) Returns longest trip pattern for the directionId specified.
java.util.List<TripPattern>	getLongestTripPatternForEachDirection() Returns the longest trip pattern for each direction ID for the route.
double	getMaxAllowableDistanceFromSegment() For specifying on a per route basis how far AVL report can be from segment and still have it be considered a match.
java.lang.String	getName()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getOrderedStopsByDirection() For each GTFS direction ID returns list of stops that in the appropriate order for the direction.
java.util.Collection<Vector>	getPathSegments() Returns unordered collection of path vectors associated with route
java.lang.Integer	getRouteOrder()
static java.util.List<Route>	getRoutes(org.hibernate.Session session, int configRev) Returns List of Route objects for the specified database revision.
java.lang.String	getShortName() The short name is either specified by route_short_name in the routes.txt GTFS file or if that is null it will be the long name name.
java.util.Collection<Stop>	getStops() Returns unordered collection of stops associated with route.
java.lang.String	getTextColor()
TripPattern	getTripPattern(java.lang.String tripPatternId) Returns the specified trip pattern, or null if that trip pattern doesn't exist for the route.
java.util.List<TripPattern>	getTripPatterns(java.lang.String directionId) Returns list of trip patterns for the directionId specified.
java.lang.String	getType()
int	hashCode() Needed because have a composite ID for Hibernate storage
boolean	isHidden()
static void	main(java.lang.String[] args) Just for debugging
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Route

public Route(int configRev,
             GtfsRoute gtfsRoute,
             java.util.List<TripPattern> tripPatternsForRoute,
             TitleFormatter titleFormatter,
             boolean shouldCombineShortAndLongNamesForRoutes)

Constructor. Used for when processing GTFS data. Creates a Route object that can be written to database.

Parameters:

configRev -

gtfsRoute -

tripPatternsForRoute -

titleFormatter -

shouldCombineShortAndLongNamesForRoutes -

Method Detail

deleteFromRev

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

Deletes rev from the Routes table

Parameters:

session -

configRev -

Returns:

Number of rows deleted

Throws:

org.hibernate.HibernateException

getRoutes

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

Returns List of Route objects for the specified database revision. Orders them based on the GTFS route_order extension or the route short name if route_order not set.

Parameters:

session -

configRev -

Returns:

Map of routes keyed on routeId

Throws:

org.hibernate.HibernateException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Needed because have a composite ID for Hibernate storage

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Needed because have a composite ID for Hibernate storage

Overrides:

equals in class java.lang.Object

getStops

public java.util.Collection<Stop> getStops()

Returns unordered collection of stops associated with route.

Synchronized because caching stops.

Returns:

getTripPattern

public TripPattern getTripPattern(java.lang.String tripPatternId)

Returns the specified trip pattern, or null if that trip pattern doesn't exist for the route.

Parameters:

tripPatternId -

Returns:

getLongestTripPatternForDirection

public TripPattern getLongestTripPatternForDirection(java.lang.String directionId)

Returns longest trip pattern for the directionId specified. Note: gets trip patterns from Core, which means it works in the core application, not just when processing GTFS data.

Parameters:

directionId -

Returns:

getLongestTripPatternForEachDirection

public java.util.List<TripPattern> getLongestTripPatternForEachDirection()

Returns the longest trip pattern for each direction ID for the route. Will typically be two trip patterns since there are usually two directions per route.

Returns:

getTripPatterns

public java.util.List<TripPattern> getTripPatterns(java.lang.String directionId)

Returns list of trip patterns for the directionId specified.

Parameters:

directionId -

Returns:

getDirectionIds

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

Returns list of direction IDs for the route.

Returns:

getPathSegments

public java.util.Collection<Vector> getPathSegments()

Returns unordered collection of path vectors associated with route

Returns:

getOrderedStopsByDirection

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getOrderedStopsByDirection()

For each GTFS direction ID returns list of stops that in the appropriate order for the direction. The appropriate order means that when there are different trip patterns that the stops that are different will be inserted appropriately into the list

Returns:

Map keyed by direction ID and value of List of ordered stop IDs.

getConfigRev

public int getConfigRev()

Returns:

the configRev

getName

public java.lang.String getName()

Returns:

the name of the route

getShortName

public java.lang.String getShortName()

The short name is either specified by route_short_name in the routes.txt GTFS file or if that is null it will be the long name name.

Returns:

the short name for the route

getId

public java.lang.String getId()

Returns:

the id

getColor

public java.lang.String getColor()

Returns:

the color

getTextColor

public java.lang.String getTextColor()

Returns:

the textColor

getRouteOrder

public java.lang.Integer getRouteOrder()

Returns:

the routeOrder or null if not set

isHidden

public boolean isHidden()

Returns:

the hidden

getType

public java.lang.String getType()

Returns:

the type

getDescription

public java.lang.String getDescription()

Returns:

the description

getExtent

public Extent getExtent()

Returns:

the extent of the stops for the route

getMaxAllowableDistanceFromSegment

public double getMaxAllowableDistanceFromSegment()

For specifying on a per route basis how far AVL report can be from segment and still have it be considered a match.

Returns:

the max distance if set, otherwise NaN

main

public static void main(java.lang.String[] args)

Just for debugging

Parameters:

args -