com.mapinfo.geocode

Class Geocoder

java.lang.Object

com.mapinfo.geocode.Geocoder

All Implemented Interfaces:

GeocodingAPI, AutoCloseable

Deprecated.

As of 3.0, use GeocoderBuilder A Geocoder is the primary implementation of the GeocodingAPI. This object exposes the primary services available for geocoding.

 /**
  * dist/resources
  * - config
  * - bin
  * - lib
  **\/
 GeocodingConfiguration configuration = new ConfigurationBuilder()
         .withConfigurationPath(Paths.get("dist/resources"))
         .build();

 GeocodingAPI geocoder = new Geocoder(configuration);
 Address address = new GeocodeAddress();
 address.setMainAddressLine("1 Global View Troy NY 12180 USA");
 Response response = geocoder.geocode(GeocoderType.ADDRESS, address, null);
 

@Deprecated
public class Geocoder
extends Object
implements GeocodingAPI

Constructor Summary

Constructors

Constructor and Description
Geocoder() Deprecated. Constructs a Geocoder object
Geocoder(com.pb.geocoding.config.api.GeocodingConfiguration configuration) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	close() Deprecated.
Response	geocode(GeocodeType type, Address address, Preferences preferences) Deprecated. Geocode an address.
List<Response>	geocodeMultiple(GeocodeType type, List<Address> addressList, Preferences preferences) Deprecated.
CapabilitiesResponse	getCapabilities() Deprecated. Get the capabilities of the geocoding service for all countries.
CapabilitiesResponse	getCapabilities(String country) Deprecated. Get the capabilities of all geocoding service operations for a single country.
CapabilitiesResponse	getCapabilities(String country, String operation) Deprecated. Get the capabilities of the named operation for a single country.
List<Dictionary>	getConfiguredDictionaries() Deprecated. Get the configured dictionaries for all countries.
List<Dictionary>	getConfiguredDictionaries(String country) Deprecated. Get the configured dictionaries for a single country.
Response	keyLookup(KeyType type, Key key, Preferences preferences) Deprecated.
List<Response>	keyLookupMultiple(KeyType type, List<Key> keys, Preferences preferences) Deprecated.
Response	reverseGeocode(double x, double y, String csys, String country, Preferences preferences) Deprecated. Reverse geocode a point and return the address closest to the given x and y value.
Response	reverseGeocode(com.mapinfo.midev.geometry.IPoint point, String country, Preferences preferences) Deprecated. Reverse geocode a point and return the address closest to that point.
List<Response>	reverseGeocodeMultiple(List<Points> locationList, Preferences preferences) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Geocoder

public Geocoder()
         throws GeocodingException

Deprecated.

Constructs a Geocoder object

Throws:

GeocodingException - if an exception is thrown during construction of a Geocoder object

Geocoder

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

Deprecated.

Throws:

GeocodingException

Method Detail

geocode

public Response geocode(GeocodeType type,
                        Address address,
                        Preferences preferences)
                 throws GeocodingException

Deprecated.

Description copied from interface: GeocodingAPI

Geocode an address. The "country" field of the Address must contain the ISO-3166 3-char country code abbreviation at this time.

Specified by:

geocode in interface GeocodingAPI

Parameters:

type - - type of geocoding operation to perform

address - - the address to geocode

preferences - - geocoding preferences

Returns:

a response containing candidate addresses.

Throws:

GeocodingException - if exception is thrown while performing operation

geocodeMultiple

public List<Response> geocodeMultiple(GeocodeType type,
                                      List<Address> addressList,
                                      Preferences preferences)
                               throws GeocodingException

Deprecated.

Specified by:

geocodeMultiple in interface GeocodingAPI

Parameters:

type - - type of geocoding operation to perform on each address in the list

addressList - - the list of addresses to geocode

preferences - - geocoding preferences to apply to each address in the list

Returns:

a list of responses containing candidate addresses.

Throws:

GeocodingException - if exception is thrown while performing operation

reverseGeocode

public Response reverseGeocode(double x,
                               double y,
                               String csys,
                               String country,
                               Preferences preferences)
                        throws GeocodingException

Deprecated.

Description copied from interface: GeocodingAPI

Reverse geocode a point and return the address closest to the given x and y value. If no csys name is provided, the coordinate system is assumed to be epsg:4326 (WGS84). Otherwise the csys should be in "codespace:code" format, e.g., "epsg:4326" is Long/Lat WGS84. of reverseGeocode that takes a IPoint as input as this allows for coordinate system specification. Country is not required but performance will be better if a country is supplied.

Specified by:

reverseGeocode in interface GeocodingAPI

Parameters:

x - - the x value of the location

y - - the y value of the location

csys - - the name of the coordinate system in "codespace:code" format.

country - - the optional country specification

preferences - - geocoding preferences

Returns:

a response containing candidate addresses.

Throws:

GeocodingException - if exception is thrown while performing operation

reverseGeocode

public Response reverseGeocode(com.mapinfo.midev.geometry.IPoint point,
                               String country,
                               Preferences preferences)
                        throws GeocodingException

Deprecated.

Description copied from interface: GeocodingAPI

Reverse geocode a point and return the address closest to that point. Country is not required but performance will be better if a country is supplied.

Specified by:

reverseGeocode in interface GeocodingAPI

Parameters:

point - - Contains the location to look up.

country - - the optional country specification

preferences - - geocoding preferences

Returns:

a response containing candidate addresses.

Throws:

GeocodingException - if exception is thrown while performing operation

reverseGeocodeMultiple

public List<Response> reverseGeocodeMultiple(List<Points> locationList,
                                             Preferences preferences)
                                      throws GeocodingException

Deprecated.

Specified by:

reverseGeocodeMultiple in interface GeocodingAPI

Parameters:

locationList - - the list of locations

preferences - - geocoding preferences

Returns:

a response containing candidate addresses.

Throws:

GeocodingException - if exception is thrown while performing operation

getConfiguredDictionaries

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

Deprecated.

Description copied from interface: GeocodingAPI

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

Specified by:

getConfiguredDictionaries in interface GeocodingAPI

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: GeocodingAPI

Get the configured dictionaries for all countries.

Specified by:

getConfiguredDictionaries in interface GeocodingAPI

Returns:

the list of configured dictionaries for all countries.

Throws:

GeocodingException - if exception is thrown while performing operation

getCapabilities

public CapabilitiesResponse getCapabilities()
                                     throws GeocodingException

Deprecated.

Description copied from interface: GeocodingAPI

Get the capabilities of the geocoding service for all countries.

Specified by:

getCapabilities in interface GeocodingAPI

Returns:

the capabilities of the geocoding service for all countries.

Throws:

GeocodingException - if exception is thrown while performing operation

getCapabilities

public CapabilitiesResponse getCapabilities(String country,
                                            String operation)
                                     throws GeocodingException

Deprecated.

Description copied from interface: GeocodingAPI

Get the capabilities of the named operation for a single country. If no local geocoder exists for that country, but the world geocoder is installed, it will return the information for the world geocoder (XWG).

Specified by:

getCapabilities in interface GeocodingAPI

Parameters:

country - - the country to return the information for. i.e. USA

operation - - operation to return the information for. i.e. geocode

Returns:

the capabilities of the gecoding service for one country.

Throws:

GeocodingException - if exception is thrown while performing operation

getCapabilities

public CapabilitiesResponse getCapabilities(String country)
                                     throws GeocodingException

Deprecated.

Description copied from interface: GeocodingAPI

Get the capabilities of all geocoding service operations for a single country. If no local geocoder exists for that country, but the world geocoder is installed, it will return the information for the world geocoder (XWG)

Specified by:

getCapabilities in interface GeocodingAPI

Parameters:

country - - the country to return the information for.

Returns:

the capabilities of the gecoding service for one country.

Throws:

GeocodingException - if exception is thrown while performing operation

keyLookup

public Response keyLookup(KeyType type,
                          Key key,
                          Preferences preferences)
                   throws GeocodingException

Deprecated.

Specified by:

keyLookup in interface GeocodingAPI

Parameters:

type - - type of the key to do geocoding based off of

key - - look up key to use for geocoding

preferences - - preferences that should be used for geocoding or for returning response

Returns:

a response containing candidate addresses.

Throws:

GeocodingException - if exception is thrown while performing operation

keyLookupMultiple

public List<Response> keyLookupMultiple(KeyType type,
                                        List<Key> keys,
                                        Preferences preferences)
                                 throws GeocodingException

Deprecated.

Specified by:

keyLookupMultiple in interface GeocodingAPI

Parameters:

type - - type of the key to do geocoding based off of

keys - - keys to be used for geocoding

preferences - - preferences that should be used for geocoding or for returning response

Returns:

a list of responses containing candidate addresses.

Throws:

GeocodingException - if exception is thrown while performing operation

close

public void close()
           throws Exception

Deprecated.

Specified by:

close in interface AutoCloseable

Throws:

Exception