org.transitime.db.structs

Class Block

java.lang.Object

org.transitime.db.structs.Block

All Implemented Interfaces:

java.io.Serializable

@Entity(name="Blocks")
public final class Block
extends java.lang.Object
implements java.io.Serializable

Represents assignment for a vehicle for a day. Obtained by combining data from multiple GTFS files. Thought a good deal about how to represent all the stops in the block. Wanted to have a list of trip patterns instead of trips because that would be more efficient. But then realized that for each trip need different times and such. Therefore decided to use full list of Trips. This will make the data in the database unfortunately quite large.

Author:

SkiBu Smith

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Block(int configRev, java.lang.String blockId, java.lang.String serviceId, int startTime, int endTime, java.util.List<Trip> trips) This constructor called when processing GTFS data and creating a Block to be stored in the database.

Method Summary

Modifier and Type	Method and Description
int	activeTripIndex(java.util.Date date, int allowableBeforeTimeSecs) Determines which trip is currently active and returns the associated index of that trip such that getTrip(int) can be called to get the trip.
static int	deleteFromRev(org.hibernate.Session session, int configRev) Deletes rev from the Blocks, Trips, and Block_to_Trip_joinTable
boolean	equals(java.lang.Object obj) Required by Hibernate
static java.util.List<Block>	getBlocks(org.hibernate.Session session, int configRev) Returns list of Block objects for the specified configRev
int	getConfigRev()
int	getEndTime()
java.lang.String	getId()
static java.lang.Object	getLazyLoadingSyncObject() So can sync up loading of trip and trip pattern data when trips are all read at once in another class as opposed to through Block.getTrips().
int	getPathStopTime(int tripIndex, int stopPathIndex) Returns the time in msec for how long expected to be at the stop at the end of the stop path.
StopPath	getPreviousPath(int tripIndex, int stopPathIndex) Returns the previous path specified by tripIndex and stopPathIndex params.
java.util.Set<java.lang.String>	getRouteIds() Returns collection of route IDs associated with the Block.
ScheduleTime	getScheduleTime(int tripIndex, int stopPathIndex) Returns the ScheduleTime for that stop specified by the trip and path indices.
Vector	getSegmentVector(int tripIndex, int stopPathIndex, int segmentIndex) Returns the Vector of the segment specified.
java.lang.String	getServiceId()
Location	getStartLoc() Returns the location of the first stop of the block.
int	getStartTime()
StopPath	getStopPath(int tripIndex, int stopPathIndex) Returns the path specified by tripIndex and stopPathIndex params.
int	getStopPathTravelTime(int tripIndex, int stopPathIndex) Returns the travel time for the specified path.
Trip	getTrip(int tripIndex) Returns the trip specified by the tripIndex
Trip	getTrip(java.lang.String tripId) Returns the trip for the block as specified by the tripId parameter
int	getTripIndex(Trip trip) Returns for the specified trip the index into the trips list for the block
java.util.Collection<TripPattern>	getTripPatterns() Returns the trip patterns associated with the block.
java.util.List<Trip>	getTrips() Uses lazy initialization to determine the trips for the block.
java.util.List<Trip>	getTripsCurrentlyActive(AvlReport avlReport) For this block determines which trips are currently active.
int	hashCode() Required by Hibernate
boolean	hasSchedule() Returns true if block assignment has a schedule (is not frequency based)
boolean	isActive(java.util.Date date) Returns true if the time of day of the date passed in is between the startTime and the endTime for the block.
boolean	isActive(java.util.Date date, int allowableBeforeTimeSecs, int allowableAfterStartTimeSecs) Returns true if the time of day of the date passed in is between allowableBeforeTimeSecs before the startTime and the endTime for the block.
boolean	isActive(long epochTime) Returns true if the time of day of the date passed in is between the startTime and the endTime for the block.
boolean	isActive(long epochTime, int allowableBeforeTimeSecs) Returns true if the time of day of the epoch time passed in is between allowableBeforeTimeSecs before the startTime and the endTime for the block.
boolean	isActive(long epochTime, int allowableBeforeTimeSecs, int allowableAfterStartTimeSecs) Returns true if the time of day of the date passed in is between allowableBeforeTimeSecs before the startTime and the endTime for the block.
boolean	isBeforeStartTime(java.util.Date date, int allowableBeforeTimeSecs) Returns true if the time of day of the date passed in is between allowableBeforeTimeSecs before the start time and the start time.
boolean	isLayover(int tripIndex, int stopPathIndex) Returns true if path is for a stop that is configured to be layover stop for the trip pattern.
boolean	isNoSchedule() Returns true if block assignment has no schedule (is frequency based)
boolean	isWaitStop(int tripIndex, int stopPathIndex) Indicates that vehicle is not supposed to depart the stop until the scheduled departure time.
static void	main(java.lang.String[] args) For debugging
boolean	nearEndOfBlock(SpatialMatch match, double distance) Returns true if on last trip of block and within the specified distance of the end of that last trip.
int	numSegments(int tripIndex, int stopPathIndex) Returns number of segments for the path specified
int	numStopPaths(int tripIndex) Returns number of stopPaths for the trip specified.
int	numTrips() Returns the number of trips.
boolean	shouldBeExclusive() Returns true if this block assignment should be exclusive, such that when a vehicle is assigned to this block any other vehicles assigned to this block will have their assignments removed.
java.lang.String	toShortString() Like toString() but only outputs core info.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Block

