Package org.onebusaway.federations

Interface FederatedServiceCollection

All Known Implementing Classes:

AbstractFederatedServiceCollectionWrapperImpl, DynamicFederatedServiceCollectionImpl, FederatedServiceCollectionImpl, LazyFederatedServiceCollectionImpl

public interface FederatedServiceCollection

A collection of FederatedService instances. Provides interface for querying instances by agency id and geographic location. A basic implementation can be found in FederatedServiceCollectionImpl, which takes a map of FederatedService instances and provides the require querying mechanims. More powerful implementations exist as well. The DynamicFederatedServiceCollectionImpl is backed by a FederatedServiceRegistry to dynamically update the set of available FederatedService instances, potentially from a remote source.

Author:

bdferris

See Also:

FederatedServiceCollectionImpl, DynamicFederatedServiceCollectionImpl

Method Summary

Modifier and Type	Method	Description
Set<FederatedService>	getAllServices()
FederatedService	getServiceForAgencyId(String agencyId)
FederatedService	getServiceForAgencyIds(Iterable<String> agencyIds)
FederatedService	getServiceForBounds(double lat1, double lon1, double lat2, double lon2)
FederatedService	getServiceForBounds(CoordinateBounds bounds)
FederatedService	getServiceForLocation(double lat, double lon)
FederatedService	getServiceForLocations(List<CoordinatePoint> points)

Method Detail

getAllServices

Set<FederatedService> getAllServices()

getServiceForAgencyId

FederatedService getServiceForAgencyId(String agencyId)
                                throws ServiceAreaServiceException

Throws:

ServiceAreaServiceException

getServiceForAgencyIds

FederatedService getServiceForAgencyIds(Iterable<String> agencyIds)
                                 throws ServiceAreaServiceException

Throws:

ServiceAreaServiceException

getServiceForBounds

FederatedService getServiceForBounds(CoordinateBounds bounds)
                              throws ServiceAreaServiceException

Throws:

ServiceAreaServiceException

getServiceForBounds

FederatedService getServiceForBounds(double lat1,
                                     double lon1,
                                     double lat2,
                                     double lon2)
                              throws ServiceAreaServiceException

Throws:

ServiceAreaServiceException

getServiceForLocation

FederatedService getServiceForLocation(double lat,
                                       double lon)
                                throws ServiceAreaServiceException

Throws:

ServiceAreaServiceException

getServiceForLocations

FederatedService getServiceForLocations(List<CoordinatePoint> points)
                                 throws ServiceAreaServiceException

Throws:

ServiceAreaServiceException