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

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, lazily loading its ancestry.
GeoName	getGeoName(int geonameId, AncestryMode ancestryMode) Retrieves the GeoName with the provided ID, resolving ancestry according to the provided method.
void	loadAncestry(Collection<GeoName> geoNames) Retrieve the full ancestry for the provided GeoNames.
void	loadAncestry(GeoName... geoNames) Retrieve the full ancestry for the provided GeoNames.

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, lazily loading its ancestry.

Parameters:

geonameId - the ID of the requested GeoName

Returns:

the requested GeoName or null if not found

Throws:

ClavinException - if an error occurs

getGeoName

GeoName getGeoName(int geonameId,
                   AncestryMode ancestryMode)
            throws ClavinException

Retrieves the GeoName with the provided ID, resolving ancestry according to the provided method.

Parameters:

geonameId - the ID of the requested GeoName

ancestryMode - the mode used to load ancestry for the GeoName

Returns:

the requested GeoName or null if not found

Throws:

ClavinException - if an error occurs

loadAncestry

void loadAncestry(GeoName... geoNames)
           throws ClavinException

Retrieve the full ancestry for the provided GeoNames.

Parameters:

geoNames - the GeoNames whose ancestry will be loaded

Throws:

ClavinException - if an error occurs

loadAncestry

void loadAncestry(Collection<GeoName> geoNames)
           throws ClavinException

Retrieve the full ancestry for the provided GeoNames.

Parameters:

geoNames - the GeoNames whose ancestry will be loaded

Throws:

ClavinException - if an error occurs