org.onebusaway.transit_data_federation.services.narrative
Interface NarrativeService

All Known Implementing Classes:
NarrativeServiceImpl

public interface NarrativeService

Service methods supporting narrative querying. We define "narrative" as any information that isn't used in raw schedule, trip planning, and routing computations, but instead is simply there to provide human-readable labels to results. For example, a stop's id is a raw data attribute that will be used in method queries and data structures, but the stop name is a human-readable element that typically isn't needed until constructing a result to display to the user. The narrative service has methods for querying narrative objects for various low-level objects, such as Agency, Stop, RouteCollectionEntry, Trip, and StopTime.

Author:
bdferris
See Also:
AgencyNarrative, StopNarrative, RouteCollectionNarrative, TripNarrative, StopTimeNarrative

Method Summary
 AgencyNarrative getAgencyForId(String agencyId)
           
 RouteCollectionNarrative getRouteCollectionForId(org.onebusaway.gtfs.model.AgencyAndId routeCollectionId)
           
 ShapePoints getShapePointsForId(org.onebusaway.gtfs.model.AgencyAndId id)
           
 StopNarrative getStopForId(org.onebusaway.gtfs.model.AgencyAndId stopId)
           
 StopTimeNarrative getStopTimeForEntry(StopTimeEntry entry)
           
 TripNarrative getTripForId(org.onebusaway.gtfs.model.AgencyAndId tripId)
           
 

Method Detail

getAgencyForId

AgencyNarrative getAgencyForId(String agencyId)

getRouteCollectionForId

RouteCollectionNarrative getRouteCollectionForId(org.onebusaway.gtfs.model.AgencyAndId routeCollectionId)

getStopForId

StopNarrative getStopForId(org.onebusaway.gtfs.model.AgencyAndId stopId)

getTripForId

TripNarrative getTripForId(org.onebusaway.gtfs.model.AgencyAndId tripId)

getStopTimeForEntry

StopTimeNarrative getStopTimeForEntry(StopTimeEntry entry)

getShapePointsForId

ShapePoints getShapePointsForId(org.onebusaway.gtfs.model.AgencyAndId id)


Copyright © 2011 OneBusAway. All Rights Reserved.