org.transitime.ipc.interfaces

Interface ConfigInterface

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

ConfigServer

public interface ConfigInterface
extends java.rmi.Remote

Defines the RMI interface for getting configuration data.

Author:

SkiBu Smith

Method Summary

Modifier and Type	Method and Description
java.util.List<Agency>	getAgencies() Returns list of Agency objects containing data from GTFS agency.txt file
java.util.List<IpcCalendar>	getAllCalendars() Returns list of all Calendar objects.
IpcBlock	getBlock(java.lang.String blockId, java.lang.String serviceId) Returns block info for specified blockId and serviceId.
java.util.List<java.lang.String>	getBlockIds() Returns list of block IDs, unsorted, duplicates removed
java.util.List<java.lang.String>	getBlockIds(java.lang.String serviceId) Returns list of block IDs for specified serviceId, unsorted
java.util.Collection<IpcBlock>	getBlocks(java.lang.String blockId) Returns blocks for each service class for the blockId specified.
java.util.List<IpcCalendar>	getCurrentCalendars() Returns list of Calendar objects that are currently active.
java.util.List<java.lang.String>	getCurrentServiceIds() Returns list of service IDs, unsorted
IpcRoute	getRoute(java.lang.String routeIdOrShortName, java.lang.String directionId, java.lang.String stopId, java.lang.String tripPatternId) Obtains data for single route.
java.util.Collection<IpcRouteSummary>	getRoutes() Obtains ordered list of routes configured.
java.util.List<IpcSchedule>	getSchedules(java.lang.String routeIdOrShortName) Returns list of IpcSchedule objects for the specified routeIdOrShortName
java.util.List<java.lang.String>	getServiceIds() Returns list of service IDs, unsorted
IpcDirectionsForRoute	getStops(java.lang.String routeIdOrShortName) Returns stops for each direction for a route.
IpcTrip	getTrip(java.lang.String tripId) Returns trip info for specified tripId.
java.util.List<java.lang.String>	getTripIds() Returns list of trip IDs, unsorted
java.util.List<IpcTripPattern>	getTripPatterns(java.lang.String routeIdOrShortName) Returns trip patterns for specified routeIdOrShortName.
java.util.List<java.lang.String>	getVehicleIds() Returns list of vehicle IDs, unsorted

Method Detail

getRoutes

java.util.Collection<IpcRouteSummary> getRoutes()
                                         throws java.rmi.RemoteException

Obtains ordered list of routes configured.

Returns:

Throws:

java.rmi.RemoteException

getRoute

IpcRoute getRoute(java.lang.String routeIdOrShortName,
                  java.lang.String directionId,
                  java.lang.String stopId,
                  java.lang.String tripPatternId)
           throws java.rmi.RemoteException

Obtains data for single route.

Parameters:

routeIdOrShortName - Specifies which route to provide data for. routeShortName is often used instead of routeId since routeIds unfortunately often change when there is a schedule change.

directionId - optional. If want UI to highlight the remaining stops and paths left in the trip then can specify directionId along with the stopId. The directionId can be needed for agencies where only a single stop is used for both directions for a route.

stopId - optional. If want UI to highlight the remaining stops and paths left in trip then stopId is used to return which stops remain in trip. If this additional info not needed for UI then null can be specified.

tripPatternId - optional. If want UI to highlight the remaining stops and paths left in trip then stopId is used to determine which trip pattern to highlight. If this additional info not needed for UI then null can be specified.

Returns:

Throws:

java.rmi.RemoteException

getStops

IpcDirectionsForRoute getStops(java.lang.String routeIdOrShortName)
                        throws java.rmi.RemoteException

Returns stops for each direction for a route.

Parameters:

routeIdOrShortName - Specifies which route to provide data for. routeShortName is often used instead of routeId since routeIds unfortunately often change when there is a schedule change.

Returns:

Throws:

java.rmi.RemoteException

getBlock

IpcBlock getBlock(java.lang.String blockId,
                  java.lang.String serviceId)
           throws java.rmi.RemoteException

Returns block info for specified blockId and serviceId. Includes all trip and trip pattern info associated with the block.

Parameters:

blockId -

serviceId -

Returns:

Throws:

java.rmi.RemoteException

getBlocks

java.util.Collection<IpcBlock> getBlocks(java.lang.String blockId)
                                  throws java.rmi.RemoteException

Returns blocks for each service class for the blockId specified.

Parameters:

blockId -

Returns:

Throws:

java.rmi.RemoteException

getTrip

IpcTrip getTrip(java.lang.String tripId)
         throws java.rmi.RemoteException

Returns trip info for specified tripId. Includes all trip pattern info associated with the trip.

Parameters:

tripId -

Returns:

Throws:

java.rmi.RemoteException

getTripPatterns

java.util.List<IpcTripPattern> getTripPatterns(java.lang.String routeIdOrShortName)
                                        throws java.rmi.RemoteException

Returns trip patterns for specified routeIdOrShortName.

Parameters:

routeIdOrShortName -

Returns:

Throws:

java.rmi.RemoteException

getSchedules

java.util.List<IpcSchedule> getSchedules(java.lang.String routeIdOrShortName)
                                  throws java.rmi.RemoteException

Returns list of IpcSchedule objects for the specified routeIdOrShortName

Parameters:

routeIdOrShortName -

Returns:

Throws:

java.rmi.RemoteException

getAgencies

java.util.List<Agency> getAgencies()
                            throws java.rmi.RemoteException

Returns list of Agency objects containing data from GTFS agency.txt file

Returns:

Throws:

java.rmi.RemoteException

getCurrentCalendars

java.util.List<IpcCalendar> getCurrentCalendars()
                                         throws java.rmi.RemoteException

Returns list of Calendar objects that are currently active.

Returns:

Throws:

java.rmi.RemoteException

getAllCalendars

java.util.List<IpcCalendar> getAllCalendars()
                                     throws java.rmi.RemoteException

Returns list of all Calendar objects.

Returns:

Throws:

java.rmi.RemoteException

getVehicleIds

java.util.List<java.lang.String> getVehicleIds()
                                        throws java.rmi.RemoteException

Returns list of vehicle IDs, unsorted

Returns:

vehicle IDs

Throws:

java.rmi.RemoteException

getServiceIds

java.util.List<java.lang.String> getServiceIds()
                                        throws java.rmi.RemoteException

Returns list of service IDs, unsorted

Returns:

vehicle IDs

Throws:

java.rmi.RemoteException

getCurrentServiceIds

java.util.List<java.lang.String> getCurrentServiceIds()
                                               throws java.rmi.RemoteException

Returns list of service IDs, unsorted

Returns:

vehicle IDs

Throws:

java.rmi.RemoteException

getTripIds

java.util.List<java.lang.String> getTripIds()
                                     throws java.rmi.RemoteException

Returns list of trip IDs, unsorted

Returns:

vehicle IDs

Throws:

java.rmi.RemoteException

getBlockIds

java.util.List<java.lang.String> getBlockIds()
                                      throws java.rmi.RemoteException

Returns list of block IDs, unsorted, duplicates removed

Returns:

vehicle IDs

Throws:

java.rmi.RemoteException

getBlockIds

java.util.List<java.lang.String> getBlockIds(java.lang.String serviceId)
                                      throws java.rmi.RemoteException

Returns list of block IDs for specified serviceId, unsorted

Parameters:

serviceId - If null then all block IDs are returned

Returns:

vehicle IDs

Throws:

java.rmi.RemoteException