fr.dudie.nominatim.client

Interface NominatimClient

All Known Implementing Classes:

JsonNominatimClient

public interface NominatimClient

Interface to use the Google Maps Service.

Author:

Jérémie Huchet

Method Summary

Methods

Modifier and Type	Method and Description
Address	getAddress(double longitude, double latitude) Reverse geocode the given coordinates.
Address	getAddress(double longitude, double latitude, int zoom) Reverse geocode the given coordinates using a specific zoom level
Address	getAddress(int longitudeE6, int latitudeE6) A convenience method to do the same as getAddress(double, double) but with int E6 latitude and longitude.
Address	getAddress(String type, long id) Reverse geocode the given OSM id.
List<Address>	search(String query) Search for results with the given query.

Method Detail

search

List<Address> search(String query)
                     throws IOException

Search for results with the given query.

Parameters:

query - the query

Returns:

a list of results

Throws:

IOException - a communication error occurred

getAddress

Address getAddress(double longitude,
                 double latitude)
                   throws IOException

Reverse geocode the given coordinates.

Parameters:

longitude - a longitude

latitude - a latitude

Returns:

an address corresponding to the given longitude and latitude or null if no result found

Throws:

IOException - a communication error occurred

getAddress

Address getAddress(double longitude,
                 double latitude,
                 int zoom)
                   throws IOException

Reverse geocode the given coordinates using a specific zoom level

Parameters:

longitude - a longitude

latitude - a latitude

zoom - a osm zoom level

Returns:

an address corresponding to the given longitude and latitude or null if no result found

Throws:

IOException - a communication error occurred

getAddress

Address getAddress(int longitudeE6,
                 int latitudeE6)
                   throws IOException

A convenience method to do the same as getAddress(double, double) but with int E6 latitude and longitude.

Parameters:

longitudeE6 - a longitude E6

latitudeE6 - a latitude E6

Returns:

an address corresponding to the given longitude and latitude or null if no result found

Throws:

IOException - a communication error occurred

getAddress

Address getAddress(String type,
                 long id)
                   throws IOException

Reverse geocode the given OSM id.

Parameters:

type - An OSM type [N|W|R]

id - An OSM id

Returns:

an address corresponding to the given osm type and id pair or null if no result found

Throws:

IOException