com.mapinfo.geocode.interactive

Class InteractiveGeocoder

java.lang.Object

com.mapinfo.geocode.interactive.InteractiveGeocoder

All Implemented Interfaces:

InteractiveGeocodingAPI

Deprecated.

as of 3.0, use InteractiveBuilder This class handles all the top level interactive geocoding functionality

 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(...);
 

@Deprecated
public class InteractiveGeocoder
extends Object
implements InteractiveGeocodingAPI

Constructor Summary

Constructors

Constructor and Description
InteractiveGeocoder() Deprecated.
InteractiveGeocoder(com.pb.geocoding.config.api.GeocodingConfiguration configuration) Deprecated.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

InteractiveGeocoder

public InteractiveGeocoder()
                    throws GeocodingException

Deprecated.

Throws:

GeocodingException

InteractiveGeocoder

public InteractiveGeocoder(com.pb.geocoding.config.api.GeocodingConfiguration configuration)
                    throws GeocodingException

Deprecated.

Throws:

GeocodingException

Method Detail

suggest

public Response suggest(Address address,
                        Preferences preferences)
                 throws GeocodingException

Deprecated.

Description copied from interface: InteractiveGeocodingAPI

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
 

Specified by:

suggest in interface InteractiveGeocodingAPI

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

findNearest

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

Deprecated.

Description copied from interface: InteractiveGeocodingAPI

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

Specified by:

findNearest in interface InteractiveGeocodingAPI

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

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

Deprecated.

Description copied from interface: InteractiveGeocodingAPI

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

Specified by:

findNearest in interface InteractiveGeocodingAPI

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

getConfiguredDictionaries

public List<Dictionary> getConfiguredDictionaries(String country)
                                           throws GeocodingException

Deprecated.

Description copied from interface: InteractiveGeocodingAPI

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)

Specified by:

getConfiguredDictionaries in interface InteractiveGeocodingAPI

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

public List<Dictionary> getConfiguredDictionaries()
                                           throws GeocodingException

Deprecated.

Description copied from interface: InteractiveGeocodingAPI

Get the Interactive configured dictionaries for all countries.

Specified by:

getConfiguredDictionaries in interface InteractiveGeocodingAPI

Returns:

the list of configured dictionaries for all countries.

Throws:

GeocodingException - if exception is thrown while performing operation