org.apache.stanbol.enhancer.engines.geonames.impl

Class LocationEnhancementEngine

java.lang.Object

org.apache.stanbol.enhancer.servicesapi.impl.AbstractEnhancementEngine<IOException,RuntimeException>

org.apache.stanbol.enhancer.engines.geonames.impl.LocationEnhancementEngine

All Implemented Interfaces:

org.apache.stanbol.enhancer.servicesapi.EnhancementEngine, org.apache.stanbol.enhancer.servicesapi.ServiceProperties

@Service
 @Property(name="stanbol.enhancer.engine.name",value="geonames") @Property(name="service.ranking",intValue=-100)
public class LocationEnhancementEngine
extends org.apache.stanbol.enhancer.servicesapi.impl.AbstractEnhancementEngine<IOException,RuntimeException>
implements org.apache.stanbol.enhancer.servicesapi.EnhancementEngine, org.apache.stanbol.enhancer.servicesapi.ServiceProperties

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.clerezza.commons.rdf.IRI	CONCEPT_GEONAMES_FEATURE
static String	DEFAULT_ENGINE_NAME
static int	DEFAULT_SERVICE_RANKING Default value for the Constants.SERVICE_RANKING used by this engine.
static Integer	defaultOrder The default value for the Execution of this Engine.
static Map<FeatureClass,Collection<org.apache.clerezza.commons.rdf.IRI>>	FEATURE_CLASS_CONCEPT_MAPPINGS This maps geonames.org feature classes to dbpedia.org ontology classes
static Map<String,Collection<org.apache.clerezza.commons.rdf.IRI>>	FEATURE_TYPE_CONCEPT_MAPPINGS
static String	GEONAMES_ANONYMOUS_SERVICE_STATE The useage of the anonymous server is deactivated by default because it is often overloaded and therefore causes randomly errors.
static String	GEONAMES_SERVER_URL
static String	GEONAMES_TOKEN
static String	GEONAMES_USERNAME
protected GeonamesAPIWrapper	geonamesService The geonames.org API wrapper used to make service requests
static String	MAX_LOCATION_ENHANCEMENTS
static String	MIN_HIERARCHY_SCORE
static String	MIN_SCORE

Fields inherited from interface org.apache.stanbol.enhancer.servicesapi.EnhancementEngine

CANNOT_ENHANCE, ENHANCE_ASYNC, ENHANCE_SYNCHRONOUS, PROPERTY_NAME

Fields inherited from interface org.apache.stanbol.enhancer.servicesapi.ServiceProperties

ENHANCEMENT_ENGINE_ORDERING, ORDERING_CONTENT_EXTRACTION, ORDERING_DEFAULT, ORDERING_EXTRACTION_ENHANCEMENT, ORDERING_NLP_CHUNK, ORDERING_NLP_LANGAUGE_DETECTION, ORDERING_NLP_LEMMATIZE, ORDERING_NLP_NER, ORDERING_NLP_POS, ORDERING_NLP_SENTENCE_DETECTION, ORDERING_NLP_TOKENIZING, ORDERING_POST_PROCESSING, ORDERING_PRE_PROCESSING

Constructor Summary

Constructors

Constructor and Description
LocationEnhancementEngine()

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext ce)
int	canEnhance(org.apache.stanbol.enhancer.servicesapi.ContentItem ci)
void	computeEnhancements(org.apache.stanbol.enhancer.servicesapi.ContentItem ci)
protected void	deactivate(org.osgi.service.component.ComponentContext ce)
protected Collection<Toponym>	getHierarchy(Toponym toponym) Returns the hierarchy for the parsed toponym.
Integer	getMaxLocationEnhancements() Getter for the maximum number of enhancements added for a single TextAnnotation.
Double	getMinHierarchyScore() Setter for the minimum value used to decide based on the score of locations returned by the geonames.org web service if also the hierarchy of that point should be added as enhancements to the analysed content item.
Double	getMinScore() Getter for the minimum score used to decide if results of geoname.org search results are added as EntityEnhancements to the ContentItem
Map<String,Object>	getServiceProperties()
void	setMaxLocationEnhancements(Integer maxNumber) Setter for the maximum number of enhancements added for a single TextAnnotation.
void	setMinHierarchyScore(Double minHierarchyScore) Setter for the minimum value used to decide based on the score of locations returned by the geonames.org web service if also the hierarchy of that point should be added as enhancements to the analysed content item.
void	setMinScore(Double minScore) Setter for the minimum score used to decide if results of geoname.org search results are added as EntityEnhancements to the ContentItem.

Methods inherited from class org.apache.stanbol.enhancer.servicesapi.impl.AbstractEnhancementEngine

getName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.stanbol.enhancer.servicesapi.EnhancementEngine

getName

Field Detail

DEFAULT_ENGINE_NAME

public static final String DEFAULT_ENGINE_NAME

See Also:

Constant Field Values

DEFAULT_SERVICE_RANKING

public static final int DEFAULT_SERVICE_RANKING

Default value for the Constants.SERVICE_RANKING used by this engine. This is a negative value to allow easy replacement by this engine depending to a remote service with one that does not have this requirement

See Also:

Constant Field Values

defaultOrder

public static final Integer defaultOrder

The default value for the Execution of this Engine. Currently set to ServiceProperties.ORDERING_EXTRACTION_ENHANCEMENT

FEATURE_CLASS_CONCEPT_MAPPINGS

public static final Map<FeatureClass,Collection<org.apache.clerezza.commons.rdf.IRI>> FEATURE_CLASS_CONCEPT_MAPPINGS

