org.transitime.db.structs

Class AvlReport

java.lang.Object

org.transitime.db.structs.AvlReport

All Implemented Interfaces:

java.io.Serializable

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

An AvlReport is a GPS report with some additional information, such as vehicleId.

Serializable since Hibernate requires such.

Author:

SkiBu Smith

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AvlReport.AssignmentType

Constructor Summary

Constructors

Constructor and Description
AvlReport(AvlReport toCopy, java.util.Date newTime) Makes a copy of the AvlReport but uses the new time passed in.
AvlReport(AvlReport toCopy, java.lang.String assignmentId, AvlReport.AssignmentType assignmentType) Makes a copy of the AvlReport but uses the new assignment info passed in.
AvlReport(IpcAvl ipcAvl) For converting a RMI IpcAvl object to a regular AvlReport.
AvlReport(java.lang.String vehicleId, long time, double lat, double lon, float speed, float heading, java.lang.String source) Constructor for an AvlReport object that is not yet being processed.
AvlReport(java.lang.String vehicleId, long time, double lat, double lon, float speed, float heading, java.lang.String source, java.lang.String leadVehicleId, java.lang.String driverId, java.lang.String licensePlate, java.lang.Integer passengerCount, float passengerFullness) Constructor for an AvlReport object that is not yet being processed.
AvlReport(java.lang.String vehicleId, long time, double lat, double lon, java.lang.String source)
AvlReport(java.lang.String vehicleId, long time, Location location, float speed, float heading, java.lang.String source) Constructor for an AvlReport object that is not yet being processed.
AvlReport(java.lang.String vehicleId, long time, Location location, java.lang.String source) For when speed and heading are not valid.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAssignmentId() Returns the assignment ID if it is set.
AvlReport.AssignmentType	getAssignmentType()
static java.util.List<AvlReport>	getAvlReportsFromDb(java.util.Date beginTime, java.util.Date endTime, java.lang.String vehicleId, java.lang.String clause) Gets list of AvlReports from database for the time span specified.
java.util.Date	getDate()
java.lang.String	getDriverId()
java.lang.String	getField1Name()
java.lang.String	getField1Value()
float	getHeading() Heading of vehicles in degrees.
double	getLat()
long	getLatency() Returns how many msec elapsed between the GPS fix was generated to the time it was finally processed.
java.lang.String	getLeadVehicleId() Returns the ID of the leading vehicle if this is an AVL report for a non-lead vehicle in a multi-car consist.
java.lang.String	getLicensePlate()
Location	getLocation()
double	getLon()
int	getPassengerCount() Returns the passenger count, as obtained from AVL feed.
float	getPassengerFullness() Fraction indicating how full a vehicle is.
java.lang.String	getSource() The source of the AVL report
float	getSpeed()
long	getTime()
long	getTimeProcessed()
java.lang.String	getVehicleId()
int	hashCode()
boolean	hasValidAssignment() Returns whether assignment information was set in the AVL data and that assignment is valid.
boolean	ignoreBecauseInConsist() If this is a vehicle in a multi-car consist and it is not the lead vehicle then shouldn't generate redundant arrival/departure times, predictions etc.
boolean	isBlockIdAssignmentType() Returns true if AVL report indicates that assignment is a block assignment type such as AssignmentType.BLOCK_ID or AssignmentType.BLOCK_FOR_SCHED_BASED_PREDS.
boolean	isForSchedBasedPreds() Returns true if the AVL report is configured to indicate that it was created to generate schedule based predictions.
boolean	isHeadingValid() For some AVL systems heading is not available and therefore cannot be used.
boolean	isPassengerCountValid() Returns whether the passenger count is valid.
boolean	isPassengerFullnessValid() Returns whether the passenger fullness is valid.
boolean	isRouteIdAssignmentType()
boolean	isSpeedValid() For some AVL systems speed is not available and therefore cannot be used.
boolean	isTripIdAssignmentType()
boolean	isTripShortNameAssignmentType()
static boolean	matchesUnpredictableAssignment(java.lang.String assignment) Returns true if the assignment specified matches the regular expression for unpredictable assignments.
void	setAssignment(java.lang.String assignmentId, AvlReport.AssignmentType assignmentType) Stores the assignment information as part of this AvlReport.
void	setField1(java.lang.String name, java.lang.String value) For containing additional info as part of AVL feed that is specific to a particular feed or a new element.
void	setTimeProcessed() Updates the object to record the current time as the time that the data was actually processed.
java.lang.String	toString()
java.lang.String	validateData() Makes sure that the members of this class all have reasonable values.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AvlReport

public AvlReport(java.lang.String vehicleId,
                 long time,
                 double lat,
                 double lon,
                 float speed,
                 float heading,
                 java.lang.String source)

Constructor for an AvlReport object that is not yet being processed. Since not yet being processed timeProcessed is set to null.

