| java.lang.Object | ||
| ↳ | com.carto.geocoding.GeocodingService | |
| ↳ | com.carto.geocoding.PeliasOnlineGeocodingService | |
Class Overview
An online geocoding service that uses Mapzen Pelias geocoder.
As the class connects to an external (non-CARTO) service, this class is provided "as-is",
future changes from the service provider may not be compatible with the implementation.
Geocoding and reverse geocoding perform network requests and must be executed in non-UI background thread.
Be sure to read the Terms and Conditions of your Pelias service provider to see if the
service is available for your application.
Note: this class is experimental and may change or even be removed in future SDK versions.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
PeliasOnlineGeocodingService(String apiKey)
Constructs a new instance of the PeliasOnlineGeocodingService given API key.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| GeocodingResultVector |
calculateAddresses(GeocodingRequest request)
Calculates matching addresses from the specified geocoding request.
| ||||||||||
| synchronized void | delete() | ||||||||||
| String |
getCustomServiceURL()
Returns the custom backend service URL.
| ||||||||||
| String |
getLanguage()
Returns the language of the expected results.
| ||||||||||
| int |
getMaxResults()
Returns the maximum number of results the geocoding service returns.
| ||||||||||
| boolean |
isAutocomplete()
Returns the autocomplete flag of the service.
| ||||||||||
| void |
setAutocomplete(boolean autocomplete)
Sets the autocomplete flag of the service.
| ||||||||||
| void |
setCustomServiceURL(String serviceURL)
Sets the custom backend service URL.
| ||||||||||
| void |
setLanguage(String lang)
Sets the language of the expected results.
| ||||||||||
| void |
setMaxResults(int maxResults)
Sets the maximum number of results the geocoding service returns.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
com.carto.geocoding.GeocodingService
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public PeliasOnlineGeocodingService (String apiKey)
Constructs a new instance of the PeliasOnlineGeocodingService given API key.
Parameters
| apiKey | The API key to use (registered with Mapzen). |
|---|
Public Methods
public GeocodingResultVector calculateAddresses (GeocodingRequest request)
Calculates matching addresses from the specified geocoding request.
Parameters
| request | The geocoding request to use. |
|---|
Returns
- The list of matching geocoding results, sorted by descending ranks.
Throws
| IOException |
|---|
public synchronized void delete ()
public String getCustomServiceURL ()
Returns the custom backend service URL.
Returns
- The custom backend service URL. If this is not defined, an empty string is returned.
public String getLanguage ()
Returns the language of the expected results.
Returns
- The language of the expected results. As ISO 639-1 code or empty string.
public int getMaxResults ()
Returns the maximum number of results the geocoding service returns.
Returns
- The maximum number of results the geocoding service returns.
public boolean isAutocomplete ()
Returns the autocomplete flag of the service.
Returns
- The autocomplete flag of the service.
public void setAutocomplete (boolean autocomplete)
Sets the autocomplete flag of the service.
By default this flag is off.
Parameters
| autocomplete | The new value for autocomplete flag. |
|---|
public void setCustomServiceURL (String serviceURL)
Sets the custom backend service URL.
The custom URL may contain tag "{api_key}" which will be substituted with the set API key.
The custom URL should contain tag "{mode}" which will be set either to "autocomplete" or "search" based on the autocomplete state.
Parameters
| serviceURL | The custom backend service URL to use. If this is empty, then the default service is used. |
|---|
public void setLanguage (String lang)
Sets the language of the expected results.
Parameters
| lang | The language to use as ISO 639-1 code. Empty string can be used for default language. |
|---|
public void setMaxResults (int maxResults)
Sets the maximum number of results the geocoding service returns.
The default number of results is service dependant (normally 10).
Parameters
| maxResults | The new maximum number of results the geocoding service returns. |
|---|