org.transitime.ipc.interfaces

Interface PredictionsInterface

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

PredictionsServer

public interface PredictionsInterface
extends java.rmi.Remote

Defines the RMI interface used for obtaining predictions.

Author:

SkiBu Smith

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PredictionsInterface.RouteStop This class is for use as key into hash maps that store prediction data.

Method Summary

Modifier and Type	Method and Description
java.util.List<IpcPredictionsForRouteStopDest>	get(java.util.List<PredictionsInterface.RouteStop> routeStops, int predictionsPerStop) For each route/stop specified returns a list of predictions for that stop.
java.util.List<IpcPredictionsForRouteStopDest>	get(Location loc, double maxDistance, int predictionsPerStop) Returns predictions based on the specified location.
java.util.List<IpcPredictionsForRouteStopDest>	get(java.lang.String routeShortName, java.lang.String stopId, int predictionsPerStop) Returns list of current predictions for the specified route/stop.
java.util.List<IpcPredictionsForRouteStopDest>	getAllPredictions(int predictionMaxFutureSecs) Returns all predictions.

Method Detail

get

java.util.List<IpcPredictionsForRouteStopDest> get(java.lang.String routeShortName,
                                                   java.lang.String stopId,
                                                   int predictionsPerStop)
                                            throws java.rmi.RemoteException

Returns list of current predictions for the specified route/stop.

Parameters:

routeIdOrShortName - Can be either the GTFS route_id or the route_short_name.

stopId -

predictionsPerStop - Max number of predictions to return for route/stop

Returns:

List of PredictionsForRouteStop objects for the route/stop, one for each destination

Throws:

java.rmi.RemoteException

get

java.util.List<IpcPredictionsForRouteStopDest> get(java.util.List<PredictionsInterface.RouteStop> routeStops,
                                                   int predictionsPerStop)
                                            throws java.rmi.RemoteException

For each route/stop specified returns a list of predictions for that stop. Since expensive RMI calls are being done this method is much more efficient for obtaining multiple predictions then if a separate get() call is done for each route/stop.

Parameters:

routeStops - List of route/stops to return predictions for. Uses route short name or route ID

predictionsPerStop - Max number of predictions to return per route/stop

Returns:

List of PredictionsForRouteStop objects for the route/stop. There is a separate one for each destination for each route/stop.

Throws:

java.rmi.RemoteException

get

java.util.List<IpcPredictionsForRouteStopDest> get(Location loc,
                                                   double maxDistance,
                                                   int predictionsPerStop)
                                            throws java.rmi.RemoteException

Returns predictions based on the specified location.

Parameters:

loc - The user's location

maxDistance - How far a stop can be away from the loc

predictionsPerStop -

Returns:

List of PredictionsForRouteStop objects for the location. There is a separate one for each destination for each route/stop.

Throws:

java.rmi.RemoteException

getAllPredictions

java.util.List<IpcPredictionsForRouteStopDest> getAllPredictions(int predictionMaxFutureSecs)
                                                          throws java.rmi.RemoteException

Returns all predictions. This is intended for clients such as the GTFS-RT vehicle update feed that outputs all predictions by trip.

Parameters:

predictionMaxFutureSecs -

Returns:

List of all PredictionsForRouteStop objects for system. There is a separate one for every route/stop/destination.

Throws:

java.rmi.RemoteException