org.codice.ddf.spatial.geocoding.query

Class GeoNamesQueryLuceneDirectoryIndex

java.lang.Object

org.codice.ddf.spatial.geocoding.query.GeoNamesQueryLuceneIndex

org.codice.ddf.spatial.geocoding.query.GeoNamesQueryLuceneDirectoryIndex

All Implemented Interfaces:

GeoEntryQueryable

public class GeoNamesQueryLuceneDirectoryIndex
extends GeoNamesQueryLuceneIndex

Constructor Summary

Constructors

Constructor and Description
GeoNamesQueryLuceneDirectoryIndex()

Method Summary

Modifier and Type	Method and Description
protected org.apache.lucene.index.IndexReader	createIndexReader(org.apache.lucene.store.Directory directory)
protected org.apache.lucene.search.IndexSearcher	createIndexSearcher(org.apache.lucene.index.IndexReader indexReader)
Optional<String>	getCountryCode(String wktLocation, 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 location, int radiusInKm, int maxResults) Retrieves the cities within radiusInKm kilometers of metacard, sorted by population in descending order.
protected org.apache.lucene.store.Directory	openDirectory()
List<GeoEntry>	query(String queryString, int maxResults) Retrieves the top results for the given query up to maxResults results.
void	setIndexLocation(String indexLocation)

Methods inherited from class org.codice.ddf.spatial.geocoding.query.GeoNamesQueryLuceneIndex

createQuery, doGetCountryCode, doGetNearestCities, doQuery, indexExists

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoNamesQueryLuceneDirectoryIndex

public GeoNamesQueryLuceneDirectoryIndex()

Method Detail

setIndexLocation

public void setIndexLocation(String indexLocation)

openDirectory

protected org.apache.lucene.store.Directory openDirectory()
                                                   throws IOException

Specified by:

openDirectory in class GeoNamesQueryLuceneIndex

Throws:

IOException

createIndexReader

protected org.apache.lucene.index.IndexReader createIndexReader(org.apache.lucene.store.Directory directory)
                                                         throws IOException

Specified by:

createIndexReader in class GeoNamesQueryLuceneIndex

Throws:

IOException

createIndexSearcher

protected org.apache.lucene.search.IndexSearcher createIndexSearcher(org.apache.lucene.index.IndexReader indexReader)

Specified by:

createIndexSearcher in class GeoNamesQueryLuceneIndex

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.

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 location,
                                             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.

Parameters:

location - 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 wktLocation,
                                       int radius)
                                throws GeoEntryQueryException,
                                       ParseException

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.

Parameters:

wktLocation - 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)

Throws:

GeoEntryQueryException

ParseException