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

Class GeonamesAPIWrapper

java.lang.Object

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

public class GeonamesAPIWrapper
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeonamesAPIWrapper.HierarchyRequestPorpertyEnum
static class	GeonamesAPIWrapper.SearchRequestPropertyEnum Enumeration that contains the property definitions used by the LocationEnhancementEngine.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMOUS_GEONAMES_ORG_WEBSERVICE_URL The geonames.org web service URI allowing anonymous connections.
static String	DEFAULT_GEONAMES_ORG_WEBSERVICE_URL URI of the geonames.org web services used as default.
static String	HIERARCHY_SERVICE_PATH Relative path to the hierarchy service
protected String	hierarchyServiceUrl The access url for the hierarchy service.
static String	SEARCH_SERVICE_PATH Relative path to the search service
protected String	searchServiceUrl The access url for the search service.

Constructor Summary

Constructors

Constructor and Description
GeonamesAPIWrapper() Initialises a the geonames API wrapper as used for the free service
GeonamesAPIWrapper(String serverURL, String userName, String token) Initialise the geonames API wrapper for a given server, username and token.
GeonamesAPIWrapper(String searchService, String hierarchyService, String userName, String token) Initialise the geonames API wrapper for a given search and hierarchy service, username and token.

Method Summary

Modifier and Type	Method and Description
List<Toponym>	getHierarchy(int geonameId)
List<Toponym>	searchToponyms(Map<GeonamesAPIWrapper.SearchRequestPropertyEnum,Collection<String>> parsedParameter)
List<Toponym>	searchToponyms(String name)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_GEONAMES_ORG_WEBSERVICE_URL

public static final String DEFAULT_GEONAMES_ORG_WEBSERVICE_URL

URI of the geonames.org web services used as default. Currently this is the server that requires authentication with a free user account. The server that allows anonymous requests is often overloaded and is therefore no longer the default. Note that the anonymous server is still used in case this class is initialised with the default constructor.

See Also:

Constant Field Values

ANONYMOUS_GEONAMES_ORG_WEBSERVICE_URL

public static final String ANONYMOUS_GEONAMES_ORG_WEBSERVICE_URL

The geonames.org web service URI allowing anonymous connections. Often overloaded. Will be used with the default constructor

See Also:

Constant Field Values

SEARCH_SERVICE_PATH

public static final String SEARCH_SERVICE_PATH

Relative path to the search service

See Also:

Constant Field Values

HIERARCHY_SERVICE_PATH

public static final String HIERARCHY_SERVICE_PATH

Relative path to the hierarchy service

See Also:

Constant Field Values

searchServiceUrl

protected String searchServiceUrl

The access url for the search service. As default DEFAULT_GEONAMES_ORG_WEBSERVICE_URL+SEARCH_SERVICE_PATH ("http://api.geonames.org/""search") is used. Users with a premium account including an own sub domain might need to change this.

hierarchyServiceUrl

protected String hierarchyServiceUrl

The access url for the hierarchy service. As default DEFAULT_GEONAMES_ORG_WEBSERVICE_URL+HIERARCHY_SERVICE_PATH ("http://api.geonames.org/""hierarchy") is used. Users with a premium account including an own sub domain might need to change this.

Constructor Detail

GeonamesAPIWrapper

public GeonamesAPIWrapper()

Initialises a the geonames API wrapper as used for the free service

GeonamesAPIWrapper

public GeonamesAPIWrapper(String serverURL,
                          String userName,
                          String token)

Initialise the geonames API wrapper for a given server, username and token. Parsing null for any of the parameter will use the default values. If an empty string is parsed as user name it will be ignored. Token is only accepted if a valid user name is prased.

Parameters:

serverURL - The url of the geonames server to use or null to use the default

userName - The user name to use or null to use the default. The user name MUST NOT be empty.

token - The token to use or null to use the default. If no valid user name is parsed the token will be ignored.

GeonamesAPIWrapper

public GeonamesAPIWrapper(String searchService,
                          String hierarchyService,
                          String userName,
                          String token)

Initialise the geonames API wrapper for a given search and hierarchy service, username and token. Parsing null for any of the parameter will use the default values. If an empty string is parsed as user name it will be ignored. Token is only accepted if a valid user name is prased.

The parsed user name and token will be used for both the search and the hierarchy service.

Parameters:

searchService - The url of the search service to use or null to use the default

hierarchyService - The url of the hierarchy service to use or null to use the default

userName - The user name to use or null to use the default. The user name MUST NOT be empty.

token - The token to use or null to use the default. If no valid user name is parsed the token will be ignored.

Method Detail

searchToponyms

public List<Toponym> searchToponyms(String name)
                             throws IOException

Throws:

IOException

searchToponyms

public List<Toponym> searchToponyms(Map<GeonamesAPIWrapper.SearchRequestPropertyEnum,Collection<String>> parsedParameter)
                             throws IOException

Throws:

IOException

getHierarchy

public List<Toponym> getHierarchy(int geonameId)
                           throws IOException

Throws:

IOException