org.transitime.db.structs

Class VehicleEvent

java.lang.Object

org.transitime.db.structs.VehicleEvent

All Implemented Interfaces:

java.io.Serializable

@Immutable
 @Entity
public class VehicleEvent
extends java.lang.Object
implements java.io.Serializable

For storing events associated with vehicles into log file and into database. Used for situations such as vehicles becoming predictable or unpredictable and specifying why. The resulting information can be mapped out for finding problems.

Author:

SkiBu Smith

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ASSIGNMENT_CHANGED
static java.lang.String	ASSIGNMENT_GRABBED
static java.lang.String	DELAYED
static java.lang.String	END_OF_BLOCK
static java.lang.String	LEFT_TERMINAL_EARLY
static java.lang.String	LEFT_TERMINAL_LATE
static java.lang.String	NO_MATCH
static java.lang.String	NO_PROGRESS
static java.lang.String	NOT_LEAVING_TERMINAL
static java.lang.String	PREDICTABLE
static java.lang.String	TIMEOUT

Method Summary

Modifier and Type	Method and Description
static VehicleEvent	create(AvlReport avlReport, TemporalMatch match, java.lang.String eventType, java.lang.String description, boolean predictable, boolean becameUnpredictable, java.lang.String supervisor) A simpler way to create a VehicleEvent that gets a lot of its info from the avlReport and match params.
static VehicleEvent	create(java.util.Date time, java.util.Date avlTime, java.lang.String vehicleId, java.lang.String eventType, java.lang.String description, boolean predictable, boolean becameUnpredictable, java.lang.String supervisor, Location location, java.lang.String routeId, java.lang.String routeShortName, java.lang.String blockId, java.lang.String serviceId, java.lang.String tripId, java.lang.String stopId) Constructs a vehicle event and logs it and queues it to be stored in database.
boolean	equals(java.lang.Object obj) Because using a composite Id Hibernate wants this method.
java.util.Date	getAvlTime()
java.lang.String	getBlockId()
java.lang.String	getDescription()
java.lang.String	getEventType()
Location	getLocation()
java.lang.String	getRouteId()
java.lang.String	getRouteShortName()
java.lang.String	getServiceId()
java.lang.String	getStopId()
java.lang.String	getSupervisor()
java.util.Date	getTime()
java.lang.String	getTripId()
static java.util.List<VehicleEvent>	getVehicleEvents(java.lang.String agencyId, java.util.Date beginTime, java.util.Date endTime, java.lang.String sqlClause) Reads in all VehicleEvents from the database that were between the beginTime and endTime.
java.lang.String	getVehicleId()
int	hashCode() Because using a composite Id Hibernate wants this method.
boolean	isBecameUnpredictable()
boolean	isPredictable()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

PREDICTABLE

public static final java.lang.String PREDICTABLE

See Also:

Constant Field Values

TIMEOUT

public static final java.lang.String TIMEOUT

See Also:

Constant Field Values

NO_MATCH

public static final java.lang.String NO_MATCH

See Also:

Constant Field Values

NO_PROGRESS

public static final java.lang.String NO_PROGRESS

See Also:

Constant Field Values

DELAYED

public static final java.lang.String DELAYED

See Also:

Constant Field Values

END_OF_BLOCK

public static final java.lang.String END_OF_BLOCK

See Also:

Constant Field Values

LEFT_TERMINAL_EARLY

public static final java.lang.String LEFT_TERMINAL_EARLY

See Also:

Constant Field Values

LEFT_TERMINAL_LATE

public static final java.lang.String LEFT_TERMINAL_LATE

See Also:

Constant Field Values

NOT_LEAVING_TERMINAL

public static final java.lang.String NOT_LEAVING_TERMINAL

See Also:

Constant Field Values

ASSIGNMENT_GRABBED

public static final java.lang.String ASSIGNMENT_GRABBED

See Also:

Constant Field Values

ASSIGNMENT_CHANGED

public static final java.lang.String ASSIGNMENT_CHANGED

See Also:

Constant Field Values

Method Detail

create

public static VehicleEvent create(java.util.Date time,
                                  java.util.Date avlTime,
                                  java.lang.String vehicleId,
                                  java.lang.String eventType,
                                  java.lang.String description,
                                  boolean predictable,
                                  boolean becameUnpredictable,
                                  java.lang.String supervisor,
                                  Location location,
                                  java.lang.String routeId,
                                  java.lang.String routeShortName,
                                  java.lang.String blockId,
                                  java.lang.String serviceId,
                                  java.lang.String tripId,
                                  java.lang.String stopId)

Constructs a vehicle event and logs it and queues it to be stored in database.

Parameters:

time -

avlTime -

vehicleId -

eventType -

description -

predictable -

becameUnpredictable -

supervisor -

location -

routeId -

routeShortName -

blockId -

serviceId -

tripId -

stopId -

Returns:

The VehicleEvent constructed

create

public static VehicleEvent create(AvlReport avlReport,
                                  TemporalMatch match,
                                  java.lang.String eventType,
                                  java.lang.String description,
                                  boolean predictable,
                                  boolean becameUnpredictable,
                                  java.lang.String supervisor)

A simpler way to create a VehicleEvent that gets a lot of its info from the avlReport and match params. This also logs it and queues it to be stored in database. The match param can be null.

Parameters:

avlReport -

match -

eventType -

description -

predictable -

becameUnpredictable -

supervisor -

Returns:

The VehicleEvent constructed

hashCode

public int hashCode()

Because using a composite Id Hibernate wants this method.

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Because using a composite Id Hibernate wants this method.

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getVehicleEvents

public static java.util.List<VehicleEvent> getVehicleEvents(java.lang.String agencyId,
                                                            java.util.Date beginTime,
                                                            java.util.Date endTime,
                                                            java.lang.String sqlClause)

Reads in all VehicleEvents from the database that were between the beginTime and endTime.

Parameters:

agencyId - Which project getting data for

beginTime - Specifies time range for query

endTime - Specifies time range for query

sqlClause - Optional. Can specify an SQL clause to winnow down the data, such as "AND routeId='71'".

Returns:

getTime

public java.util.Date getTime()

Returns:

the system time of when the event was created.

getAvlTime

public java.util.Date getAvlTime()

Returns:

the time of the AVL report that generated the event

getVehicleId

public java.lang.String getVehicleId()

getEventType

public java.lang.String getEventType()

getDescription

public java.lang.String getDescription()

isPredictable

public boolean isPredictable()

isBecameUnpredictable

public boolean isBecameUnpredictable()

getSupervisor

public java.lang.String getSupervisor()

getLocation

public Location getLocation()

getRouteId

public java.lang.String getRouteId()

getRouteShortName

public java.lang.String getRouteShortName()

getBlockId

public java.lang.String getBlockId()

getServiceId

public java.lang.String getServiceId()

getTripId

public java.lang.String getTripId()

getStopId

public java.lang.String getStopId()