com.bericotech.clavin.resolver

Class ResolvedLocation

java.lang.Object

com.bericotech.clavin.resolver.ResolvedLocation

public class ResolvedLocation
extends Object

Object produced by resolving a location name against gazetteer records. Encapsulates a GeoName object representing the best match between a given location name and gazetter record, along with some information about the geographic entity resolution process.

Constructor Summary

Constructors

Constructor and Description
ResolvedLocation(LocationOccurrence location, GeoName geoname, String matchedName, boolean fuzzy) Builds a ResolvedLocation from a document retrieved from the Lucene index representing the geographic entity resolved from a location name.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
float	getConfidence() Get the confidence score for resolution.
GeoName	getGeoname() Get the geographic entity resolved from the location name.
LocationOccurrence	getLocation() Get the original location name extracted from the text.
String	getMatchedName() Get the name from the gazetteer record that the inputName was matched against.
int	hashCode()
boolean	isFuzzy() Was fuzzy matching used?
String	toString() For pretty-printing.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ResolvedLocation

public ResolvedLocation(LocationOccurrence location,
                GeoName geoname,
                String matchedName,
                boolean fuzzy)

Builds a ResolvedLocation from a document retrieved from the Lucene index representing the geographic entity resolved from a location name.

Parameters:

location - the original location occurrence

geoname - the matched gazetteer record

matchedName - the name that was matched by the search engine

fuzzy - was this a fuzzy match?

Method Detail

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

For pretty-printing.

Overrides:

toString in class Object

getGeoname

public GeoName getGeoname()

Get the geographic entity resolved from the location name.

Returns:

the geographic entity

getLocation

public LocationOccurrence getLocation()

Get the original location name extracted from the text.

Returns:

the original occurrence of the location name

getMatchedName

public String getMatchedName()

Get the name from the gazetteer record that the inputName was matched against.

Returns:

the matched name

isFuzzy

public boolean isFuzzy()

Was fuzzy matching used?

Returns:

true if fuzzy matching was used

getConfidence

public float getConfidence()

Get the confidence score for resolution.

Returns:

the confidence score