Package com.massifmaps.geocoding

Class PeliasOnlineGeocodingService

java.lang.Object
com.massifmaps.geocoding.GeocodingService
com.massifmaps.geocoding.PeliasOnlineGeocodingService
public class PeliasOnlineGeocodingService extends GeocodingService
An online 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

    • PeliasOnlineGeocodingService

      public PeliasOnlineGeocodingService(String apiKey)
      Constructs a new instance of the PeliasOnlineGeocodingService 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.
      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.

    • isAutocomplete

      public boolean isAutocomplete()
      Description copied from class: GeocodingService
      Returns the autocomplete flag of the service.
      Overrides:
      isAutocomplete in class GeocodingService
      Returns:
      The autocomplete flag of the service.

    • setAutocomplete

      public void setAutocomplete(boolean autocomplete)
      Description copied from class: GeocodingService
      Sets the autocomplete flag of the service.
      By default this flag is off.
      Overrides:
      setAutocomplete in class GeocodingService
      Parameters:
      autocomplete - The new value for autocomplete flag.

    • getLanguage

      public String getLanguage()
      Description copied from class: GeocodingService
      Returns the language of the expected results.
      Overrides:
      getLanguage in class GeocodingService
      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: GeocodingService
      Sets the language of the expected results.
      Overrides:
      setLanguage in class GeocodingService
      Parameters:
      lang - The language to use as ISO 639-1 code. Empty string can be used for default language.

    • getMaxResults

      public int getMaxResults()
      Description copied from class: GeocodingService
      Returns the maximum number of results the geocoding service returns.
      Overrides:
      getMaxResults in class GeocodingService
      Returns:
      The maximum number of results the geocoding service returns.

    • setMaxResults

      public void setMaxResults(int maxResults)
      Description copied from class: GeocodingService
      Sets the maximum number of results the geocoding service returns.
      The default number of results is service dependant (normally 10).
      Overrides:
      setMaxResults in class GeocodingService
      Parameters:
      maxResults - The new maximum number of results the geocoding service returns.

    • calculateAddresses

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