Package slash.navigation.geocoding

Interface GeocodingService

All Known Implementing Classes:

AutomaticGeocodingService, BaseGeocodingService, GeoNamesService, GoogleGeocodingService, MapsforgeMapGeocodingService, MapsforgePoiGeocodingService, NominatimService, PhotonService

public interface GeocodingService

Interface for a service that translates addresses into geographic coordinates and a geographic coordinate to an address.

Author:

Christian Pesch

Method Summary

Modifier and Type	Method	Description
String	getAddressFor(NavigationPosition position)	Retrieves an address for a given NavigationPosition.
String	getName()
List<GeocodingResult>	getPositionsFor(String address)	Retrieves a list of GeocodingResults for a given address.
boolean	isDownload()
boolean	isOverQueryLimit()

Method Details

getName

String getName()

isDownload

boolean isDownload()

isOverQueryLimit

boolean isOverQueryLimit()

getPositionsFor

List<GeocodingResult> getPositionsFor(String address)
                               throws IOException,
ServiceUnavailableException

Retrieves a list of GeocodingResults for a given address.

Parameters:

address - the address to geocode

Returns:

a list of GeocodingResults for the given address

Throws:

ServiceUnavailableException - if the service is overloaded

IOException - if the request fails

getAddressFor

String getAddressFor(NavigationPosition position)
              throws IOException,
ServiceUnavailableException

Retrieves an address for a given NavigationPosition.

Parameters:

position - the NavigationPosition to reverse geocode the address

Returns:

an address for the given NavigationPosition

Throws:

ServiceUnavailableException - if the service is overloaded

IOException - if the request fails