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

Constructor Summary

Constructors

Constructor and Description
JsonNominatimClient(org.apache.http.client.HttpClient httpClient, String email) Creates the json nominatim client.
JsonNominatimClient(String baseUrl, org.apache.http.client.HttpClient httpClient, String email, BoundingBox searchBounds, boolean strictBounds, boolean polygon) 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(String type, long id) Reverse geocode the given OSM id.
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

Constructor Detail

JsonNominatimClient

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

Creates the json nominatim client.

Parameters:

httpClient - an HTTP client

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

JsonNominatimClient

public JsonNominatimClient(String baseUrl,
                   org.apache.http.client.HttpClient httpClient,
                   String email,
                   BoundingBox searchBounds,
                   boolean strictBounds,
                   boolean polygon)

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)

searchBounds - the prefered search bounds

strictBounds - set to true if you want the results to be located into the given bounding box

polygon - true to get results with polygon points

Method Detail

search

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

Search for results with the given query.

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:

NominatimClient.getAddress(int, int)