com.mapinfo.geocode.api

Interface GeocodeEngine

All Superinterfaces:

Serializable

public interface GeocodeEngine
extends Serializable

This class describes the GeocodeEngine interface. It is used to describe features of that instance of the engine software. In the future, will be used to maintain the ordering of dictionaries use for a single geocoder instance.

Method Summary

Modifier and Type	Method and Description
List<String>	getDictionaryOrdering() Get the list of supported dictionaries in the order to be searched
String	getName() Get the name of the Geocoding engine
String	getPrimaryCountry() Get the country code used as internal name of the Geocoding Engine
List<String>	getSupportedCountries() Get the list of supported countries
String	getVersion() Get the version of the Geocoding engine
String	getVintage() Get the version string of the Geocoding engine
void	setDictionaryOrdering(List<String> dicts) set the list of supported dictionaries in the order to be searched
void	setName(String name) Set the name of the Geocoding Engine
void	setPrimaryCountry(String name) Set the country code used as internal name of the Geocoding Engine
void	setSupportedCountries(List<String> countries) Set the list of supported countries
void	setVersion(String version) Set the version of the Geocoding Engine
void	setVintage(String vintage) Set the version string of the Geocoding engine

Method Detail

getName

String getName()

Get the name of the Geocoding engine

Returns:

the name of the geocoding engine

setName

void setName(String name)

Set the name of the Geocoding Engine

Parameters:

name - - name of the geocoding engine

getVersion

String getVersion()

Get the version of the Geocoding engine

Returns:

the version of the geocoding engine

setVersion

void setVersion(String version)

Set the version of the Geocoding Engine

Parameters:

version - - version of the geocoding engine

getVintage

String getVintage()

Get the version string of the Geocoding engine

Returns:

the software vintage of the geocoding engine

setVintage

void setVintage(String vintage)

Set the version string of the Geocoding engine

Parameters:

vintage - the software vintage of the geocoding engine

getPrimaryCountry

String getPrimaryCountry()

Get the country code used as internal name of the Geocoding Engine

Returns:

3 char country abbreviation for the engine

setPrimaryCountry

void setPrimaryCountry(String name)

Set the country code used as internal name of the Geocoding Engine

Parameters:

name - - 3 char country abbreviation for the engine

getSupportedCountries

List<String> getSupportedCountries()

Get the list of supported countries

Returns:

the list of supported countries

setSupportedCountries

void setSupportedCountries(List<String> countries)

Set the list of supported countries

Parameters:

countries - - the list of supported countries

getDictionaryOrdering

List<String> getDictionaryOrdering()

Get the list of supported dictionaries in the order to be searched

Returns:

the ordered list of supported dictionaries

setDictionaryOrdering

void setDictionaryOrdering(List<String> dicts)

set the list of supported dictionaries in the order to be searched

Parameters:

dicts - - the ordered list of supported dictionaries