com.bericotech.clavin.resolver

Class ClavinLocationResolver

java.lang.Object

com.bericotech.clavin.resolver.ClavinLocationResolver

public class ClavinLocationResolver
extends Object

Resolves location names into GeoName objects. Takes location names extracted from unstructured text documents by LocationExtractor and resolves them into the appropriate geographic entities (as intended by the document's author based on context) by finding the best match in a gazetteer.

Field Summary

Fields

Modifier and Type	Field and Description
static AncestryMode	DEFAULT_ANCESTRY_MODE The default ancestry loading mode.
static int	DEFAULT_MAX_CONTEXT_WINDOW The default context window to consider when resolving matches.
static int	DEFAULT_MAX_HIT_DEPTH The default number of candidate matches to consider.

Constructor Summary

Constructors

Constructor and Description
ClavinLocationResolver(Gazetteer gazetteer) Create a new ClavinLocationResolver.

Method Summary

Modifier and Type	Method and Description
Gazetteer	getGazetteer() Get the Gazetteer used by this resolver.
static boolean	isDemonym(LocationOccurrence extractedLocation) Various named entity recognizers tend to mistakenly extract demonyms (i.e., names for residents of localities (e.g., American, British)) as place names, which tends to gum up the works for the resolver, so this method filters them out from the list of LocationOccurrences passed to the resolver.
List<ResolvedLocation>	resolveLocations(List<LocationOccurrence> locations, boolean fuzzy) Resolves the supplied list of location names into ResolvedLocations containing GeoName objects using the defaults for maxHitDepth and maxContentWindow.
List<ResolvedLocation>	resolveLocations(List<LocationOccurrence> locations, int maxHitDepth, int maxContextWindow, boolean fuzzy) Resolves the supplied list of location names into ResolvedLocations containing GeoName objects.
List<ResolvedLocation>	resolveLocations(List<LocationOccurrence> locations, int maxHitDepth, int maxContextWindow, boolean fuzzy, AncestryMode ancestryMode) Resolves the supplied list of location names into ResolvedLocations containing GeoName objects.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_HIT_DEPTH

public static final int DEFAULT_MAX_HIT_DEPTH

The default number of candidate matches to consider.

See Also:

Constant Field Values

DEFAULT_MAX_CONTEXT_WINDOW

public static final int DEFAULT_MAX_CONTEXT_WINDOW

The default context window to consider when resolving matches.

See Also:

Constant Field Values

DEFAULT_ANCESTRY_MODE

public static final AncestryMode DEFAULT_ANCESTRY_MODE

The default ancestry loading mode.

Constructor Detail

ClavinLocationResolver

public ClavinLocationResolver(Gazetteer gazetteer)

Create a new ClavinLocationResolver.

Parameters:

gazetteer - the Gazetteer to query

Method Detail

getGazetteer

public Gazetteer getGazetteer()

Get the Gazetteer used by this resolver.

Returns:

the configured gazetteer

resolveLocations

public List<ResolvedLocation> resolveLocations(List<LocationOccurrence> locations,
                                               boolean fuzzy)
                                        throws ClavinException

Resolves the supplied list of location names into ResolvedLocations containing GeoName objects using the defaults for maxHitDepth and maxContentWindow. Calls Gazetteer.getClosestLocations(com.bericotech.clavin.gazetteer.query.GazetteerQuery) on each location name to find all possible matches, then uses heuristics to select the best match for each by calling pickBestCandidates(java.util.List<java.util.List<com.bericotech.clavin.resolver.ResolvedLocation>>).

Parameters:

locations - list of location names to be resolved

fuzzy - switch for turning on/off fuzzy matching

Returns:

list of ResolvedLocation objects

Throws:

ClavinException - if an error occurs parsing the search terms

resolveLocations

public List<ResolvedLocation> resolveLocations(List<LocationOccurrence> locations,
                                               int maxHitDepth,
                                               int maxContextWindow,
                                               boolean fuzzy)
                                        throws ClavinException

Resolves the supplied list of location names into ResolvedLocations containing GeoName objects. Calls Gazetteer.getClosestLocations(com.bericotech.clavin.gazetteer.query.GazetteerQuery) on each location name to find all possible matches, then uses heuristics to select the best match for each by calling pickBestCandidates(java.util.List<java.util.List<com.bericotech.clavin.resolver.ResolvedLocation>>).

Parameters:

locations - list of location names to be resolved

maxHitDepth - number of candidate matches to consider

maxContextWindow - how much context to consider when resolving

fuzzy - switch for turning on/off fuzzy matching

Returns:

list of ResolvedLocation objects

Throws:

ClavinException - if an error occurs parsing the search terms

resolveLocations

public List<ResolvedLocation> resolveLocations(List<LocationOccurrence> locations,
                                               int maxHitDepth,
                                               int maxContextWindow,
                                               boolean fuzzy,
                                               AncestryMode ancestryMode)
                                        throws ClavinException

Resolves the supplied list of location names into ResolvedLocations containing GeoName objects. Calls Gazetteer.getClosestLocations(com.bericotech.clavin.gazetteer.query.GazetteerQuery) on each location name to find all possible matches, then uses heuristics to select the best match for each by calling pickBestCandidates(java.util.List<java.util.List<com.bericotech.clavin.resolver.ResolvedLocation>>).

Parameters:

locations - list of location names to be resolved

maxHitDepth - number of candidate matches to consider

maxContextWindow - how much context to consider when resolving

fuzzy - switch for turning on/off fuzzy matching

ancestryMode - the ancestry loading mode

Returns:

list of ResolvedLocation objects

Throws:

ClavinException - if an error occurs parsing the search terms

isDemonym

public static boolean isDemonym(LocationOccurrence extractedLocation)

Various named entity recognizers tend to mistakenly extract demonyms (i.e., names for residents of localities (e.g., American, British)) as place names, which tends to gum up the works for the resolver, so this method filters them out from the list of LocationOccurrences passed to the resolver.

Parameters:

extractedLocation - extraction location name to filter

Returns:

true if input is a demonym, false otherwise