Package com.massifmaps.geocoding

Class PeliasOnlineReverseGeocodingService

java.lang.Object
com.massifmaps.geocoding.ReverseGeocodingService
com.massifmaps.geocoding.PeliasOnlineReverseGeocodingService
public class PeliasOnlineReverseGeocodingService extends ReverseGeocodingService
An online reverse geocoding service that uses Mapzen Pelias geocoder.
As the class connects to an external (non-Massif) 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.

  • Constructor Details

    • PeliasOnlineReverseGeocodingService

      public PeliasOnlineReverseGeocodingService(String apiKey)
      Constructs a new instance of the PeliasOnlineReverseGeocodingService given API key.
      Parameters:
      apiKey - The API key to use (registered with Mapzen).

  • Method Details

    • getCustomServiceURL

      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.

    • setCustomServiceURL

      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.
      Parameters:
      serviceURL - The custom backend service URL to use. If this is empty, then the default service is used.

    • getLanguage

      public String getLanguage()
      Description copied from class: ReverseGeocodingService
      Returns the language of the expected results.
      Overrides:
      getLanguage in class ReverseGeocodingService
      Returns:
      The language of the expected results. As ISO 639-1 code or empty string.

    • setLanguage

      public void setLanguage(String lang)
      Description copied from class: ReverseGeocodingService
      Sets the language of the expected results.
      Overrides:
      setLanguage in class ReverseGeocodingService
      Parameters:
      lang - The language to use as ISO 639-1 code. Empty string can be used for default language.

    • calculateAddresses

      public GeocodingResultVector calculateAddresses(ReverseGeocodingRequest request) throws IOException
      Description copied from class: ReverseGeocodingService
      Calculates matching addresses from the specified reverse geocoding request.
      Overrides:
      calculateAddresses in class ReverseGeocodingService
      Parameters:
      request - The reverse geocoding request to use.
      Returns:
      The list of matching geocoding results, sorted by descending ranks.
      Throws:
      IOException