Parameters:

vehicleId - ID of the vehicle

time - Epoch time in msec of GPS report (not when processed)

lat - Latitude in decimal degrees

lon - Longitude in decimal degrees

speed - Speed of vehicle in m/s. Should be set to Float.NaN if speed not available

heading - Heading of vehicle in degrees clockwise from north. Should be set to Float.NaN if speed not available

source - Text describing the source of the report

AvlReport

public AvlReport(java.lang.String vehicleId,
                 long time,
                 Location location,
                 float speed,
                 float heading,
                 java.lang.String source)

Constructor for an AvlReport object that is not yet being processed. Since not yet being processed timeProcessed is set to null.

Parameters:

vehicleId - ID of the vehicle

time - Epoch time in msec of GPS report (not when processed)

location -

speed - Speed of vehicle in m/s. Should be set to Float.NaN if speed not available

heading - Heading of vehicle in degrees clockwise from north. Should be set to Float.NaN if speed not available

source - Text describing the source of the report. Can only be SOURCE_LENGTH (10) characters long

AvlReport

public AvlReport(java.lang.String vehicleId,
                 long time,
                 double lat,
                 double lon,
                 java.lang.String source)

Parameters:

vehicleId - ID of the vehicle

time - Epoch time in msec of GPS report (not when processed) For when speed and heading are not valid. They are set to Float.NaN . Since not yet being processed timeProcessed is set to null.

vehicleId -

time -

lat - Latitude in decimal degrees

lon - Longitude in decimal degrees

source - Text describing the source of the report. Can only be SOURCE_LENGTH (10) characters long

AvlReport

public AvlReport(java.lang.String vehicleId,
                 long time,
                 Location location,
                 java.lang.String source)

For when speed and heading are not valid. They are set to Float.NaN . Since not yet being processed timeProcessed is set to null.

Parameters:

vehicleId -

time -

location -

source - Text describing the source of the report. Can only be SOURCE_LENGTH (10) characters long

AvlReport

public AvlReport(java.lang.String vehicleId,
                 long time,
                 double lat,
                 double lon,
                 float speed,
                 float heading,
                 java.lang.String source,
                 java.lang.String leadVehicleId,
                 java.lang.String driverId,
                 java.lang.String licensePlate,
                 java.lang.Integer passengerCount,
                 float passengerFullness)

Constructor for an AvlReport object that is not yet being processed. Since not yet being processed timeProcessed is set to null.

Parameters:

vehicleId -

time -

lat -

lon -

speed - Speed of vehicle in m/s. Should be set to Float.NaN if speed not available

heading - Heading of vehicle in degrees clockwise from north. Should be set to Float.NaN if speed not available

source - Text describing the source of the report. Can only be SOURCE_LENGTH (10) characters long

leadVehicleId - Optional value. Set to null if not available.

driverId - Optional value. Set to null if not available.

licensePlate - Optional value. Set to null if not available.

passengerCount - Optional value. Set to the number of passengers on vehicles. Set to null if not available.

passengerFullness - Optional Value. Fractional fullness of vehicle. 0.0=empty, 1.0=full. Set to Float.NaN if data not available.

AvlReport

public AvlReport(IpcAvl ipcAvl)

For converting a RMI IpcAvl object to a regular AvlReport.

Parameters:

ipcAvl -

AvlReport

public AvlReport(AvlReport toCopy,
                 java.util.Date newTime)

Makes a copy of the AvlReport but uses the new time passed in. Useful for creating a new AvlReport when AVL timeout occurs when vehicle on a layover.

Parameters:

toCopy - The AvlReport to copy (except for the AVL time)

newTime - The AVL time to use

AvlReport

public AvlReport(AvlReport toCopy,
                 java.lang.String assignmentId,
                 AvlReport.AssignmentType assignmentType)

Makes a copy of the AvlReport but uses the new assignment info passed in. Useful for creating a new AvlReport when a bad assignment is received since one can simply create a new AvlReport with the new assignment info.

Parameters:

toCopy - The AvlReport to copy (except for the AVL time)

assignmentId - The assignment to use

assignmentType - How the assignment was done

Method Detail

validateData

public java.lang.String validateData()

Makes sure that the members of this class all have reasonable values.

Returns:

null if there are no problems. An error message if there are problems with the data.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getVehicleId

public java.lang.String getVehicleId()

getTime

public long getTime()

Returns:

The GPS time of the AVL report

getDate

public java.util.Date getDate()

Returns:

A Date object containing the GPS time

getTimeProcessed

public long getTimeProcessed()

Returns:

The time that the AVL report was received and processed.

getLocation

public Location getLocation()

getLat

public double getLat()

getLon

public double getLon()

getSpeed

public float getSpeed()

Returns:

Speed of vehicle in meters per second. Returns Float.NaN if speed is not valid.

