com.bericotech.clavin.gazetteer.query

Interface Gazetteer

All Known Implementing Classes:

LuceneGazetteer

public interface Gazetteer

A Gazetteer provides lookup methods for retrieving details about known places found in the indexed Gazetteer data.

Method Summary

Methods

Modifier and Type	Method and Description
List<ResolvedLocation>	getClosestLocations(GazetteerQuery query) Execute a query against the gazetteer using the provided configuration, returning the top matches as ResolvedLocations.
GeoName	getGeoName(int geonameId) Retrieves the GeoName with the provided ID.

Method Detail

getClosestLocations

List<ResolvedLocation> getClosestLocations(GazetteerQuery query)
                                           throws ClavinException

Execute a query against the gazetteer using the provided configuration, returning the top matches as ResolvedLocations.

Parameters:

query - the configuration parameters for the query

Returns:

the list of ResolvedLocations as potential matches

Throws:

ClavinException - if an error occurs

getGeoName

GeoName getGeoName(int geonameId)
                   throws ClavinException

Retrieves the GeoName with the provided ID.

Parameters:

geonameId - the ID of the requested GeoName

Returns:

the requested GeoName or null if not found

Throws:

ClavinException - if an error occurs