org.onebusaway.transit_data_federation.services.beans
Interface TripDetailsBeanService

All Known Implementing Classes:
TripStatusBeanServiceImpl

public interface TripDetailsBeanService

Service methods for querying the real-time status and position of a particular trip.

Author:
bdferris
See Also:
TripDetailsBean

Method Summary
 TripStatusBean getBlockLocationAsStatusBean(BlockLocation blockLocation, long time)
          Convert a BlockLocation object into a trip status bean
 TripDetailsBean getTripForId(TripDetailsQueryBean query)
          There are potential multiple matching trips for this method.
 TripDetailsBean getTripForVehicle(org.onebusaway.gtfs.model.AgencyAndId vehicleId, long time, TripDetailsInclusionBean tripDetailsInclusionBean)
           
 ListBean<TripDetailsBean> getTripsForAgency(TripsForAgencyQueryBean query)
           
 ListBean<TripDetailsBean> getTripsForBounds(TripsForBoundsQueryBean query)
           
 ListBean<TripDetailsBean> getTripsForId(TripDetailsQueryBean query)
           
 ListBean<TripDetailsBean> getTripsForRoute(TripsForRouteQueryBean query)
           
 

Method Detail

getTripForId

TripDetailsBean getTripForId(TripDetailsQueryBean query)
There are potential multiple matching trips for this method. In such a case, we'll return the trip with the first vehicle id, as determined by string sorted order.

Parameters:
query -
Returns:
trip details for the trip matching the specified query criteria (tripId, service, and optional vehicleId), or null if none found

getTripsForId

ListBean<TripDetailsBean> getTripsForId(TripDetailsQueryBean query)
Parameters:
query -
Returns:
trip details for the trips matching the specified query criteria (tripId, service, and optional vehicleId)

getTripForVehicle

TripDetailsBean getTripForVehicle(org.onebusaway.gtfs.model.AgencyAndId vehicleId,
                                  long time,
                                  TripDetailsInclusionBean tripDetailsInclusionBean)
Parameters:
vehicleId -
time -
tripDetailsInclusionBean - controls what will be included in the response
Returns:
trip details for the trip operated by the specified vehicle at the specified time, or null if not found

getTripsForBounds

ListBean<TripDetailsBean> getTripsForBounds(TripsForBoundsQueryBean query)
Parameters:
query -
Returns:
the list of active trips matching the query criteria

getTripsForRoute

ListBean<TripDetailsBean> getTripsForRoute(TripsForRouteQueryBean query)
Parameters:
query -
Returns:
the list of active trips matching the route query criteria

getTripsForAgency

ListBean<TripDetailsBean> getTripsForAgency(TripsForAgencyQueryBean query)
Parameters:
query -
Returns:
the list of active trips matching agency query criteria

getBlockLocationAsStatusBean

TripStatusBean getBlockLocationAsStatusBean(BlockLocation blockLocation,
                                            long time)
Convert a BlockLocation object into a trip status bean

Parameters:
blockLocation -
time - TODO
Returns:
a trip status bean representation of a block location object


Copyright © 2011 OneBusAway. All Rights Reserved.