getHeading

public float getHeading()

Heading of vehicles in degrees. The heading can sometimes be invalid. Though internally an invalid heading is stored as null it is returned by this method as NaN so that can return a float. If speed is below AvlConfig.minSpeedForValidHeading() then will also return NaN.

Returns:

Heading of vehicles in degrees. If heading not set or if speed below minimum then Float.NaN is returned.

getSource

public java.lang.String getSource()

The source of the AVL report

Returns:

getLatency

public long getLatency()

Returns how many msec elapsed between the GPS fix was generated to the time it was finally processed. Returns 0 if timeProcessed was never set.

Returns:

isSpeedValid

public boolean isSpeedValid()

For some AVL systems speed is not available and therefore cannot be used.

Returns:

isHeadingValid

public boolean isHeadingValid()

For some AVL systems heading is not available and therefore cannot be used.

Returns:

getAssignmentId

public java.lang.String getAssignmentId()

Returns the assignment ID if it is set. If it is not set then null is returned.

Returns:

getAssignmentType

public AvlReport.AssignmentType getAssignmentType()

isBlockIdAssignmentType

public boolean isBlockIdAssignmentType()

Returns true if AVL report indicates that assignment is a block assignment type such as AssignmentType.BLOCK_ID or AssignmentType.BLOCK_FOR_SCHED_BASED_PREDS.

Returns:

true if block assignment

isTripIdAssignmentType

public boolean isTripIdAssignmentType()

isTripShortNameAssignmentType

public boolean isTripShortNameAssignmentType()

isRouteIdAssignmentType

public boolean isRouteIdAssignmentType()

matchesUnpredictableAssignment

public static boolean matchesUnpredictableAssignment(java.lang.String assignment)

Returns true if the assignment specified matches the regular expression for unpredictable assignments.

Parameters:

assignment -

Returns:

true if assignment matches regular expression

hasValidAssignment

public boolean hasValidAssignment()

Returns whether assignment information was set in the AVL data and that assignment is valid. An assignment is not valid if it is configured to be invalid. Examples of such include training vehicles, support vehicles, and simply vehicles set to a special assignment such as 9999 for sfmta.

Returns:

true if has assignment and it is valid. Otherwise false.

setAssignment

public void setAssignment(java.lang.String assignmentId,
                          AvlReport.AssignmentType assignmentType)

Stores the assignment information as part of this AvlReport. If vehicle is to not have an assignment need to set assignmentId to null and set assignmentType to AssignmentType.UNSET.

Parameters:

assignmentId -

assignmentType -

getLeadVehicleId

public java.lang.String getLeadVehicleId()

Returns the ID of the leading vehicle if this is an AVL report for a non-lead vehicle in a multi-car consist. Otherwise returns null.

Returns:

setField1

public void setField1(java.lang.String name,
                      java.lang.String value)

For containing additional info as part of AVL feed that is specific to a particular feed or a new element.

Parameters:

name -

value -

ignoreBecauseInConsist

public boolean ignoreBecauseInConsist()

If this is a vehicle in a multi-car consist and it is not the lead vehicle then shouldn't generate redundant arrival/departure times, predictions etc.

Returns:

True if non-lead car in multi-car consist

getDriverId

public java.lang.String getDriverId()

getLicensePlate

public java.lang.String getLicensePlate()

getPassengerCount

public int getPassengerCount()

Returns the passenger count, as obtained from AVL feed. If passenger count not available returns -1.

Returns:

isPassengerCountValid

public boolean isPassengerCountValid()

Returns whether the passenger count is valid.

Returns:

true if count is valid.

getPassengerFullness

public float getPassengerFullness()

Fraction indicating how full a vehicle is. Returns NaN if info not available.

Returns:

isPassengerFullnessValid

public boolean isPassengerFullnessValid()

Returns whether the passenger fullness is valid.

Returns:

true if passenger fullness is valid.

setTimeProcessed

public void setTimeProcessed()

Updates the object to record the current time as the time that the data was actually processed.

getField1Name

public java.lang.String getField1Name()

getField1Value

public java.lang.String getField1Value()

isForSchedBasedPreds

public boolean isForSchedBasedPreds()

Returns true if the AVL report is configured to indicate that it was created to generate schedule based predictions.

Returns:

true if for schedule based predictions

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAvlReportsFromDb

public static java.util.List<AvlReport> getAvlReportsFromDb(java.util.Date beginTime,
                                                            java.util.Date endTime,
                                                            java.lang.String vehicleId,
                                                            java.lang.String clause)

Gets list of AvlReports from database for the time span specified.

Parameters:

beginTime -

endTime -

vehicleId - Optional. If not null then will only return results for that vehicle

clause - Optional. If not null then the clause, such as "ORDER BY time" will be added to the hql statement.

Returns:

List of AvlReports or null if an exception is thrown