public Block(int configRev,
             java.lang.String blockId,
             java.lang.String serviceId,
             int startTime,
             int endTime,
             java.util.List<Trip> trips)

This constructor called when processing GTFS data and creating a Block to be stored in the database. Note: startTime and endTime could in theory be determined here by looking at first and last TripElements. But what if they haven't been set in GTFS? Want the calling function to do this kind of error checking because it does other error checking and can log issues appropriately.

Parameters:

configRev -

blockId -

startTime -

endTime -

trips -

Method Detail

getBlocks

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

Returns list of Block objects for the specified configRev

Parameters:

session -

configRev -

Returns:

List of Block objects

Throws:

org.hibernate.HibernateException

deleteFromRev

public static int deleteFromRev(org.hibernate.Session session,
                                int configRev)
                         throws org.hibernate.HibernateException

Deletes rev from the Blocks, Trips, and Block_to_Trip_joinTable

Parameters:

session -

configRev -

Returns:

Number of rows deleted

Throws:

org.hibernate.HibernateException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toShortString

public java.lang.String toShortString()

Like toString() but only outputs core info. Doesn't output the trips except to identify them. This is a big difference from toString() because each Trip has lots of info to output.

Returns:

hashCode

public int hashCode()

Required by Hibernate

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Required by Hibernate

Overrides:

equals in class java.lang.Object

activeTripIndex

public int activeTripIndex(java.util.Date date,
                           int allowableBeforeTimeSecs)

Determines which trip is currently active and returns the associated index of that trip such that getTrip(int) can be called to get the trip. Trip is active if the date lies between the end time of the previous trip and the end time of the current trip. To handle wrapping around midnight if there isn't a match initially then will check past midnight and before midnight as well.

Often consider a block to be active before its scheduled start time. For this situation the first trip is returned if it is within allowableBeforeTimeSecs before the block is supposed to start.

Parameters:

date - The current time, to be used for determining if trip active.

allowableBeforeTimeSecs - How much before the block time the block is considered to be active. Needed because often consider a block to be active before its scheduled start time. For this situation need to return first trip.

Returns:

index of trip, or -1 if no match

isActive

public boolean isActive(java.util.Date date,
                        int allowableBeforeTimeSecs,
                        int allowableAfterStartTimeSecs)

Returns true if the time of day of the date passed in is between allowableBeforeTimeSecs before the startTime and the endTime for the block. No leeway is provided for the end time. Note: does not look to see if the service associated with the block is active. Only looks at time of day.

Parameters:

date - The time checking to see whether block is active for

allowableBeforeTimeSecs - Block considered active if within this number of seconds before the block start time. Set to 0 if want to know if date is actually between the block start and end times.

