org.transitime.db.structs

Class Match

java.lang.Object

org.transitime.db.structs.Match

All Implemented Interfaces:

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

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

For persisting the match for the vehicle. This data is later used for determining expected travel times. The key/IDs for the table are vehicleId and the AVL avlTime so that the Match data can easily be joined with AvlReport data to get additional information.

Serializable since Hibernate requires such.

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.

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
Match(VehicleState vehicleState) Simple constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Because using a composite Id Hibernate wants this member.
java.lang.String	getBlockId()
int	getConfigRev()
java.util.Date	getDate()
float	getDistanceAlongSegment()
float	getDistanceAlongStopPath()
static java.util.List<Match>	getMatchesFromDb(java.lang.String projectId, java.util.Date beginTime, java.util.Date endTime, java.lang.String sqlClause, int firstResult, int maxResults) Allows batch retrieval of Match data from database.
int	getSegmentIndex()
java.lang.String	getServiceId()
int	getStopPathIndex()
long	getTime()
java.lang.String	getTripId()
java.lang.String	getVehicleId()
int	hashCode() Because using a composite Id Hibernate wants this member.
boolean	isAtStop() Returns true if vehicle is at or near a stop.
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

Constructor Detail

Match

public Match(VehicleState vehicleState)

Simple constructor

Parameters:

vehicleState -

Method Detail

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

getMatchesFromDb

public static java.util.List<Match> getMatchesFromDb(java.lang.String projectId,
                                                     java.util.Date beginTime,
                                                     java.util.Date endTime,
                                                     java.lang.String sqlClause,
                                                     int firstResult,
                                                     int maxResults)

Allows batch retrieval of Match data from database. This is likely the best way to read in large amounts of data.

Parameters:

projectId -

beginTime -

endTime -

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

firstResult -

maxResults -

Returns:

getVehicleId

public java.lang.String getVehicleId()

getDate

public java.util.Date getDate()

getTime

public long getTime()

getConfigRev

public int getConfigRev()

getServiceId

public java.lang.String getServiceId()

getBlockId

public java.lang.String getBlockId()

getTripId

public java.lang.String getTripId()

getStopPathIndex

public int getStopPathIndex()

getSegmentIndex

public int getSegmentIndex()

getDistanceAlongSegment

public float getDistanceAlongSegment()

getDistanceAlongStopPath

public float getDistanceAlongStopPath()

isAtStop

public boolean isAtStop()

Returns true if vehicle is at or near a stop. The atStop member is transient which means it is not set properly if the Match object was read from the database. It is only set when the Match is created by the predictor software.

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