com.mapinfo.geocode.api

Interface InteractiveGeocodingAPI

All Known Implementing Classes:

InteractiveGeocoder

public interface InteractiveGeocodingAPI

The GeoComplete API allows candidates to be found based on incomplete input information.

 GeocodingConfiguration configuration = new ConfigurationBuilder()
         .setConfigirationLocation(Paths.get("/dist/resources/config"))
         .setNativeBinariesLocation(Paths.get("/dist/resources/bin/linux64"))
         .setResolveClassPathConfig(false)
         .build();

 InteractiveGeocodingAPI interactiveAPI = new InteractiveGeocoder(configuration);
 Response response = interactiveAPI.suggest(...);
 

Method Summary

Modifier and Type	Method and Description
Response	findNearest(double x, double y, Preferences preferences) Looks for data records that fall within the default distance point.
Response	findNearest(com.mapinfo.midev.geometry.IPoint origin, Preferences preferences) Looks for data records that fall within the default distance point.
List<Dictionary>	getConfiguredDictionaries() Get the Interactive configured dictionaries for all countries.
List<Dictionary>	getConfiguredDictionaries(String country) Get the configured dictionaries for a single country.
Response	suggest(Address address, Preferences preferences) Completes the given information with a collection of suggested candidate matches.

Method Detail

suggest

Response suggest(Address address,
                 Preferences preferences)
          throws GeocodingException

Completes the given information with a collection of suggested candidate matches. Interactive search is done on mainAddressLine of Address Object other fields of Address are only used for filtering, and restricting available responses i.e country etc.

 Address address = new GeocodeAddress();
 address.setMainAddressLine("1 Global View"); //search for 1 Global View
 address.setCountry("usa"); //only from usa
 //other Address fields can be used for further restriction of search location
 

Parameters:

address - input address information. For interactive search utilizes the mainAddress of Address Object

preferences - if null provided defaults will be used

Returns:

Response an instance of InteractiveResponse

Throws:

GeocodingException - an exception is thrown if address is null or with invalid configuration

getConfiguredDictionaries

List<Dictionary> getConfiguredDictionaries(String country)
                                    throws GeocodingException

Get the configured dictionaries for a single country. If no local Interactive geocoder exists for that country, but the world geocoder is installed, it will return the information for the world Interactive geocoder (XWG)

Parameters:

country - - the country to return the information for.

Returns:

the list of configured dictionaries for a single country.

Throws:

GeocodingException - if exception is thrown while performing operation

getConfiguredDictionaries

List<Dictionary> getConfiguredDictionaries()
                                    throws GeocodingException

Get the Interactive configured dictionaries for all countries.

Returns:

the list of configured dictionaries for all countries.

Throws:

GeocodingException - if exception is thrown while performing operation

findNearest

Response findNearest(com.mapinfo.midev.geometry.IPoint origin,
                     Preferences preferences)
              throws GeocodingException

Looks for data records that fall within the default distance point. To change the default distance setthe Distance and DistanceUnit fields in the Preferences.

Parameters:

origin - Centerpoint of the area to be searched

preferences - provide non default user preferences

Returns:

Response conatining a collection of Candidates

Throws:

GeocodingException - if exception is thrown while performing operation

findNearest

Response findNearest(double x,
                     double y,
                     Preferences preferences)
              throws GeocodingException

Looks for data records that fall within the default distance point. To change the default distance setthe Distance and DistanceUnit fields in the Preferences.

Parameters:

x - X-Origin of the area to be searched

y - Y-Origin of the area to be searched

preferences - provide non default user preferences

Returns:

Response conatining a collection of Candidates

Throws:

GeocodingException - if exception is thrown while performing operation