org.transitime.db.structs

Class TripPatternKey

java.lang.Object

org.transitime.db.structs.TripPatternKey

public class TripPatternKey
extends java.lang.Object

This class is to be used as a key for a TripPattern map. It contains just enough information, the shapeId and the stopPaths list, needed to uniquely identify a TripPattern.

Author:

SkiBu Smith

Constructor Summary

Constructors

Constructor and Description
TripPatternKey(java.lang.String shapeId, java.util.List<StopPath> paths) Construct TripPatternBase.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Needed so can have Set/Map of TripPatterns and looking up elements will be quick and proper.
java.lang.String	getShapeId()
java.util.List<StopPath>	getStopPaths()
int	hashCode() Needed so can have Set/Map of TripPatterns and looking up elements will be quick and proper.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TripPatternKey

public TripPatternKey(java.lang.String shapeId,
                      java.util.List<StopPath> paths)

Construct TripPatternBase. Can then be used as key to map to see of the TripPattern already exists.

Parameters:

shapeId - from the trip.txt GTFS file

stopPaths - Specifies the stops for the trip pattern. Must not be null.

Method Detail

hashCode

public int hashCode()

Needed so can have Set/Map of TripPatterns and looking up elements will be quick and proper. Note that this method does not do a full hashcode on stopPaths. This is because the StopPath elements are not finalized when building up trip patterns. The tripPatternId still hasn't been set. So don't want to compare the entire StopPath objects. Instead, only use StopPath.basicHashCode(). This difference is very important so using an automatically generated method here would not suffice.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Needed so can have Set/Map of TripPatterns and looking up elements will be quick and proper. Note that this method does not do a full equals() on stopPaths. This is because the StopPath elements are not finalized when building up trip patterns. The tripPatternId still hasn't been set. So don't want to compare the entire StopPath objects. Instead, only use StopPath.basicEquals(). This difference is very important so using an automatically generated method here would not suffice.

Overrides:

equals in class java.lang.Object

getShapeId

public java.lang.String getShapeId()

getStopPaths

public java.util.List<StopPath> getStopPaths()