com.bericotech.clavin.gazetteer.query

Class LuceneGazetteer

java.lang.Object

com.bericotech.clavin.gazetteer.query.LuceneGazetteer

All Implemented Interfaces:

Gazetteer

public class LuceneGazetteer
extends Object
implements Gazetteer

An implementation of Gazetteer that uses Lucene to rapidly search known locations.

Constructor Summary

Constructors

Constructor and Description
LuceneGazetteer(File indexDir) Builds a LuceneGazetteer by loading a pre-built Lucene index from disk and setting configuration parameters for resolving location names to GeoName objects.

Method Summary

Modifier and Type	Method and Description
List<ResolvedLocation>	getClosestLocations(GazetteerQuery query) Execute a query against the Lucene gazetteer index 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneGazetteer

public LuceneGazetteer(File indexDir)
                throws ClavinException

Builds a LuceneGazetteer by loading a pre-built Lucene index from disk and setting configuration parameters for resolving location names to GeoName objects.

Parameters:

indexDir - Lucene index directory to be loaded

Throws:

ClavinException - if an error occurs opening the index

Method Detail

getClosestLocations

public List<ResolvedLocation> getClosestLocations(GazetteerQuery query)
                                           throws ClavinException

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

Specified by:

getClosestLocations in interface Gazetteer

Parameters:

query - the configuration parameters for the query

Returns:

the list of ResolvedLocations as potential matches

Throws:

ClavinException - if an error occurs

getGeoName

public GeoName getGeoName(int geonameId)
                   throws ClavinException

Description copied from interface: Gazetteer

Retrieves the GeoName with the provided ID, lazily loading its ancestry.

Specified by:

getGeoName in interface Gazetteer

Parameters:

geonameId - the ID of the requested GeoName

Returns:

the requested GeoName or null if not found

Throws:

ClavinException - if an error occurs

getGeoName

public GeoName getGeoName(int geonameId,
                          AncestryMode ancestryMode)
                   throws ClavinException

Description copied from interface: Gazetteer

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

Specified by:

getGeoName in interface Gazetteer

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

public void loadAncestry(GeoName... geoNames)
                  throws ClavinException

Description copied from interface: Gazetteer

Retrieve the full ancestry for the provided GeoNames.

Specified by:

loadAncestry in interface Gazetteer

Parameters:

geoNames - the GeoNames whose ancestry will be loaded

Throws:

ClavinException - if an error occurs

loadAncestry

public void loadAncestry(Collection<GeoName> geoNames)
                  throws ClavinException

Description copied from interface: Gazetteer

Retrieve the full ancestry for the provided GeoNames.

Specified by:

loadAncestry in interface Gazetteer

Parameters:

geoNames - the GeoNames whose ancestry will be loaded

Throws:

ClavinException - if an error occurs