com.mapinfo.geocode.service

Class GeocodeRequest

java.lang.Object

com.mapinfo.geocode.service.GeocodeRequest

public class GeocodeRequest
extends Object

This class contains information needed to perform a geocode operation.

Field Summary

Fields

Modifier and Type	Field and Description
static GeocodeType	DEFAULT_TYPE

Constructor Summary

Constructors

Constructor and Description
GeocodeRequest()

Method Summary

Modifier and Type	Method and Description
List<Address>	getAddresses() The list of addresses to be geocoded.
Preferences	getPreferences() Indicates the preferences to be used for geocoding.
GeocodeType	getType() Indicates the geocode type to be performed.
void	setAddresses(List<Address> addresses) w Sets the list of addresses to be geocoded.
void	setPreferences(Preferences preferences) Sets the preferences to be used for geocoding.
void	setType(GeocodeType type) Set the geocode type to be performed.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TYPE

public static final GeocodeType DEFAULT_TYPE

Constructor Detail

GeocodeRequest

public GeocodeRequest()

Method Detail

getType

public GeocodeType getType()

Indicates the geocode type to be performed. If geocode type is null, the default is an address geocode.

Returns:

type of geocde to be requested

setType

public void setType(GeocodeType type)

Set the geocode type to be performed. If type is null, the default is an address geocode. If type is GeocodeType.CUSTOM, the preferences must indicate the custom type.

Parameters:

type - tye of geocode to be performed

getAddresses

public List<Address> getAddresses()

The list of addresses to be geocoded.

Returns:

a list of addresses to be geocoded

setAddresses

public void setAddresses(List<Address> addresses)
                  throws GeocodingException

w Sets the list of addresses to be geocoded. The list cannot be null and cannot be empty. Each address must at least have one field populated.

Parameters:

addresses - - list of addresses to geocode

Throws:

GeocodingException - if list is null or empty

getPreferences

public Preferences getPreferences()

Indicates the preferences to be used for geocoding. Null preferences will use the geocoding engine default settings.

Returns:

preferences to be used for geocoding.

setPreferences

public void setPreferences(Preferences preferences)

Sets the preferences to be used for geocoding. Null preferences will indicate that the geocoding engine default settings will be used.

Parameters:

preferences - preferences to be used for geocoding.

toString

public String toString()

Overrides:

toString in class Object