org.onebusaway.transit_data_federation.services
Interface RouteCollectionSearchService

All Known Implementing Classes:

RouteCollectionSearchServiceImpl

public interface RouteCollectionSearchService

Service interface for searching for RouteCollectionEntry ids by route short names and other parameters.

Author:

bdferris

See Also:

RouteCollectionEntry

Method Summary

SearchResult<org.onebusaway.gtfs.model.AgencyAndId>

searchForRoutesByName(String nameQuery, int maxResultCount, double minScoreToKeep)

Method Detail

searchForRoutesByName

SearchResult<org.onebusaway.gtfs.model.AgencyAndId> searchForRoutesByName(String nameQuery,
                                                                          int maxResultCount,
                                                                          double minScoreToKeep)
                                                                          throws IOException,
                                                                                 org.apache.lucene.queryParser.ParseException

Parameters:

nameQuery - the route short name query

maxResultCount - maximum number of results to keep

minScoreToKeep - score tuning metric to prune result (implementation dependent)

Returns:

a search result for RouteCollectionEntry ids matching the specified short name query

Throws:

IOException

org.apache.lucene.queryParser.ParseException