org.codice.ddf.catalog.ui.query.geofeature

Class GazetteerFeatureService

java.lang.Object

org.codice.ddf.catalog.ui.query.geofeature.GazetteerFeatureService

All Implemented Interfaces:

FeatureService

public class GazetteerFeatureService
extends Object
implements FeatureService

Implements a FeatureService using gazetteer(s). Currently the only gazetteer is provided by the GeoEntryQueryable interface, which queries geonames.org data. It is intended that more will be added and the results federated.

Constructor Summary

Constructors

Constructor and Description
GazetteerFeatureService()

Method Summary

Modifier and Type	Method and Description
Feature	getFeatureByName(String name) Retrieves a specific geographic feature by its exact name (as returned by getSuggestedFeatureNames).
protected GeoResult	getGeoResultFromGeoEntry(GeoEntry entry)
List<String>	getSuggestedFeatureNames(String query, int maxResults) Searches for geographic features by name, returning the names of the closest n matches.
void	setGeoEntryQueryable(GeoEntryQueryable geoEntryQueryable)

Methods inherited from class java.lang.Object

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

Constructor Detail

GazetteerFeatureService

public GazetteerFeatureService()

Method Detail

setGeoEntryQueryable

public void setGeoEntryQueryable(GeoEntryQueryable geoEntryQueryable)

getSuggestedFeatureNames

public List<String> getSuggestedFeatureNames(String query,
                                             int maxResults)

Description copied from interface: FeatureService

Searches for geographic features by name, returning the names of the closest n matches. Intended for use by an autocomplete widget.

Specified by:

getSuggestedFeatureNames in interface FeatureService

Parameters:

query - search term

maxResults - maximum number of results to return

Returns:

list of names found

getFeatureByName

public Feature getFeatureByName(String name)

Description copied from interface: FeatureService

Retrieves a specific geographic feature by its exact name (as returned by getSuggestedFeatureNames).

Specified by:

getFeatureByName in interface FeatureService

Parameters:

name - name of a geographic feature

Returns:

the feature if found, otherwise null

getGeoResultFromGeoEntry

protected GeoResult getGeoResultFromGeoEntry(GeoEntry entry)