prajna.entity

Class GeoNamesVerifier

java.lang.Object

prajna.geo.GeoLocator

prajna.geo.GeoNamesLocator

prajna.entity.GeoNamesVerifier

All Implemented Interfaces:

EntityVerifier

public class GeoNamesVerifier
extends GeoNamesLocator
implements EntityVerifier

Simple implementation of an EntityVerifier using GeoNames. This verifier only accepts Location entities, and uses a GeoNames lookup to verify if a location with that name exists.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
GeoNamesVerifier() Create a new GeoNamesVerifier

Method Summary

Methods

Modifier and Type	Method and Description
EntityType	determineType(java.lang.String term) Determine the entity type for a particular term.
java.lang.String	getModel() Get the model string for this verifier.
java.util.Set<EntityType>	getSupportedTypes() Get the supported types for this verifier.
java.lang.String	normalize(java.lang.String term) Get a normalized form for this entity.
java.lang.String	normalize(java.lang.String term, EntityType type) Get a normalized form for this entity.
void	setModel(java.lang.String model) Set the model for this verifier.
boolean	verifyType(java.lang.String term, EntityType type) Verify if the term matches the entity type.

Methods inherited from class prajna.geo.GeoNamesLocator

getCache, getCoordinate, getCountry, getFeatureType, getGeoObject, getGeoPath, getRealName, isEstimateFlag, isLoaded, isRetryFlag, loadCache, lookup, lookup, lookup, setEstimateFlag, setFeatureClass, setGeoPath, setRetryFlag

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoNamesVerifier

public GeoNamesVerifier()

Create a new GeoNamesVerifier

Method Detail

determineType

public EntityType determineType(java.lang.String term)

Determine the entity type for a particular term. This method returns either EntityType.LOCATION or null, depending on whether the term can be parsed as a geographic location or not.

Specified by:

determineType in interface EntityVerifier

Parameters:

term - the term to check. This is the extracted entity

Returns:

the entity type for the term.

getModel

public java.lang.String getModel()

Get the model string for this verifier. The model string contains the path, and the optional load flag

Specified by:

getModel in interface EntityVerifier

Returns:

the model string

getSupportedTypes

public java.util.Set<EntityType> getSupportedTypes()

Get the supported types for this verifier. The GeoNamesVerifier only supports EntityType.LOCATION types

Specified by:

getSupportedTypes in interface EntityVerifier

Returns:

a set with a single element, EntityType.LOCATION

normalize

public java.lang.String normalize(java.lang.String term)

Get a normalized form for this entity. This method ensures that any entity of a particular type will conform to a particular format, or resolve spelling differences, etc. If the term is not supported by this verifier, or if the verifier cannot normalize the term, null is returned. For the GeoNamesVerifier, the term is checked against the GeoNames database, and a normalized geographic form is returned.

Parameters:

term - the term to normalize

Returns:

a normalized string

normalize

public java.lang.String normalize(java.lang.String term,
                         EntityType type)

Get a normalized form for this entity. This method ensures that any entity of a particular type will conform to a particular format, or resolve spelling differences, etc. If the term is not supported by this verifier, or if the verifier cannot normalize the term, null is returned. For the GeoNamesVerifier, the term is checked against the GeoNames database, and a normalized geographic form is returned.

Specified by:

normalize in interface EntityVerifier

Parameters:

term - the term to normalize

type - the entity type, which should be EntityType.LOCATION

Returns:

a normalized string

setModel

public void setModel(java.lang.String model)

Set the model for this verifier. This method expects the argument to be the base URL of the GeoNames server. By default, it is http://ws.geonames.org.

Specified by:

setModel in interface EntityVerifier

Parameters:

model - the new base for the geonames URL.

verifyType

public boolean verifyType(java.lang.String term,
                 EntityType type)

Verify if the term matches the entity type. If the type is EntityType.LOCATION, and GeoNames has a valid coordinate for the term, then it is valid. Otherwise, this returns false.

Specified by:

verifyType in interface EntityVerifier

Parameters:

term - the term to check

type - the entity type

Returns:

true if the type is EntityType.LOCATION and GeoNames has a valid coordinate for the term, false otherwise.