fr.dudie.nominatim.client

Interface NominatimClient

All Known Implementing Classes:

JsonNominatimClient

public interface NominatimClient

Interface to use the Nominatim Service.

Since:

1.0

Author:

Jérémie Huchet, Sunil D S

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(NominatimReverseRequest reverse) Reverse geocoding request.
Address	getAddress(String type, long id) Deprecated.
List<Address>	lookupAddress(List<String> typeId) This method can be used to lookup addresses with an OSM type and ID
List<Address>	lookupAddress(NominatimLookupRequest lookup) Address lookup request.
List<Address>	search(NominatimSearchRequest search) Search for addresses.
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.

See also search(NominatimSearchRequest) to obtain more result details.

Parameters:

query - the query

Returns:

a list of results

Throws:

IOException - a communication error occurred

Since:

1.0

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

Since:

1.0

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

Since:

2.0.1

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

Since:

1.0

getAddress

@Deprecated
Address getAddress(String type,
                            long id)
                   throws IOException

Deprecated.

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

Since:

2.0.1

See Also:

fr.dudie.nominatim.client.NominatimClientV3#getAddress(fr.dudie.nominatim.client.request.NominatimReverseRequest)

lookupAddress

List<Address> lookupAddress(List<String> typeId)
                            throws IOException

This method can be used to lookup addresses with an OSM type and ID

Parameters:

typeId - [N|W|R]ID

Returns:

a list of addresses corresponding to the given OSM type and ID or null if no result found

Throws:

IOException - a communication error occurred

Since:

3.2

search

List<Address> search(NominatimSearchRequest search)
                     throws IOException

Search for addresses.

Parameters:

search - the search request parameters

Returns:

a list of results

Throws:

IOException - a communication error occurred

Since:

3.0

getAddress

Address getAddress(NominatimReverseRequest reverse)
                   throws IOException

Reverse geocoding request.

Parameters:

reverse - a reverse geocoding request

Returns:

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

Throws:

IOException - a communication error occurred

Since:

3.0

lookupAddress

List<Address> lookupAddress(NominatimLookupRequest lookup)
                            throws IOException

Address lookup request.

Parameters:

lookup - a lookup request

Returns:

a list of addresses corresponding to the given OSM type and ID or null if no result found

Throws:

IOException - a communication error occurred

Since:

3.2