org.transitime.gtfs.gtfsStructs

Class GtfsStopTime

java.lang.Object

org.transitime.utils.csv.CsvBase

org.transitime.gtfs.gtfsStructs.GtfsStopTime

All Implemented Interfaces:

java.lang.Comparable<GtfsStopTime>

Direct Known Subclasses:

GtfsExtendedStopTime

public class GtfsStopTime
extends CsvBase
implements java.lang.Comparable<GtfsStopTime>

A GTFS stop_times object

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
GtfsStopTime(org.apache.commons.csv.CSVRecord record, boolean supplemental, java.lang.String fileName) Creates a GtfsStopTime object by reading the data from the CSVRecord.
GtfsStopTime(GtfsStopTime originalStopTime, GtfsStopTime supplementStopTime) When combining a regular stop time with a supplemental one need to create a whole new object since this class is Immutable to make it safer to use.
GtfsStopTime(GtfsStopTime originalValues, java.lang.Integer newArrivalTimeSecs) For when need to create a GtfsStopTime that is a wait stop.
GtfsStopTime(java.lang.String tripId, java.lang.String arrivalTimeStr, java.lang.String departureTimeStr, java.lang.String stopId, int stopSequence, java.lang.Boolean timepointStop) For creating a GtfsStopTime object from scratch

Method Summary

Modifier and Type	Method and Description
int	compareTo(GtfsStopTime arg0) So can use Collections.sort() to sort an Array of GtfsStopTime objects by stop sequence.
java.lang.Integer	getArrivalTimeSecs()
java.lang.Integer	getDepartureTimeSecs()
java.lang.String	getDropOffType()
java.lang.String	getPickupType()
java.lang.Double	getShapeDistTraveled()
java.lang.String	getStopHeadsign()
java.lang.String	getStopId()
int	getStopSequence()
java.lang.String	getTripId()
boolean	isTimepointStop() Returns true if the stop_time is configured as a timepoint stop that should be included with schedule adherence reports.
boolean	isWaitStop()
boolean	shouldDelete()
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

GtfsStopTime

public GtfsStopTime(java.lang.String tripId,
                    java.lang.String arrivalTimeStr,
                    java.lang.String departureTimeStr,
                    java.lang.String stopId,
                    int stopSequence,
                    java.lang.Boolean timepointStop)

For creating a GtfsStopTime object from scratch

Parameters:

tripId -

arrivalTimeStr -

departureTimeStr -

stopId -

stopSequence - Index of stop in trip

timepointStop -

shapeDistTraveled -

GtfsStopTime

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

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

Parameters:

record -

supplemental -

fileName - for logging errors

Throws:

java.lang.NumberFormatException

GtfsStopTime

public GtfsStopTime(GtfsStopTime originalValues,
                    java.lang.Integer newArrivalTimeSecs)

For when need to create a GtfsStopTime that is a wait stop. Uses the values from originalValues but uses the new arrival time and sets isWaitStop to true.

Parameters:

originalValues - The original values from the stop_times.txt file

newArrivalTimeSecs - The new arrival time.

GtfsStopTime

public GtfsStopTime(GtfsStopTime originalStopTime,
                    GtfsStopTime supplementStopTime)

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

Parameters:

originalStopTime -

supplementStopTime -

Method Detail

getTripId

public java.lang.String getTripId()

getArrivalTimeSecs

public java.lang.Integer getArrivalTimeSecs()

Returns:

arrival time in seconds into day

getDepartureTimeSecs

public java.lang.Integer getDepartureTimeSecs()

Returns:

departure time in seconds into day

getStopId

public java.lang.String getStopId()

getStopSequence

public int getStopSequence()

getStopHeadsign

public java.lang.String getStopHeadsign()

getPickupType

public java.lang.String getPickupType()

getDropOffType

public java.lang.String getDropOffType()

isTimepointStop

public boolean isTimepointStop()

Returns true if the stop_time is configured as a timepoint stop that should be included with schedule adherence reports.

Returns:

getShapeDistTraveled

public java.lang.Double getShapeDistTraveled()

Returns:

shape_dist_traveled or null if not set

shouldDelete

public boolean shouldDelete()

isWaitStop

public boolean isWaitStop()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(GtfsStopTime arg0)

So can use Collections.sort() to sort an Array of GtfsStopTime objects by stop sequence.

Specified by:

compareTo in interface java.lang.Comparable<GtfsStopTime>

Parameters:

arg0 -

Returns: