org.transitime.gtfs.gtfsStructs

Class GtfsStop

java.lang.Object

org.transitime.utils.csv.CsvBase

org.transitime.gtfs.gtfsStructs.GtfsStop

public class GtfsStop
extends CsvBase

A GTFS stops object. Contains two extension columns beyond the GTFS spec, hidden and adherenc.stop. They are useful for the user interface. They will usually be set using a supplemental stops file.

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
GtfsStop(org.apache.commons.csv.CSVRecord record, boolean supplemental, java.lang.String fileName) Creates a GtfsStop object by reading the data from the CSVRecord.
GtfsStop(GtfsStop original, double lat, double lon) Creates a copy of the GtfsStop but updates the latitude and longitude.
GtfsStop(GtfsStop originalStop, GtfsStop supplementStop) When combining a regular stop with a supplemental stop need to create a whole new object since this class is Immutable to make it safer to use.
GtfsStop(java.lang.String stopId, java.lang.Integer stopCode, java.lang.String stopName, double lat, double lon) For creating a GtfsStop object from scratch.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDeleteFirstStopFromRoutesStr() Returns ":" separated string indicate route short names where this stop should not be included in the trips if it is the first stop of a trip.
java.lang.String	getDeleteFromRoutesStr() Returns ":" separated string indicate route short names where this stop should not be included in the trips.
java.lang.Boolean	getHidden() Specifies if stop should be hidden from the public user interface.
java.lang.Boolean	getlayoverStop() Indicates that vehicle can leave route path before departing this stop since the driver is taking a break.
java.lang.String	getLocationType()
java.lang.String	getParentStation()
java.lang.Integer	getStopCode()
java.lang.String	getStopDesc()
java.lang.String	getStopId()
double	getStopLat()
double	getStopLon()
java.lang.String	getStopName()
java.lang.String	getStopTimezone()
java.lang.String	getStopUrl()
java.lang.Boolean	getTimepointStop() Specifies if system should determine schedule adherence times for this stop.
java.lang.Boolean	getWaitStop() Specifies if stop is a wait stop where driver is not supposed to continue until the scheduled departure time.
java.lang.String	getWheelchairBoarding()
java.lang.String	getZoneId()
boolean	shouldDeleteFromRoute(java.lang.String routeShortNameToDeleteFrom, java.lang.String routesStr) Returns true if the routeShortNameToDeleteFrom specified is defined in deleteFromRoutes.
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

GtfsStop

public GtfsStop(java.lang.String stopId,
                java.lang.Integer stopCode,
                java.lang.String stopName,
                double lat,
                double lon)

For creating a GtfsStop object from scratch.

GtfsStop

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

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

Parameters:

record -

supplemental -

fileName - for logging errors

GtfsStop

public GtfsStop(GtfsStop original,
                double lat,
                double lon)

Creates a copy of the GtfsStop but updates the latitude and longitude. Useful for transforming coordinates in China so that locations are properly displayed in maps.

Parameters:

original -

shapePtLat -

shapePtLon -

GtfsStop

public GtfsStop(GtfsStop originalStop,
                GtfsStop supplementStop)

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

Parameters:

originalStop -

supplementStop -

Method Detail

getStopId

public java.lang.String getStopId()

getStopCode

public java.lang.Integer getStopCode()

getStopName

public java.lang.String getStopName()

getStopDesc

public java.lang.String getStopDesc()

getStopLat

public double getStopLat()

getStopLon

public double getStopLon()

getZoneId

public java.lang.String getZoneId()

getStopUrl

public java.lang.String getStopUrl()

getLocationType

public java.lang.String getLocationType()

getParentStation

public java.lang.String getParentStation()

getStopTimezone

public java.lang.String getStopTimezone()

getWheelchairBoarding

public java.lang.String getWheelchairBoarding()

getTimepointStop

public java.lang.Boolean getTimepointStop()

Specifies if system should determine schedule adherence times for this stop. Some agencies configure all stops to have times but determining schedule adherence for every single stop would clutter things up. Only want to show adherence for a subset of stops.

Returns:

null if not set in config files

getlayoverStop

public java.lang.Boolean getlayoverStop()

Indicates that vehicle can leave route path before departing this stop since the driver is taking a break.

Returns:

null if not set in config files

getWaitStop

public java.lang.Boolean getWaitStop()

Specifies if stop is a wait stop where driver is not supposed to continue until the scheduled departure time.

Returns:

null if not set in config files

getHidden

public java.lang.Boolean getHidden()

Specifies if stop should be hidden from the public user interface.

Returns:

null if not set in config files

getDeleteFromRoutesStr

public java.lang.String getDeleteFromRoutesStr()

Returns ":" separated string indicate route short names where this stop should not be included in the trips. Returns null if not defined.

Returns:

getDeleteFirstStopFromRoutesStr

public java.lang.String getDeleteFirstStopFromRoutesStr()

Returns ":" separated string indicate route short names where this stop should not be included in the trips if it is the first stop of a trip. Returns null if not defined.

Returns:

shouldDeleteFromRoute

public boolean shouldDeleteFromRoute(java.lang.String routeShortNameToDeleteFrom,
                                     java.lang.String routesStr)

Returns true if the routeShortNameToDeleteFrom specified is defined in deleteFromRoutes.

Parameters:

routeShortNameToDeleteFrom - The short name of the route currently working on. Used to determine if the stop really should be deleted.

routesStr - Should be deleteFromRoutesStr or deleteFirstStopFromRoutesStr, depending on type of stop deletion.

Returns:

True if stop deleted

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object