org.codice.ddf.spatial.geocoder.geonames

Class GeoNamesWebService

java.lang.Object

org.codice.ddf.spatial.geocoder.geonames.GeoNamesWebService

All Implemented Interfaces:

GeoEntryQueryable

public class GeoNamesWebService
extends Object
implements GeoEntryQueryable

Constructor Summary

Constructors

Constructor and Description
GeoNamesWebService()

Method Summary

Modifier and Type	Method and Description
Optional<String>	getCountryCode(String locationWkt, int radius) Retrieves the country code for the the area defined by wktLocation in a distance of up to radius from the coordinate searched.
List<NearbyLocation>	getNearestCities(String locationWkt, int radiusInKm, int maxResults) Retrieves the cities within radiusInKm kilometers of metacard, sorted by population in descending order.
List<GeoEntry>	query(String queryString, int maxResults) Retrieves the top results for the given query up to maxResults results.

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoNamesWebService

public GeoNamesWebService()

Method Detail

query

public List<GeoEntry> query(String queryString,
                            int maxResults)
                     throws GeoEntryQueryException

Description copied from interface: GeoEntryQueryable

Retrieves the top results for the given query up to maxResults results.

Specified by:

query in interface GeoEntryQueryable

Parameters:

queryString - a String containing search terms

maxResults - the maximum number of results to return

Returns:

the top results for the query in descending order of relevance, or an empty List if no results are found

Throws:

GeoEntryQueryException - if an exception occurs while querying the GeoNames resource

getNearestCities

public List<NearbyLocation> getNearestCities(String locationWkt,
                                             int radiusInKm,
                                             int maxResults)
                                      throws ParseException,
                                             GeoEntryQueryException

Description copied from interface: GeoEntryQueryable

Retrieves the cities within radiusInKm kilometers of metacard, sorted by population in descending order.

Each result is returned as a NearbyLocation, which describes the position of metacard relative to the city.

Specified by:

getNearestCities in interface GeoEntryQueryable

Parameters:

locationWkt - a WKT identifying the area to search

radiusInKm - the search radius, in kilometers

maxResults - the maximum number of results to return

Returns:

the position of metacard relative to each of the nearest cities along with the cities' names, sorted in descending order of population

Throws:

ParseException - if an exceptions occurs while parsing location

GeoEntryQueryException - if an exception occurs while querying the GeoNames resource

getCountryCode

public Optional<String> getCountryCode(String locationWkt,
                                       int radius)

Description copied from interface: GeoEntryQueryable

Retrieves the country code for the the area defined by wktLocation in a distance of up to radius from the coordinate searched.

Specified by:

getCountryCode in interface GeoEntryQueryable

Parameters:

locationWkt - A WKT location

radius - the radius in kilometers to search from the given wktLocation

Returns:

a country code in ISO 3166-1 alpha-2 format or null if not found (for example, a location in the ocean)