com.bericotech.clavin.resolver.multipart

Class MultipartLocationResolver

java.lang.Object

com.bericotech.clavin.resolver.multipart.MultipartLocationResolver

public class MultipartLocationResolver
extends Object

Resolves multipart location names from structured data into GeoName objects. Takes multipart location names, such as what's often found in structured data like a spreadsheet or database table (e.g., [Reston][Virginia][United States]), and resolves them into the appropriate geographic entities by identifying the most logical match in a gazetteer, trying to enforce some kind of notional hierarchy of place names (e.g., city --> state/province/etc. --> country).

Constructor Summary

Constructors

Constructor and Description
MultipartLocationResolver(Gazetteer gaz)

Method Summary

Methods

Modifier and Type	Method and Description
ResolvedLocation	resolveLocation(boolean fuzzy, String... locationParts) Resolves a location provided as a series of political divisions from narrowest to broadest.
ResolvedLocation	resolveLocation(String loc, boolean fuzzy) Attempts to resolve a location provided as a comma-separated string of political divisions from narrowest to broadest.
ResolvedMultipartLocation	resolveMultipartLocation(MultipartLocationName location, boolean fuzzy) Resolves a multipart location name, such as what's often found in structured data like a spreadsheet or database table (e.g., [Reston][Virginia][United States]), into a ResolvedMultipartLocation containing GeoName objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultipartLocationResolver

public MultipartLocationResolver(Gazetteer gaz)

Method Detail

resolveMultipartLocation

public ResolvedMultipartLocation resolveMultipartLocation(MultipartLocationName location,
                                                 boolean fuzzy)
                                                   throws ClavinException

Resolves a multipart location name, such as what's often found in structured data like a spreadsheet or database table (e.g., [Reston][Virginia][United States]), into a ResolvedMultipartLocation containing GeoName objects.

Parameters:

location - multipart location name to be resolved

fuzzy - switch for turning on/off fuzzy matching

Returns:

resolved multipart location name

Throws:

ClavinException - if an error occurs while resolving locations

resolveLocation

public ResolvedLocation resolveLocation(String loc,
                               boolean fuzzy)
                                 throws ClavinException

Attempts to resolve a location provided as a comma-separated string of political divisions from narrowest to broadest. The gazetteer current supports ancestry from the country level through four administrative divisions so any more-specific divisions will be ignored once a city (lowest available level of resolution) is found. Results will only be returned if all unignored location components are matched.

Parameters:

loc - the comma-separated location name (e.g. "City, County, State, Country")

fuzzy - true to use fuzzy matching if an exact match for any location could not be found

Returns:

the resolved location

Throws:

ClavinException - if an error occurs while searching

resolveLocation

public ResolvedLocation resolveLocation(boolean fuzzy,
                               String... locationParts)
                                 throws ClavinException

Resolves a location provided as a series of political divisions from narrowest to broadest. The gazetteer current supports ancestry from the country level through four administrative divisions so any more-specific divisions will be ignored once a city (lowest available level of resolution) is found. Results will only be returned if all unignored location components are matched.

Parameters:

fuzzy - true to use fuzzy matching if an exact match for any location could not be found

locationParts - the names of the locations to match, ordered from most to least specific (e.g. [ "City", "County", "State", "Country" ])

Returns:

the resolved location

Throws:

ClavinException - if an error occurs while searching