allowableAfterStartTimeSecs - If set to value greater than or equal to zero then block considered active only if within this number of seconds after the start time. If less then zero then block considered active up to the block end time.

Returns:

True if the block is active for the specified date

isActive

public boolean isActive(long epochTime,
                        int allowableBeforeTimeSecs,
                        int allowableAfterStartTimeSecs)

Returns true if the time of day of the date passed in is between allowableBeforeTimeSecs before the startTime and the endTime for the block. No leeway is provided for the end time. Note: does not look to see if the service associated with the block is active. Only looks at time of day.

Parameters:

date - The time checking to see whether block is active for

allowableBeforeTimeSecs - Block considered active if within this number of seconds before the block start time. Set to 0 if want to know if date is actually between the block start and end times.

allowableAfterStartTimeSecs - If set to value greater than or equal to zero then block considered active only if within this number of seconds after the start time. If less then zero then block considered active up to the block end time.

Returns:

True if the block is active for the specified date

isActive

public boolean isActive(long epochTime,
                        int allowableBeforeTimeSecs)

Returns true if the time of day of the epoch time passed in is between allowableBeforeTimeSecs before the startTime and the endTime for the block. No leeway is provided for the end time. Note: does not look to see if the service associated with the block is active. Only looks at time of day.

Parameters:

epochTime -

allowableBeforeTimeSecs -

Returns:

isActive

public boolean isActive(java.util.Date date)

Returns true if the time of day of the date passed in is between the startTime and the endTime for the block. No leeway is provided. Note: does not look to see if the service associated with the block is active. Only looks at time of day.

Parameters:

date -

Returns:

True if the block is active.

isActive

public boolean isActive(long epochTime)

Returns true if the time of day of the date passed in is between the startTime and the endTime for the block. No leeway is provided. Note: does not look to see if the service associated with the block is active. Only looks at time of day.

Parameters:

epochTime -

Returns:

True if the block is active.

isBeforeStartTime

public boolean isBeforeStartTime(java.util.Date date,
                                 int allowableBeforeTimeSecs)

Returns true if the time of day of the date passed in is between allowableBeforeTimeSecs before the start time and the start time.

Parameters:

date -

allowableBeforeTimeSecs -

Returns:

true if within allowableBeforeTimeSecs before the start time of the block

getTripsCurrentlyActive

public java.util.List<Trip> getTripsCurrentlyActive(AvlReport avlReport)

For this block determines which trips are currently active. Should work even for trips that start before midnight or go till after midnight. Trip is considered active if it is within start time of trip minus CoreConfig.getAllowableEarlyForLayoverSeconds() and within the end time of the trip. No leniency is made for the end time since once a trip is over really don't want to assign vehicle to that trip.

Parameters:

avlReport -

Returns:

List of Trips that are active. If none are active an empty list is returned.

getId

public java.lang.String getId()

Returns:

the blockId

getConfigRev

public int getConfigRev()

Returns:

the configRev

getServiceId

public java.lang.String getServiceId()

Returns:

the serviceId

getStartTime

public int getStartTime()

Returns:

the startTime in seconds from midnight

getEndTime

public int getEndTime()

Returns:

the endTime in seconds from midnight

getTrips

public java.util.List<Trip> getTrips()

Uses lazy initialization to determine the trips for the block.

Returns:

the trips

getLazyLoadingSyncObject

public static java.lang.Object getLazyLoadingSyncObject()

So can sync up loading of trip and trip pattern data when trips are all read at once in another class as opposed to through Block.getTrips().

Returns:

isNoSchedule

public boolean isNoSchedule()

Returns true if block assignment has no schedule (is frequency based)

Returns:

true if no schedule

hasSchedule

public boolean hasSchedule()

Returns true if block assignment has a schedule (is not frequency based)

Returns:

true if has schedule

getTrip

public Trip getTrip(int tripIndex)

Returns the trip specified by the tripIndex

Parameters:

tripIndex -

Returns:

the Trip specified by tripIndex. If index out of range returns null

getTrip

public Trip getTrip(java.lang.String tripId)

Returns the trip for the block as specified by the tripId parameter

