org.transitime.gtfs.gtfsStructs

Class GtfsRoute

java.lang.Object

org.transitime.utils.csv.CsvBase

org.transitime.gtfs.gtfsStructs.GtfsRoute

@Immutable
public class GtfsRoute
extends CsvBase

A GTFS routes object. Contains two extension columns beyond the GTFS spec. These are rout.order and hidden. They are useful for the user interface. They will usually be set using a supplemental routes file.

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
GtfsRoute(org.apache.commons.csv.CSVRecord record, boolean supplementalFile, java.lang.String fileName) Creates a GtfsRoute object by reading the data from the CSVRecord.
GtfsRoute(GtfsRoute originalRoute, GtfsRoute supplementRoute) When combining a regular route with a supplemental route need to create a whole new object since this class is Immutable to make it safer to use.
GtfsRoute(java.lang.String routeId, java.lang.String agencyId, java.lang.String routeShortName, java.lang.String routeLongName, java.lang.String routeType, java.lang.String routeColor, java.lang.String routeTextColor) For creating a GtfsStop object from scratch.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAgencyId()
java.lang.Integer	getBreakTime() Returns the minimum time that drivers get as a break time for layovers for the route.
boolean	getHidden() Returns if route should be hidden from user interface for the public.
java.lang.Double	getMaxDistance() 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	getParentRouteId() Some agencies create several entries for a single route.
java.lang.String	getRouteColor()
java.lang.String	getRouteDesc()
java.lang.String	getRouteId()
java.lang.String	getRouteLongName()
java.lang.Integer	getRouteOrder() Returns optional route_order or null if not set.
java.lang.String	getRouteShortName() Returns the route short name.
java.lang.String	getRouteTextColor()
java.lang.String	getRouteType()
java.lang.String	getRouteURL()
java.lang.String	getUnscheduledBlockSuffix() Returns suffix to use if should create unscheduled block assignments for this route.
boolean	shouldCreateUnscheduledBlock() Returns true if should create unscheduled block assignments for this route.
boolean	shouldRemove() Returns if route should be removed from configuration so it doesn't show up at all
java.lang.String	toString()

Methods inherited from class org.transitime.utils.csv.CsvBase

getFileName, getLineNumber

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GtfsRoute

public GtfsRoute(java.lang.String routeId,
                 java.lang.String agencyId,
                 java.lang.String routeShortName,
                 java.lang.String routeLongName,
                 java.lang.String routeType,
                 java.lang.String routeColor,
                 java.lang.String routeTextColor)

For creating a GtfsStop object from scratch.

GtfsRoute

public GtfsRoute(org.apache.commons.csv.CSVRecord record,
                 boolean supplementalFile,
                 java.lang.String fileName)

Creates a GtfsRoute object by reading the data from the CSVRecord.

Parameters:

record -

supplemental -

fileName - for logging errors

GtfsRoute

public GtfsRoute(GtfsRoute originalRoute,
                 GtfsRoute supplementRoute)

When combining a regular route with a supplemental route need to create a whole new object since this class is Immutable to make it safer to use.

Parameters:

originalRoute -

supplementRoute -

Method Detail

getRouteId

public java.lang.String getRouteId()

getAgencyId

public java.lang.String getAgencyId()

getRouteShortName

public java.lang.String getRouteShortName()

Returns the route short name. Can be null.

Returns:

getRouteLongName

public java.lang.String getRouteLongName()

getRouteDesc

public java.lang.String getRouteDesc()

getRouteType

public java.lang.String getRouteType()

getRouteURL

public java.lang.String getRouteURL()

getRouteColor

public java.lang.String getRouteColor()

getRouteTextColor

public java.lang.String getRouteTextColor()

getRouteOrder

public java.lang.Integer getRouteOrder()

Returns optional route_order or null if not set.

Returns:

getParentRouteId

public java.lang.String getParentRouteId()

Some agencies create several entries for a single route. For example, they might have a 3 different trip patterns so they use 3 separate routes, but they have the same title. In this case the routes should be combined.

Returns:

route_id of the parent route

getHidden

public boolean getHidden()

Returns if route should be hidden from user interface for the public.

Returns:

shouldRemove

public boolean shouldRemove()

Returns if route should be removed from configuration so it doesn't show up at all

Returns:

shouldCreateUnscheduledBlock

public boolean shouldCreateUnscheduledBlock()

Returns true if should create unscheduled block assignments for this route.

Returns:

getUnscheduledBlockSuffix

public java.lang.String getUnscheduledBlockSuffix()

Returns suffix to use if should create unscheduled block assignments for this route.

Returns:

The suffix to use for the block assignments

getBreakTime

public java.lang.Integer getBreakTime()

Returns the minimum time that drivers get as a break time for layovers for the route. Affects predictions.

Returns:

The break time, or null if not set for route

getMaxDistance

public java.lang.Double getMaxDistance()

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

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object