org.transitime.ipc.servers

Class PredictionsServer

java.lang.Object

org.transitime.ipc.rmi.AbstractServer

org.transitime.ipc.servers.PredictionsServer

All Implemented Interfaces:

java.rmi.Remote, PredictionsInterface

public class PredictionsServer
extends AbstractServer
implements PredictionsInterface

Implements the PredictionsInterface interface on the server side such that a PredictionsInterfaceFactory can make RMI calls in order to obtain prediction information. The prediction information is provided using org.transitime.ipc.data.Prediction objects.

Author:

SkiBu Smith

Nested Class Summary

Nested classes/interfaces inherited from interface org.transitime.ipc.interfaces.PredictionsInterface

PredictionsInterface.RouteStop

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 routeIdOrShortName, 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.
static PredictionsServer	start(java.lang.String agencyId, PredictionDataCache predictionDataCache) Starts up the PredictionsServer so that RMI calls can query for predictions.

Methods inherited from class org.transitime.ipc.rmi.AbstractServer

getAgencyId, getBindName, isConstructed

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

start

public static PredictionsServer start(java.lang.String agencyId,
                                      PredictionDataCache predictionDataCache)

Starts up the PredictionsServer so that RMI calls can query for predictions. This will automatically cause the object to continue to run and serve requests.

Parameters:

agencyId -

predictionDataCache -

Returns:

the singleton PredictionsServer object. Usually does not need to used since the server will be fully running.

get

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

Description copied from interface: PredictionsInterface

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

Specified by:

get in interface PredictionsInterface

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

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

Description copied from interface: PredictionsInterface

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.

Specified by:

get in interface PredictionsInterface

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

getAllPredictions

public java.util.List<IpcPredictionsForRouteStopDest> getAllPredictions(int predictionMaxFutureSecs)

Description copied from interface: PredictionsInterface

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

Specified by:

getAllPredictions in interface PredictionsInterface

Returns:

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

get

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

Description copied from interface: PredictionsInterface

Returns predictions based on the specified location.

Specified by:

get in interface PredictionsInterface

Parameters:

loc - The user's location

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

Returns:

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

Throws:

java.rmi.RemoteException