Parameters:

tripId - Which trip is to be returned

Returns:

The Trip that matches the tripId

getTripIndex

public int getTripIndex(Trip trip)

Returns for the specified trip the index into the trips list for the block

Parameters:

trip - Specifies which trip looking for

Returns:

Index into trips of the specified trip

getRouteIds

public java.util.Set<java.lang.String> getRouteIds()

Returns collection of route IDs associated with the Block. Each route ID will only be included once.

Returns:

getTripPatterns

public java.util.Collection<TripPattern> getTripPatterns()

Returns the trip patterns associated with the block. Note that these are not in any kind of fixed order since trip patterns are used multiple times in a block.

Returns:

getStopPathTravelTime

public int getStopPathTravelTime(int tripIndex,
                                 int stopPathIndex)

Returns the travel time for the specified path. Does not include stop times.

Parameters:

tripIndex -

stopPathIndex -

Returns:

getPathStopTime

public int getPathStopTime(int tripIndex,
                           int stopPathIndex)

Returns the time in msec for how long expected to be at the stop at the end of the stop path.

Parameters:

tripIndex -

stopPathIndex -

Returns:

getSegmentVector

public Vector getSegmentVector(int tripIndex,
                               int stopPathIndex,
                               int segmentIndex)

Returns the Vector of the segment specified.

Parameters:

tripIndex -

stopPathIndex -

segmentIndex -

Returns:

The Vector for the specified segment or null if the indices are out of range.

numSegments

public int numSegments(int tripIndex,
                       int stopPathIndex)

Returns number of segments for the path specified

Parameters:

tripIndex -

stopPathIndex -

Returns:

Number of segments for specified path or -1 if an index is out of range.

numStopPaths

public int numStopPaths(int tripIndex)

Returns number of stopPaths for the trip specified.

Parameters:

tripIndex -

Returns:

Number of stopPaths for specified trip or -1 if index is out of range.

numTrips

public int numTrips()

Returns the number of trips.

Returns:

isLayover

public boolean isLayover(int tripIndex,
                         int stopPathIndex)

Returns true if path is for a stop that is configured to be layover stop for the trip pattern. A layover stop is when a vehicle can leave route path before departing this stop since the driver is taking a break.

Parameters:

tripIndex -

stopPathIndex -

Returns:

isWaitStop

public boolean isWaitStop(int tripIndex,
                          int stopPathIndex)

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

Returns:

true if a wait stop

getStopPath

public StopPath getStopPath(int tripIndex,
                            int stopPathIndex)

Returns the path specified by tripIndex and stopPathIndex params.

Parameters:

tripIndex -

stopPathIndex -

Returns:

the StopPath or null if tripIndex or stopPathIndex are out of range.

getStartLoc

public Location getStartLoc()

Returns the location of the first stop of the block.

Returns:

getPreviousPath

public StopPath getPreviousPath(int tripIndex,
                                int stopPathIndex)

Returns the previous path specified by tripIndex and stopPathIndex params. If wrapping back past beginning of block (where tripIndex becomes negative) then returns null.

Parameters:

tripIndex -

stopPathIndex -

Returns:

getScheduleTime

public ScheduleTime getScheduleTime(int tripIndex,
                                    int stopPathIndex)

Returns the ScheduleTime for that stop specified by the trip and path indices.

Parameters:

tripIndex -

stopPathIndex -

Returns:

the schedule time for the specified stop. Returns null if no schedule time associated with stop

nearEndOfBlock

public boolean nearEndOfBlock(SpatialMatch match,
                              double distance)

Returns true if on last trip of block and within the specified distance of the end of that last trip.

Parameters:

match -

distance -

Returns:

True if within distance of end of block

shouldBeExclusive

public boolean shouldBeExclusive()

Returns true if this block assignment should be exclusive, such that when a vehicle is assigned to this block any other vehicles assigned to this block will have their assignments removed.

Current it is configured using Java property instead of in the database.

Returns:

True if this block assignment should be exclusively assigned to only a single vehicle at a time

main

public static void main(java.lang.String[] args)

For debugging

Parameters:

args -