This maps geonames.org feature classes to dbpedia.org ontology classes

FEATURE_TYPE_CONCEPT_MAPPINGS

public static final Map<String,Collection<org.apache.clerezza.commons.rdf.IRI>> FEATURE_TYPE_CONCEPT_MAPPINGS

MIN_SCORE

@Property(doubleValue=0.33)
public static final String MIN_SCORE

See Also:

Constant Field Values

MAX_LOCATION_ENHANCEMENTS

@Property(intValue=3)
public static final String MAX_LOCATION_ENHANCEMENTS

See Also:

Constant Field Values

MIN_HIERARCHY_SCORE

@Property(doubleValue=0.7)
public static final String MIN_HIERARCHY_SCORE

See Also:

Constant Field Values

CONCEPT_GEONAMES_FEATURE

public static final org.apache.clerezza.commons.rdf.IRI CONCEPT_GEONAMES_FEATURE

GEONAMES_SERVER_URL

@Property(value="http://api.geonames.org/")
public static final String GEONAMES_SERVER_URL

See Also:

Constant Field Values

GEONAMES_ANONYMOUS_SERVICE_STATE

@Property(boolValue=false)
public static final String GEONAMES_ANONYMOUS_SERVICE_STATE

The useage of the anonymous server is deactivated by default because it is often overloaded and therefore causes randomly errors.

See Also:

Constant Field Values

GEONAMES_USERNAME

@Property
public static final String GEONAMES_USERNAME

See Also:

Constant Field Values

GEONAMES_TOKEN

@Property
public static final String GEONAMES_TOKEN

See Also:

Constant Field Values

geonamesService

protected GeonamesAPIWrapper geonamesService

The geonames.org API wrapper used to make service requests

Constructor Detail

LocationEnhancementEngine

public LocationEnhancementEngine()

Method Detail

activate

protected void activate(org.osgi.service.component.ComponentContext ce)
                 throws IOException,
                        org.osgi.service.cm.ConfigurationException

Overrides:

activate in class org.apache.stanbol.enhancer.servicesapi.impl.AbstractEnhancementEngine<IOException,RuntimeException>

Throws:

IOException

org.osgi.service.cm.ConfigurationException

deactivate

protected void deactivate(org.osgi.service.component.ComponentContext ce)

Overrides:

deactivate in class org.apache.stanbol.enhancer.servicesapi.impl.AbstractEnhancementEngine<IOException,RuntimeException>

canEnhance

public int canEnhance(org.apache.stanbol.enhancer.servicesapi.ContentItem ci)
               throws org.apache.stanbol.enhancer.servicesapi.EngineException

Specified by:

canEnhance in interface org.apache.stanbol.enhancer.servicesapi.EnhancementEngine

Throws:

org.apache.stanbol.enhancer.servicesapi.EngineException

computeEnhancements

public void computeEnhancements(org.apache.stanbol.enhancer.servicesapi.ContentItem ci)
                         throws org.apache.stanbol.enhancer.servicesapi.EngineException

Specified by:

computeEnhancements in interface org.apache.stanbol.enhancer.servicesapi.EnhancementEngine

Throws:

org.apache.stanbol.enhancer.servicesapi.EngineException

getHierarchy

protected Collection<Toponym> getHierarchy(Toponym toponym)
                                    throws Exception

Returns the hierarchy for the parsed toponym. The planet Earth will be at the first position of the list and the parsed toponum represents the last element of the list.

Parameters:

toponym - the toponym

Returns:

The list containing the hierarchy

Throws:

Exception - on any error while accessing the webservice

getMaxLocationEnhancements

public final Integer getMaxLocationEnhancements()

Getter for the maximum number of enhancements added for a single TextAnnotation.

Returns:

The maximum number of location enhancements added for a single text annotation

setMaxLocationEnhancements

public final void setMaxLocationEnhancements(Integer maxNumber)

Setter for the maximum number of enhancements added for a single TextAnnotation. If the parsed value is null or < 1, than the value is set to DEFAULT_MAX_LOCATION_ENHANCEMENTS.

Parameters:

maxNumber - the maximum number of enhancements added to a singel text annotation

getServiceProperties

public Map<String,Object> getServiceProperties()

Specified by:

getServiceProperties in interface org.apache.stanbol.enhancer.servicesapi.ServiceProperties

setMinScore

public void setMinScore(Double minScore)

Setter for the minimum score used to decide if results of geoname.org search results are added as EntityEnhancements to the ContentItem. If null is parsed the value is set to DEFAULT_MIN_SCORE. For values > 1 the value is set to 1 and for values < 0 the value is set to 0.

Parameters:

minScore - the minScore to set

getMinScore

public Double getMinScore()

Getter for the minimum score used to decide if results of geoname.org search results are added as EntityEnhancements to the ContentItem

Returns:

the minScore

setMinHierarchyScore

public void setMinHierarchyScore(Double minHierarchyScore)

Setter for the minimum value used to decide based on the score of locations returned by the geonames.org web service if also the hierarchy of that point should be added as enhancements to the analysed content item.
If null is parsed the value is set to DEFAULT_MIN_HIERARCHY_SCORE. For values > 1 the value is set to 1 and for values < 0 the value is set to 0.

Parameters:

minHierarchyScore - the minHierarchyScore to set

getMinHierarchyScore

public Double getMinHierarchyScore()

Setter for the minimum value used to decide based on the score of locations returned by the geonames.org web service if also the hierarchy of that point should be added as enhancements to the analysed content item.

Returns:

the minHierarchyScore