org.transitime.db.structs

Class StopPath

java.lang.Object

org.transitime.db.structs.StopPath

All Implemented Interfaces:

java.io.Serializable, org.hibernate.classic.Lifecycle

@Entity
public class StopPath
extends java.lang.Object
implements java.io.Serializable, org.hibernate.classic.Lifecycle

A StopPath is a set of points that defines how a vehicle gets from one stop to another. The stops do not necessarily lie directly on the segments since the segments are likely to be street center line data while the stops are usually on the sidewalk.

Author:

SkiBu Smith

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.hibernate.classic.Lifecycle

NO_VETO, VETO

Constructor Summary

Constructors

Constructor and Description
StopPath(int configRev, java.lang.String pathId, java.lang.String stopId, int gtfsStopSeq, boolean lastStopInTrip, java.lang.String routeId, boolean layoverStop, boolean waitStop, boolean scheduleAdherenceStop, java.lang.Integer breakTime) Simple constructor

Method Summary

Modifier and Type	Method and Description
boolean	basicEquals(java.lang.Object obj) For when seeing if TripPatternBase is unique in a collection.
int	basicHashCode() For when seeing if TripPatternBase is unique in a collection.
static java.lang.String	determinePathId(java.lang.String previousStopId, java.lang.String stopId) For consistently naming the path Id.
boolean	equals(java.lang.Object obj) Needed because have a composite ID for Hibernate storage
double	getAfterStopDistance() How far a vehicle can be past a stop and still be considered at the stop.
double	getBeforeStopDistance() How far a vehicle can be ahead of a stop and be considered to have arrived.
int	getBreakTimeSec() Returns how long driver is expected to have a break for at this stop.
int	getConfigRev()
Location	getEndOfPathLocation() Returns the end of the path, which is where the stop is.
int	getGtfsStopSeq() The stop_sequence for the trip from the GTFS stop_times.txt file
java.lang.String	getId()
double	getLength()
Location	getLocation(int index)
java.util.List<Location>	getLocations()
int	getNumberSegments()
static java.util.List<StopPath>	getPaths(org.hibernate.Session session, int configRev) Returns List of StopPath objects for the specified database revision.
java.lang.String	getRouteId()
VectorWithHeading	getSegmentVector(int segmentIndex) Returns the vector for the specified segment.
java.util.List<VectorWithHeading>	getSegmentVectors()
java.lang.String	getStopId()
Location	getStopLocation() Returns the location of the stop at the end of the path.
java.lang.String	getStopName() Provides the name of the stop as obtained by a Core predictor.
java.lang.String	getStopPathId()
java.lang.String	getTripPatternId()
int	hashCode() Needed because have a composite ID for Hibernate storage
boolean	isLastStopInTrip()
boolean	isLayoverStop() Indicates that vehicle can leave route path before departing this stop since the driver is taking a break.
boolean	isScheduleAdherenceStop()
boolean	isWaitStop() Indicates that vehicle is not supposed to depart the stop until the scheduled departure time.
double	length() Returns the distance to travel along the path.
boolean	onDelete(org.hibernate.Session arg0)
void	onLoad(org.hibernate.Session arg0, java.io.Serializable arg1)
boolean	onSave(org.hibernate.Session arg0)
boolean	onUpdate(org.hibernate.Session arg0)
void	setLocations(java.util.ArrayList<Location> locations) Locations are not available when StopPath is first created so need to be able to set them after construction.
void	setTripPatternId(java.lang.String tripPatternId) So can set the tripPatternId once it is known (which happens after StopPath is constructed).
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StopPath

public StopPath(int configRev,
                java.lang.String pathId,
                java.lang.String stopId,
                int gtfsStopSeq,
                boolean lastStopInTrip,
                java.lang.String routeId,
                boolean layoverStop,
                boolean waitStop,
                boolean scheduleAdherenceStop,
                java.lang.Integer breakTime)

Simple constructor

Parameters:

configRev -

pathId -

stopId -

gtfsStopSeq -

lastStopInTrip -

routeId -

layoverStop -

waitStop -

scheduleAdherenceStop -

breakTime -

Method Detail

getPaths

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

Returns List of StopPath objects for the specified database revision.

Parameters:

session -

configRev -

Returns:

Throws:

org.hibernate.HibernateException

determinePathId

public static java.lang.String determinePathId(java.lang.String previousStopId,
                                               java.lang.String stopId)

For consistently naming the path Id. It is based on the current stop ID and the previous stop Id. If previousStopId is null then will return "to_" + stopId. If not null will return previousStopId + "_to_" + stopId.

