prajna.structure.geo

Class GeoNamesAugmenter

java.lang.Object

prajna.ontology.SemanticAugmenter

prajna.structure.geo.GeoNamesAugmenter

All Implemented Interfaces:

EntityVerifier

public class GeoNamesAugmenter
extends SemanticAugmenter
implements EntityVerifier

Uses GeoNames to augment the semantic information. The GeoNamesAugmenter may use either a local copy of a GeoNames file or the web service to find location information.

Author:

Edward Swing

Constructor Summary

Constructors

Constructor and Description
GeoNamesAugmenter() Create a new GeoNamesReader.
GeoNamesAugmenter(java.lang.String filePath) Create a new GeoNamesReader.

Method Summary

Methods

Modifier and Type	Method and Description
EntityType	determineType(java.lang.String term) Determine the type of an entity.
java.lang.String	getModel() Get the model string for this verifier.
protected java.util.Set<java.lang.String>	getNewValues(OwlThing thing, Property prop) Find the new values for the OwlThing.
protected java.util.Set<java.lang.String>	getRefineValues(OwlThing thing) Get any possible values used to refine the class of the OwlThing passed in.
java.util.Set<EntityType>	getSupportedTypes() Get the supported types for this verifier.
java.lang.String	normalize(java.lang.String term, EntityType type) Normalize the name.
void	setConfig(java.lang.String cfg) Set the configuration information.
void	setModel(java.lang.String cfg) Set the model information.
java.lang.String	toString() Return a string representation of this reader
boolean	verifyType(java.lang.String term, EntityType type) Verify the entity type.

Methods inherited from class prajna.ontology.SemanticAugmenter

addProperties, addProperty, augment, getConfig, getOwlClass, getProperties, isOverwrite, isRefine, setOverwrite, setOwlClass, setRefine

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoNamesAugmenter

public GeoNamesAugmenter()

Create a new GeoNamesReader. The file to read must be set with the setModel method.

GeoNamesAugmenter

public GeoNamesAugmenter(java.lang.String filePath)

Create a new GeoNamesReader.

Parameters:

filePath - the path to the geonames file

Method Detail

determineType

public EntityType determineType(java.lang.String term)

Determine the type of an entity. This class only recognizes Location entities.

Specified by:

determineType in interface EntityVerifier

Parameters:

term - the term to check.

Returns:

the entity type.

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

getNewValues

protected java.util.Set<java.lang.String> getNewValues(OwlThing thing,
                                           Property prop)

Find the new values for the OwlThing. This method tries to match the desired property to the available geographic information. It then loads the geographic record and returns the values for the property

Specified by:

getNewValues in class SemanticAugmenter

Parameters:

thing - the OwlThing to augment

prop - the property to get values for

Returns:

the value for that thing, based on the geographic locator

getRefineValues

protected java.util.Set<java.lang.String> getRefineValues(OwlThing thing)

Get any possible values used to refine the class of the OwlThing passed in. For the GeoAugmenter, this returns the geographic feature type as the only element of the set.

Specified by:

getRefineValues in class SemanticAugmenter

Parameters:

thing - the thing to find the possible refinements for

Returns:

the set of possible refinement values for the OwlThing

getSupportedTypes

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

Get the supported types for this verifier. The GeoNamesReader 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,
                         EntityType type)

Normalize the name. If the entity name is in the geographic file, this determines a standard name for the entity.

Specified by:

normalize in interface EntityVerifier

Parameters:

term - the location name

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

Returns:

the normalized name

setConfig

public void setConfig(java.lang.String cfg)

Set the configuration information. The configuration information should be the path to the geonames file

Overrides:

setConfig in class SemanticAugmenter

Parameters:

cfg - the configuration, or the path to the geonames file

setModel

public void setModel(java.lang.String cfg)

Set the model information. The model should be the path to the geonames file

Specified by:

setModel in interface EntityVerifier

Parameters:

cfg - the configuration, or the path to the geonames file

toString

public java.lang.String toString()

Return a string representation of this reader

Overrides:

toString in class SemanticAugmenter

Returns:

a string representation of this reader

verifyType

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

Verify the entity type. This method verifies if a particular entity is a Location entity by checking if it exists in the geonames file.

Specified by:

verifyType in interface EntityVerifier

Parameters:

term - the term

type - the type. This implementation only recognizes EntityType.LOCATION

Returns:

if the term is a location in the geonames file