fr.dudie.nominatim.client

Class JsonNominatimClient

java.lang.Object

fr.dudie.nominatim.client.JsonNominatimClient

All Implemented Interfaces:

NominatimClient

public final class JsonNominatimClient
extends Object
implements NominatimClient

An implementation of the Nominatim Api Service.

Author:

Jérémie Huchet, Sunil D S

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENCODING_UTF_8 UTF-8 encoding.

Constructor Summary

Constructors

Constructor and Description
JsonNominatimClient(org.apache.http.client.HttpClient httpClient, String email) Creates the json nominatim client with the default base URL (.
JsonNominatimClient(org.apache.http.client.HttpClient httpClient, String email, NominatimOptions defaults) Creates the json nominatim client with the default base URL (.
JsonNominatimClient(String baseUrl, org.apache.http.client.HttpClient httpClient, String email) Creates the json nominatim client.
JsonNominatimClient(String baseUrl, org.apache.http.client.HttpClient httpClient, String email, NominatimOptions defaults) Creates the json nominatim client.

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 NominatimClient.getAddress(double, double) but with int E6 latitude and longitude.
Address	getAddress(NominatimReverseRequest reverse) Reverse geocoding request.
Address	getAddress(String type, long id) Reverse geocode the given OSM id.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENCODING_UTF_8

public static final String ENCODING_UTF_8

UTF-8 encoding.

See Also:

Constant Field Values

Constructor Detail

JsonNominatimClient

public JsonNominatimClient(org.apache.http.client.HttpClient httpClient,
                   String email)

Creates the json nominatim client with the default base URL (.

Parameters:

httpClient - an HTTP client

email - an email to add in the HTTP requests parameters to "sign" them

JsonNominatimClient

public JsonNominatimClient(org.apache.http.client.HttpClient httpClient,
                   String email,
                   NominatimOptions defaults)

Creates the json nominatim client with the default base URL (.

Parameters:

httpClient - an HTTP client

email - an email to add in the HTTP requests parameters to "sign" them

defaults - defaults options, they override null valued requests options

JsonNominatimClient

public JsonNominatimClient(String baseUrl,
                   org.apache.http.client.HttpClient httpClient,
                   String email)

Creates the json nominatim client.

Parameters:

baseUrl - the nominatim server url

httpClient - an HTTP client

email - an email to add in the HTTP requests parameters to "sign" them (see http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy)

JsonNominatimClient

public JsonNominatimClient(String baseUrl,
                   org.apache.http.client.HttpClient httpClient,
                   String email,
                   NominatimOptions defaults)

Creates the json nominatim client.

Parameters:

baseUrl - the nominatim server url

httpClient - an HTTP client

email - an email to add in the HTTP requests parameters to "sign" them (see http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy)

defaults - defaults options, they override null valued requests options

Method Detail

search

public List<Address> search(NominatimSearchRequest search)
                     throws IOException

Search for addresses.

Specified by:

search in interface NominatimClient

Parameters:

search - the search request parameters

Returns:

a list of results

Throws:

IOException - a communication error occurred

See Also:

NominatimClient.search(fr.dudie.nominatim.client.request.NominatimSearchRequest)

getAddress

public Address getAddress(NominatimReverseRequest reverse)
                   throws IOException

Reverse geocoding request.

Specified by:

getAddress in interface NominatimClient

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

See Also:

NominatimClient.getAddress(fr.dudie.nominatim.client.request.NominatimReverseRequest)

lookupAddress

public List<Address> lookupAddress(NominatimLookupRequest lookup)
                            throws IOException

Address lookup request.

Specified by:

lookupAddress in interface NominatimClient

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

See Also:

NominatimClient.lookupAddress(fr.dudie.nominatim.client.request.NominatimLookupRequest)

search

public List<Address> search(String query)
                     throws IOException

Search for results with the given query.

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

Specified by:

search in interface NominatimClient

Parameters:

query - the query

Returns:

a list of results

Throws:

IOException - a communication error occurred

See Also:

NominatimClient.search(java.lang.String)

getAddress

public Address getAddress(double longitude,
                 double latitude)
                   throws IOException

Reverse geocode the given coordinates.

Specified by:

getAddress in interface NominatimClient

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

See Also:

NominatimClient.getAddress(double, double)

getAddress

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

Reverse geocode the given coordinates using a specific zoom level

Specified by:

getAddress in interface NominatimClient

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

See Also:

NominatimClient.getAddress(double, double, int)

getAddress

public Address getAddress(int longitudeE6,
                 int latitudeE6)
                   throws IOException

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

Specified by:

getAddress in interface NominatimClient

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

See Also:

NominatimClient.getAddress(int, int)

getAddress

public Address getAddress(String type,
                 long id)
                   throws IOException

Reverse geocode the given OSM id.

Specified by:

getAddress in interface NominatimClient

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

See Also:

fr.dudie.nominatim.client.NominatimClient#getAddress(String, int)

lookupAddress

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

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

Specified by:

lookupAddress in interface NominatimClient

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

See Also:

NominatimClient.lookupAddress(java.util.List)