Parameters:

previousStopId -

stopId -

Returns:

length

public double length()

Returns the distance to travel along the path. Summation of all of the path segments.

Returns:

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

basicHashCode

public int basicHashCode()

For when seeing if TripPatternBase is unique in a collection. When this is done the StopPath isn't yet fully complete so only compare the key members that signify if a StopPath is unique.

equals

public boolean equals(java.lang.Object obj)

Needed because have a composite ID for Hibernate storage

Overrides:

equals in class java.lang.Object

basicEquals

public boolean basicEquals(java.lang.Object obj)

For when seeing if TripPatternBase is unique in a collection. When this is done the StopPath isn't yet fully complete so only compare the key members that signify if a StopPath is unique.

getConfigRev

public int getConfigRev()

Returns:

the configRev

getId

public java.lang.String getId()

Returns:

the stopPathId

getStopId

public java.lang.String getStopId()

Returns:

the stopId

getGtfsStopSeq

public int getGtfsStopSeq()

The stop_sequence for the trip from the GTFS stop_times.txt file

Returns:

the gtfsStopSeq

isLastStopInTrip

public boolean isLastStopInTrip()

Returns:

the lastStopInTrip

getStopPathId

public java.lang.String getStopPathId()

Returns:

the stopPathId

getStopName

public java.lang.String getStopName()

Provides the name of the stop as obtained by a Core predictor. Cannot be used with other applications.

Returns:

the name of the stop

getTripPatternId

public java.lang.String getTripPatternId()

Returns:

the tripPatternId

getRouteId

public java.lang.String getRouteId()

Returns:

the routeId

setLocations

public void setLocations(java.util.ArrayList<Location> locations)

Locations are not available when StopPath is first created so need to be able to set them after construction. Sets the locations member and also determines the pathLength.

Parameters:

locations -

getStopLocation

public Location getStopLocation()

Returns the location of the stop at the end of the path.

Returns:

Location of stop

setTripPatternId

public void setTripPatternId(java.lang.String tripPatternId)

So can set the tripPatternId once it is known (which happens after StopPath is constructed).

Parameters:

tripPatternId -

getLocations

public java.util.List<Location> getLocations()

Returns:

List of Locations of the segments that make up the path

getNumberSegments

public int getNumberSegments()

Returns:

Number of segments in path.

getEndOfPathLocation

public Location getEndOfPathLocation()

Returns the end of the path, which is where the stop is. Note that it is not exactly the stop location because stops do not need to be on the path.

Returns:

getLength

public double getLength()

Returns:

Combined length of all the path segments

getSegmentVectors

public java.util.List<VectorWithHeading> getSegmentVectors()

Returns:

List of VectorWithHeadings of the segments that make up the path

getSegmentVector

public VectorWithHeading getSegmentVector(int segmentIndex)

Returns the vector for the specified segment.

Parameters:

segmentIndex -

Returns:

The vector, or null if segmentIndex not valid

getLocation

public Location getLocation(int index)

Parameters:

index -

Returns:

Location for the specified index along the StopPath

isLayoverStop

public boolean isLayoverStop()

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

Returns:

true if a layover stop

getBreakTimeSec

public int getBreakTimeSec()

Returns how long driver is expected to have a break for at this stop.

Returns:

Layover time in seconds if layover stop, otherwise, 0.

isWaitStop

public boolean isWaitStop()

Indicates that vehicle is not supposed to depart the stop until the scheduled departure time.

Returns:

true if a wait stop

isScheduleAdherenceStop

public boolean isScheduleAdherenceStop()

getBeforeStopDistance

public double getBeforeStopDistance()

How far a vehicle can be ahead of a stop and be considered to have arrived.

Returns:

getAfterStopDistance

public double getAfterStopDistance()

How far a vehicle can be past a stop and still be considered at the stop.

Returns:

onDelete

public boolean onDelete(org.hibernate.Session arg0)
                 throws org.hibernate.CallbackException

Specified by:

onDelete in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException

onLoad

public void onLoad(org.hibernate.Session arg0,
                   java.io.Serializable arg1)

Specified by:

onLoad in interface org.hibernate.classic.Lifecycle

onSave

public boolean onSave(org.hibernate.Session arg0)
               throws org.hibernate.CallbackException

Specified by:

onSave in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException

onUpdate

public boolean onUpdate(org.hibernate.Session arg0)
                 throws org.hibernate.CallbackException

Specified by:

onUpdate in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException