org.transitime.db.structs

Class ArrivalDeparture

java.lang.Object

org.transitime.db.structs.ArrivalDeparture

All Implemented Interfaces:

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

Direct Known Subclasses:

Arrival, Departure

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

For persisting an Arrival or a Departure time. Should use Arrival or Departure subclasses.

Implements Lifecycle so that can have the onLoad() callback be called when reading in data so that can intern() member strings. In order to do this the String members could not be declared as final since they are updated after the constructor is called. By interning the member strings less than half (about 40%) of the RAM to be used. This is very important when reading in large batches of ArrivalDeparture objects!

Author:

SkiBu Smith

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ArrivalDeparture.ArrivalsOrDepartures

Field Summary

Fields inherited from interface org.hibernate.classic.Lifecycle

NO_VETO, VETO

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Because using a composite Id Hibernate wants this member.
static java.util.Iterator<ArrivalDeparture>	getArrivalsDeparturesDbIterator(org.hibernate.Session session, java.util.Date beginTime, java.util.Date endTime) For querying large amount of data.
static java.util.List<ArrivalDeparture>	getArrivalsDeparturesFromDb(java.util.Date beginTime, java.util.Date endTime, java.lang.String vehicleId) Read in arrivals and departures for a vehicle, over a time range.
static java.util.List<ArrivalDeparture>	getArrivalsDeparturesFromDb(java.util.Date beginTime, java.util.Date endTime, java.lang.String sqlClause, int firstResult, int maxResults, ArrivalDeparture.ArrivalsOrDepartures arrivalOrDeparture) Same as other getArrivalsDeparturesFromDb() but uses -Dtransitime.db.dbName Java property to specify the name of the database.
static java.util.List<ArrivalDeparture>	getArrivalsDeparturesFromDb(java.lang.String projectId, java.util.Date beginTime, java.util.Date endTime) Reads the arrivals/departures for the timespan specified.
static java.util.List<ArrivalDeparture>	getArrivalsDeparturesFromDb(java.lang.String dbName, java.util.Date beginTime, java.util.Date endTime, java.lang.String sqlClause, int firstResult, int maxResults, ArrivalDeparture.ArrivalsOrDepartures arrivalOrDeparture) Allows batch retrieval of data.
java.util.Date	getAvlTime()
Block	getBlock() Note that the block is a transient element so will not be available if this object was read from the database.
java.lang.String	getBlockId()
int	getConfigRev()
java.util.Date	getDate()
java.lang.String	getDirectionId()
java.lang.String	getRouteId()
TemporalDifference	getScheduleAdherence() Returns the schedule adherence for the stop if there was a schedule time.
java.util.Date	getScheduledDate() The schedule time will only be set if the schedule info was available from the GTFS data and it is the proper type of arrival or departure stop (there is an arrival schedule time and this is the last stop for a trip and and this is an arrival time OR there is a departure schedule time and this is not the last stop for a trip and this is a departure time.
long	getScheduledTime() Same as getScheduledDate() but returns long epoch time.
java.lang.String	getServiceId()
Stop	getStop() Returns the Stop object associated with the arrival/departure.
java.lang.String	getStopId()
int	getStopPathIndex()
float	getStopPathLength()
long	getTime()
java.lang.String	getTripId()
int	getTripIndex()
java.lang.String	getVehicleId()
int	hashCode() Because using a composite Id Hibernate wants this member.
boolean	isArrival()
boolean	isDeparture() Can be more clear than using !isArrival()
void	logCreation() For logging each creation of an ArrivalDeparture to the separate ArrivalsDepartures.log file.
boolean	onDelete(org.hibernate.Session s) Implemented due to Lifecycle interface being implemented.
void	onLoad(org.hibernate.Session s, java.io.Serializable id) Callback due to implementing Lifecycle interface.
boolean	onSave(org.hibernate.Session s) Implemented due to Lifecycle interface being implemented.
boolean	onUpdate(org.hibernate.Session s) Implemented due to Lifecycle interface being implemented.
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

onLoad

public void onLoad(org.hibernate.Session s,
                   java.io.Serializable id)
            throws org.hibernate.CallbackException

Callback due to implementing Lifecycle interface. Used to compact string members by interning them.

Specified by:

onLoad in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException

onSave

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

Implemented due to Lifecycle interface being implemented. Not actually used.

Specified by:

onSave in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException

onUpdate

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

Implemented due to Lifecycle interface being implemented. Not actually used.

Specified by:

onUpdate in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException

onDelete

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

Implemented due to Lifecycle interface being implemented. Not actually used.

Specified by:

onDelete in interface org.hibernate.classic.Lifecycle

Throws:

org.hibernate.CallbackException

logCreation

public void logCreation()

For logging each creation of an ArrivalDeparture to the separate ArrivalsDepartures.log file.

hashCode

public int hashCode()

Because using a composite Id Hibernate wants this member.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Because using a composite Id Hibernate wants this member.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getArrivalsDeparturesDbIterator

public static java.util.Iterator<ArrivalDeparture> getArrivalsDeparturesDbIterator(org.hibernate.Session session,
                                                                                   java.util.Date beginTime,
                                                                                   java.util.Date endTime)
                                                                            throws org.hibernate.HibernateException

For querying large amount of data. With a Hibernate Iterator not all the data is read in at once. This means that can iterate over a large dataset without running out of memory. But this can be slow because when using iterate() an initial query is done to get all of Id column data and then a separate query is done when iterating over each row. Doing an individual query per row is of course quite time consuming. Better to use getArrivalsDeparturesFromDb() with a fairly large batch size of ~50000.

Note that the session needs to be closed externally once done with the Iterator.

Parameters:

session -

beginTime -

endTime -

Returns:

Throws:

org.hibernate.HibernateException

getArrivalsDeparturesFromDb

public static java.util.List<ArrivalDeparture> getArrivalsDeparturesFromDb(java.util.Date beginTime,
                                                                           java.util.Date endTime,
                                                                           java.lang.String vehicleId)

Read in arrivals and departures for a vehicle, over a time range.

Parameters:

projectId -

beginTime -

endTime -

vehicleId -

Returns:

getArrivalsDeparturesFromDb

public static java.util.List<ArrivalDeparture> getArrivalsDeparturesFromDb(java.lang.String projectId,
                                                                           java.util.Date beginTime,
                                                                           java.util.Date endTime)

Reads the arrivals/departures for the timespan specified. All of the data is read in at once so could present memory issue if reading in a very large amount of data. For that case probably best to instead use getArrivalsDeparturesDb() where one specifies the firstResult and maxResult parameters.

Parameters:

projectId -

beginTime -

endTime -

Returns:

getArrivalsDeparturesFromDb

public static java.util.List<ArrivalDeparture> getArrivalsDeparturesFromDb(java.lang.String dbName,
                                                                           java.util.Date beginTime,
                                                                           java.util.Date endTime,
                                                                           java.lang.String sqlClause,
                                                                           int firstResult,
                                                                           int maxResults,
                                                                           ArrivalDeparture.ArrivalsOrDepartures arrivalOrDeparture)

Allows batch retrieval of data. This is likely the best way to read in large amounts of data. Using getArrivalsDeparturesDbIterator() reads in only data as needed so good with respect to memory usage but it does a separate query for each row. Reading in list of all data is quick but can cause memory problems if reading in a very large amount of data. This method is a good compromise because it only reads in a batch of data at a time so is not as memory intensive yet it is quite fast. With a batch size of 50k found it to run in under 1/4 the time as with the iterator method.

Parameters:

dbName - Name of the database to retrieve data from. If set to null then will use db name configured by Java property transitime.db.dbName

beginTime -

endTime -

sqlClause - The clause is added to the SQL for retrieving the arrival/departures. Useful for ordering the results. Can be null.

firstResult - For when reading in batch of data at a time.

maxResults - For when reading in batch of data at a time. If set to 0 then will read in all data at once.

arrivalOrDeparture - Enumeration specifying whether to read in just arrivals or just departures. Set to null to read in both.

Returns:

getArrivalsDeparturesFromDb

public static java.util.List<ArrivalDeparture> getArrivalsDeparturesFromDb(java.util.Date beginTime,
                                                                           java.util.Date endTime,
                                                                           java.lang.String sqlClause,
                                                                           int firstResult,
                                                                           int maxResults,
                                                                           ArrivalDeparture.ArrivalsOrDepartures arrivalOrDeparture)

Same as other getArrivalsDeparturesFromDb() but uses -Dtransitime.db.dbName Java property to specify the name of the database.

Parameters:

beginTime -

endTime -

sqlClause -

firstResult -

maxResults -

arrivalOrDeparture -

Returns:

getVehicleId

public java.lang.String getVehicleId()

getDate

public java.util.Date getDate()

getAvlTime

public java.util.Date getAvlTime()

getTime

public long getTime()

getStopId

public java.lang.String getStopId()

isArrival

public boolean isArrival()

isDeparture

public boolean isDeparture()

Can be more clear than using !isArrival()

Returns:

getTripId

public java.lang.String getTripId()

getBlockId

public java.lang.String getBlockId()

getRouteId

public java.lang.String getRouteId()

getServiceId

public java.lang.String getServiceId()

getDirectionId

public java.lang.String getDirectionId()

getConfigRev

public int getConfigRev()

getTripIndex

public int getTripIndex()

getStopPathIndex

public int getStopPathIndex()

getStopPathLength

public float getStopPathLength()

getBlock

public Block getBlock()

Note that the block is a transient element so will not be available if this object was read from the database. In that case it will be null.

Returns:

getScheduledDate

public java.util.Date getScheduledDate()

The schedule time will only be set if the schedule info was available from the GTFS data and it is the proper type of arrival or departure stop (there is an arrival schedule time and this is the last stop for a trip and and this is an arrival time OR there is a departure schedule time and this is not the last stop for a trip and this is a departure time. Otherwise will be null.

Returns:

getScheduledTime

public long getScheduledTime()

Same as getScheduledDate() but returns long epoch time.

Returns:

getScheduleAdherence

public TemporalDifference getScheduleAdherence()

Returns the schedule adherence for the stop if there was a schedule time. Otherwise returns null.

Returns:

getStop

public Stop getStop()

Returns the Stop object associated with the arrival/departure. Will only be valid for the Core system where the configuration has been read in.

Returns:

The Stop associated with the arrival/departure