org.onebusaway.transit_data_federation.services
Interface StopSearchService

All Known Implementing Classes:
StopSearchServiceImpl

public interface StopSearchService

Service interface for searching for Stop ids by stop code and stop name.

Author:
bdferris

Method Summary
 SearchResult<org.onebusaway.gtfs.model.AgencyAndId> searchForStopsByCode(String code, int maxResultCount, double minScoreToKeep)
          Search for stop ids by stop code (see Stop.getCode()).
 SearchResult<org.onebusaway.gtfs.model.AgencyAndId> searchForStopsByName(String name, int maxResultCount, double minScoreToKeep)
          Search for stop ids by stop name (see Stop.getName())
 

Method Detail

searchForStopsByCode

SearchResult<org.onebusaway.gtfs.model.AgencyAndId> searchForStopsByCode(String code,
                                                                         int maxResultCount,
                                                                         double minScoreToKeep)
                                                                         throws IOException,
                                                                                org.apache.lucene.queryParser.ParseException
Search for stop ids by stop code (see Stop.getCode()). Typically default to a search against Stop.getId() if no code is specified for a stop.

Parameters:
code - the stop code query
maxResultCount - maximum number of results to return
minScoreToKeep - implementation-specific score cutoff for search results
Returns:
a search result for matching stop ids
Throws:
IOException
org.apache.lucene.queryParser.ParseException

searchForStopsByName

SearchResult<org.onebusaway.gtfs.model.AgencyAndId> searchForStopsByName(String name,
                                                                         int maxResultCount,
                                                                         double minScoreToKeep)
                                                                         throws IOException,
                                                                                org.apache.lucene.queryParser.ParseException
Search for stop ids by stop name (see Stop.getName())

Parameters:
code - the stop code query
maxResultCount - maximum number of results to return
minScoreToKeep - implementation-specific score cutoff for search results
Returns:
a search result for matching stop ids
Throws:
IOException
org.apache.lucene.queryParser.ParseException


Copyright © 2011 OneBusAway. All Rights Reserved.