org.opentripplanner.index

Class GeocoderResource

java.lang.Object

org.opentripplanner.index.GeocoderResource

@Path(value="/routers/{routerId}/geocode")
 @Produces(value="application/json")
public class GeocoderResource
extends Object

OTP simple built-in geocoder. Client geocoder modules usually read XML, but GeocoderBuiltin reads JSON.

Constructor Summary

Constructors

Constructor and Description
GeocoderResource(OTPServer otpServer, String routerId)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	textSearch(String query, boolean autocomplete, boolean stops, boolean clusters, boolean corners) Geocode using data using the OTP graph for stops, clusters and street names

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeocoderResource

public GeocoderResource(@Context
                        OTPServer otpServer,
                        @PathParam(value="routerId")
                        String routerId)

Method Detail

textSearch

@GET
public javax.ws.rs.core.Response textSearch(@QueryParam(value="query")
                                                 String query,
                                                 @QueryParam(value="autocomplete") @DefaultValue(value="false")
                                                 boolean autocomplete,
                                                 @QueryParam(value="stops") @DefaultValue(value="true")
                                                 boolean stops,
                                                 @QueryParam(value="clusters") @DefaultValue(value="false")
                                                 boolean clusters,
                                                 @QueryParam(value="corners") @DefaultValue(value="true")
                                                 boolean corners)

Geocode using data using the OTP graph for stops, clusters and street names

Parameters:

query - The query string we want to geocode

autocomplete - Whether we should use the query string to do a prefix match

stops - Search for stops, either by name or stop code

clusters - Search for clusters by their name

corners - Search for street corners using at least one of the street names

Returns:

list of results in in the format expected by GeocoderBuiltin.js in the OTP Leaflet client