GeocoderPreferences (geocodingservices - geocoding-api 5.1.796 API)

java.lang.Object
- com.mapinfo.geocode.GeocoderPreferences

All Implemented Interfaces:

Preferences, Serializable

Direct Known Subclasses:

InteractivePreferences
```
public class GeocoderPreferences
extends Object
implements Preferences
```
This class implements the Preferences interface. It is used to specify desired behavior within a geocoding operation.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_CLIENT_COORD_SYS_NAME` Default coordinate system is epsg:4326 (WGS 84)
`static int`	`DEFAULT_CORNER_OFFSET` Default corner offset is 7 meters
`static DistanceUnit`	`DEFAULT_CORNER_OFFSET_UNITS` Default offset unit is meters
`static int`	`DEFAULT_DISTANCE` Default search distance for reverse geocode is 150 meters.
`static DistanceUnit`	`DEFAULT_DISTANCE_UNITS` Default reverse geocode search distance unit is meters
`static boolean`	`DEFAULT_FALL_BACK_TO_GEOGRAPHIC` In street geocoding, when no street candidates are found, geocoder will attempt to return a geographic centroid
`static boolean`	`DEFAULT_FALL_BACK_TO_POSTAL` In street geocoding, when no street candidates are found, geocoder will attempt to return a postal centroid
`static Locale`	`DEFAULT_LOCALE` default locale is one in use
`static MatchMode`	`DEFAULT_MATCHMODE` By default, no match mode is specified
`static int`	`DEFAULT_MAX_RETURN_CANDIDATES` Defaults to return only a single matched candidate
`static int`	`DEFAULT_MAX_RETURN_RANGES` Defaults to return only a single address range per candidate
`static int`	`DEFAULT_STREET_OFFSET` Default street offset is 7 meters
`static DistanceUnit`	`DEFAULT_STREET_OFFSET_UNITS` Default offset unit is meters
`static String`	`FALLBACK_TO_WORLD`
`static String`	`SEARCH_WORLD_PLACES`

Fields inherited from interface com.mapinfo.geocode.api.Preferences
GEOHASH_LEVEL, H3HEX_RESOLUTION, KEY_CUSTOM_DICTIONARY_USAGE, PREFER_CUSTOM_DICTIONARIES, PREFER_POBOX_OVER_STREET, PREFER_STANDARD_DICTIONARIES, RETURN_GEOHASH, RETURN_H3HEX, RETURN_PARSED_INPUT, USE_CUSTOM_DICTIONARIES_ONLY, USE_STANDARD_DICTIONARIES_ONLY

Constructor Summary

Constructors
Constructor and Description

GeocoderPreferences()
Constructs a new, empty preferences object

GeocoderPreferences(Preferences copyFrom)
Copy constructor

Constructors
Constructor and Description
`GeocoderPreferences()` Constructs a new, empty preferences object
`GeocoderPreferences(Preferences copyFrom)` Copy constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCustomPreference(String key, String value)` Allows a single custom key-value pair to be added to the preferences.
`boolean`	`equals(Object o)`
`BoundingBox`	`getBoundingBox()`
`String`	`getClientCoordSysName()` coordinate system to return points in, specified in teh "codespace:code" format.
`Locale`	`getClientLocale()` user input locale if specified.
`String`	`getClientLocaleString()` (non-Javadoc)
`double`	`getCornerOffset()` Used for interpolating the closest house number on a range.
`DistanceUnit`	`getCornerOffsetUnits()` Units for the corner offset
`Map<String,String>`	`getCustomPreferences()` The custom preferences allow input of String key-value pairs that represent custom geocoding preferences.
`double`	`getDistance()` Defines the maximum distance to search for reverse geocode candidates.
`DistanceUnit`	`getDistanceUnits()` Units for the distance of the reverse geocode search distance defined with getDistance
`MatchMode`	`getMatchMode()` Returns the match mode
`int`	`getMaxReturnedCandidates()` Specifies the maximum number of candidates to be returned.
`int`	`getMaxReturnedRanges()` Specifies the maximum number of ranges to be returned per candidate.
`int`	`getMaxReturnedRangeUnits()` Maximum number of unit objects to be returned on a range.
`FieldsMatching`	`getMustMatchFields()` Allows you to specify what fields must match input in order for a candidate to be considered close
`com.mapinfo.midev.geometry.IPoint`	`getPoint()`
`List<String>`	`getPreferredDictionaryOrder()` If a non empty list is returned, it contains the indexes of the dictionaries to be searched.
`ReturnFieldsDescriptor`	`getReturnFieldsDescriptor()` Allows you to select what parts of a candidate to return.
`double`	`getStreetOffset()` Used for interpolating the closest house number on a range.
`DistanceUnit`	`getStreetOffsetUnits()` Units for the street offset
`int`	`hashCode()`
`boolean`	`isFallbackToGeographic()` If true and an address level geocode fails to find a close candidate, wil attempt to find a geographic centroid based on the input address.
`boolean`	`isFallbackToPostal()` If true and an address level geocode fails to find a close candidate, wil attempt to find a postal centroid based on the input address.
`boolean`	`isReturnAllCandidateInfo()` If set to true, all available information will be returned for each candidate.
`void`	`setBoundingBox(BoundingBox boundingBox)` set the boundingBox
`void`	`setClientCoordSysName(String name)` Set coordinate system to return points in, using format "codespace:code".
`void`	`setClientLocale(Locale locale)` This method allows the user to specify their locale.
`void`	`setCornerOffset(double offset)` Used for interpolating the closest house number on a range.
`void`	`setCornerOffsetUnits(DistanceUnit units)` Units for the corner offset
`void`	`setCustomPreferences(Map<String,String> customPreferences)` Used to map of custom fields
`void`	`setDistance(double distance)` Defines the maximum distance to search for reverse geocode candidates.
`void`	`setDistanceUnits(DistanceUnit LinearUnits)` Units for the distance of the reverse geocode search distance defined with setDistance
`void`	`setFallbackToGeographic(boolean bFallback)` If true and an address level geocode fails to find a close candidate, wil attempt to find a geographic centroid based on the input address.
`void`	`setFallbackToPostal(boolean bFallback)` If true and an address level geocode fails to find a close candidate, wil attempt to find a postal centroid based on the input address.
`void`	`setMatchMode(MatchMode mode)` sets the match mode
`void`	`setMaxReturnedCandidates(int max)` Specifies the maximum number of candidates to be returned.
`void`	`setMaxReturnedRanges(int count)` Specifies the maximum number of ranges to be returned per candidate.
`void`	`setMaxReturnedRangeUnits(int count)` Set maximum number of unit objects to be returned on a range.
`void`	`setMustMatchFields(FieldsMatching mustMatchFields)` Allows you to specify what fields must match input in order for a candidate to be considered close
`void`	`setPoint(com.mapinfo.midev.geometry.IPoint point)` set the origin point
`void`	`setPreferredDictionaryOrder(List<String> orderedList)` For countries with more than one configured dictionary, this method allows the user to define the priorities of the dictionaries and also exclude specific configured dictionaries from the search.
`void`	`setReturnAllCandidateInfo(boolean bAll)` If set to true, all available information will be returned for each candidate.
`void`	`setReturnFieldsDescriptor(ReturnFieldsDescriptor descriptor)` Allows you to select what parts of a candidate to return.
`void`	`setStreetOffset(double offset)` Used for interpolating the closest house number on a range.
`void`	`setStreetOffsetUnits(DistanceUnit units)` Units for the street offset
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_FALL_BACK_TO_GEOGRAPHIC
```
public static final boolean DEFAULT_FALL_BACK_TO_GEOGRAPHIC
```
    In street geocoding, when no street candidates are found, geocoder will attempt to return a geographic centroid
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FALL_BACK_TO_POSTAL
```
public static final boolean DEFAULT_FALL_BACK_TO_POSTAL
```
    In street geocoding, when no street candidates are found, geocoder will attempt to return a postal centroid
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_RETURN_CANDIDATES
```
public static final int DEFAULT_MAX_RETURN_CANDIDATES
```
    Defaults to return only a single matched candidate
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_RETURN_RANGES
```
public static final int DEFAULT_MAX_RETURN_RANGES
```
    Defaults to return only a single address range per candidate
    
    See Also:
    
    Constant Field Values
  - DEFAULT_STREET_OFFSET
```
public static final int DEFAULT_STREET_OFFSET
```
    Default street offset is 7 meters
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CORNER_OFFSET
```
public static final int DEFAULT_CORNER_OFFSET
```
    Default corner offset is 7 meters
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DISTANCE
```
public static final int DEFAULT_DISTANCE
```
    Default search distance for reverse geocode is 150 meters. Max is 1.6km or 1 mile
    
    See Also:
    
    Constant Field Values
  - DEFAULT_MATCHMODE
```
public static final MatchMode DEFAULT_MATCHMODE
```
    By default, no match mode is specified
  - DEFAULT_LOCALE
```
public static final Locale DEFAULT_LOCALE
```
    default locale is one in use
  - DEFAULT_STREET_OFFSET_UNITS
```
public static final DistanceUnit DEFAULT_STREET_OFFSET_UNITS
```
    Default offset unit is meters
  - DEFAULT_CORNER_OFFSET_UNITS
```
public static final DistanceUnit DEFAULT_CORNER_OFFSET_UNITS
```
    Default offset unit is meters
  - DEFAULT_DISTANCE_UNITS
```
public static final DistanceUnit DEFAULT_DISTANCE_UNITS
```
    Default reverse geocode search distance unit is meters
  - DEFAULT_CLIENT_COORD_SYS_NAME
```
public static final String DEFAULT_CLIENT_COORD_SYS_NAME
```
    Default coordinate system is epsg:4326 (WGS 84)
    
    See Also:
    
    Constant Field Values
  - FALLBACK_TO_WORLD
```
public static final String FALLBACK_TO_WORLD
```
    See Also:
    
    Constant Field Values
  - SEARCH_WORLD_PLACES
```
public static final String SEARCH_WORLD_PLACES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - GeocoderPreferences
```
public GeocoderPreferences()
```
    Constructs a new, empty preferences object
  - GeocoderPreferences
```
public GeocoderPreferences(Preferences copyFrom)
```
    Copy constructor
    
    Parameters:
    
    copyFrom - object to copy preferences from
- Method Detail
  - getClientLocale
```
public Locale getClientLocale()
```
    Description copied from interface: Preferences
    
    user input locale if specified. This is only used by reverse geocoding in countries with more that one language, to determine the preferred language to return candidate in.
    
    Specified by:
    
    getClientLocale in interface Preferences
    
    Returns:
    
    users locale
  - setClientLocale
```
public void setClientLocale(Locale locale)
```
    Description copied from interface: Preferences
    
    This method allows the user to specify their locale. This is only used by reverse geocoding in countries with more that one language, to determine the preferred language to return candidate it.
    
    Specified by:
    
    setClientLocale in interface Preferences
    
    Parameters:
    
    locale - the locale
  - getClientCoordSysName
```
public String getClientCoordSysName()
```
    Description copied from interface: Preferences
    
    coordinate system to return points in, specified in teh "codespace:code" format. Default is "epsg:4326" (WGS 84)
    
    Specified by:
    
    getClientCoordSysName in interface Preferences
    
    Returns:
    
    requested coordinate system
  - setClientCoordSysName
```
public void setClientCoordSysName(String name)
```
    Description copied from interface: Preferences
    
    Set coordinate system to return points in, using format "codespace:code". Default is "epsg:4326" (WGS 84)
    
    Specified by:
    
    setClientCoordSysName in interface Preferences
    
    Parameters:
    
    name - requested coordinate system
  - getMaxReturnedRangeUnits
```
public int getMaxReturnedRangeUnits()
```
    Description copied from interface: Preferences
    
    Maximum number of unit objects to be returned on a range. Default is zero.
    
    Specified by:
    
    getMaxReturnedRangeUnits in interface Preferences
    
    Returns:
    
    maximum units to return
  - setMaxReturnedRangeUnits
```
public void setMaxReturnedRangeUnits(int count)
```
    Description copied from interface: Preferences
    
    Set maximum number of unit objects to be returned on a range. Default is zero. To return all units, enter -1.
    
    Specified by:
    
    setMaxReturnedRangeUnits in interface Preferences
    
    Parameters:
    
    count - maximum units to return
  - getStreetOffset
```
public double getStreetOffset()
```
    Description copied from interface: Preferences
    
    Used for interpolating the closest house number on a range. This value is the offset from the center of the street.
    
    Specified by:
    
    getStreetOffset in interface Preferences
    
    Returns:
    
    The street offset used to interpolate house numbers.
  - setStreetOffset
```
public void setStreetOffset(double offset)
```
    Description copied from interface: Preferences
    
    Used for interpolating the closest house number on a range. This value is the offset from the center of the street.
    
    Specified by:
    
    setStreetOffset in interface Preferences
    
    Parameters:
    
    offset - The street offset used to interpolate house numbers.
  - getCornerOffset
```
public double getCornerOffset()
```
    Description copied from interface: Preferences
    
    Used for interpolating the closest house number on a range. This value is the offset from the end of the street.
    
    Specified by:
    
    getCornerOffset in interface Preferences
    
    Returns:
    
    The corner offset used to interpolate house numbers.
  - setCornerOffset
```
public void setCornerOffset(double offset)
```
    Description copied from interface: Preferences
    
    Used for interpolating the closest house number on a range. This value is the offset from the end of the street.
    
    Specified by:
    
    setCornerOffset in interface Preferences
    
    Parameters:
    
    offset - The corner offset used to interpolate house numbers.
  - getStreetOffsetUnits
```
public DistanceUnit getStreetOffsetUnits()
```
    Description copied from interface: Preferences
    
    Units for the street offset
    
    Specified by:
    
    getStreetOffsetUnits in interface Preferences
    
    Returns:
    
    units for the street offset
  - setStreetOffsetUnits
```
public void setStreetOffsetUnits(DistanceUnit units)
```
    Description copied from interface: Preferences
    
    Units for the street offset
    
    Specified by:
    
    setStreetOffsetUnits in interface Preferences
    
    Parameters:
    
    units - units for the street offset
  - getCornerOffsetUnits
```
public DistanceUnit getCornerOffsetUnits()
```
    Description copied from interface: Preferences
    
    Units for the corner offset
    
    Specified by:
    
    getCornerOffsetUnits in interface Preferences
    
    Returns:
    
    units for the corner offset
  - setCornerOffsetUnits
```
public void setCornerOffsetUnits(DistanceUnit units)
```
    Description copied from interface: Preferences
    
    Units for the corner offset
    
    Specified by:
    
    setCornerOffsetUnits in interface Preferences
    
    Parameters:
    
    units - units for the corner offset
  - isReturnAllCandidateInfo
```
public boolean isReturnAllCandidateInfo()
```
    Description copied from interface: Preferences
    
    If set to true, all available information will be returned for each candidate. If false you may specify what to return in the ReturnFieldsDescriptor
    
    Specified by:
    
    isReturnAllCandidateInfo in interface Preferences
    
    Returns:
    
    true to return all available information on a candidate
  - setReturnAllCandidateInfo
```
public void setReturnAllCandidateInfo(boolean bAll)
```
    Description copied from interface: Preferences
    
    If set to true, all available information will be returned for each candidate. If false you may specify what to return in the ReturnFieldsDescriptor
    
    Specified by:
    
    setReturnAllCandidateInfo in interface Preferences
    
    Parameters:
    
    bAll - true to return all available information on a candidate
  - getReturnFieldsDescriptor
```
public ReturnFieldsDescriptor getReturnFieldsDescriptor()
```
    Description copied from interface: Preferences
    
    Allows you to select what parts of a candidate to return. Ignored if isReturnAllCandidateInfo is true
    
    Specified by:
    
    getReturnFieldsDescriptor in interface Preferences
    
    Returns:
    
    return fields object
  - setReturnFieldsDescriptor
```
public void setReturnFieldsDescriptor(ReturnFieldsDescriptor descriptor)
```
    Description copied from interface: Preferences
    
    Allows you to select what parts of a candidate to return. Ignored if isReturnAllCandidateInfo is true
    
    Specified by:
    
    setReturnFieldsDescriptor in interface Preferences
    
    Parameters:
    
    descriptor - return fields object
  - getPreferredDictionaryOrder
```
public List<String> getPreferredDictionaryOrder()
```
    Description copied from interface: Preferences
    
    If a non empty list is returned, it contains the indexes of the dictionaries to be searched.
    
    Specified by:
    
    getPreferredDictionaryOrder in interface Preferences
    
    Returns:
    
    list of dictionaries to be searched. If list is empty all available dictionaries will be searched
  - setPreferredDictionaryOrder
```
public void setPreferredDictionaryOrder(List<String> orderedList)
```
    Description copied from interface: Preferences
    
    For countries with more than one configured dictionary, this method allows the user to define the priorities of the dictionaries and also exclude specific configured dictionaries from the search. To use this feature, get the list of configured dictionaries for the country you are geocoding by calling the GeocodingAPI's getConfiguredDictionaries method. Then add a string representing the index of the desired dictionaries to the orderedList. If an index is not included, that dictionary will not be searched. When using geocodeMultiple or reverseGeocodeMultiple, you must also specify the country code (or "XWG" for the world geocoder) before the list of indexes for that country. More than one country can be specified in this way; for example {"AUS","0","2","XWG","0"} would skip the second configured dictionary for Australia and use only the first configured dictionary for the world geocoder. Exactly which dictionaries those are depends on the order given to the dictionaries when the geocoders were configured. The format including the country code can also be used to specify the order for the single geocode and reverseGeocode operations.
    
    Specified by:
    
    setPreferredDictionaryOrder in interface Preferences
    
    Parameters:
    
    orderedList - list containing strings indexes describing order and dictionaries to be searched
  - getCustomPreferences
```
public Map<String,String> getCustomPreferences()
```
    Description copied from interface: Preferences
    
    The custom preferences allow input of String key-value pairs that represent custom geocoding preferences. These represent preferences that apply only to certain countries, and can be found in the country's capabilities.
    
    Specified by:
    
    getCustomPreferences in interface Preferences
    
    Returns:
    
    Map of custom input values
  - setCustomPreferences
```
public void setCustomPreferences(Map<String,String> customPreferences)
```
    Description copied from interface: Preferences
    
    Used to map of custom fields
    
    Specified by:
    
    setCustomPreferences in interface Preferences
    
    Parameters:
    
    customPreferences - map of custom fields
  - addCustomPreference
```
public void addCustomPreference(String key,
                                String value)
```
    Description copied from interface: Preferences
    
    Allows a single custom key-value pair to be added to the preferences. If you add an existing key name with a null value, that removes the custom preference.
    
    Specified by:
    
    addCustomPreference in interface Preferences
    
    Parameters:
    
    key - this preference must be defined and understood by the target geocoder
    
    value - the value to be input
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getMaxReturnedRanges
```
public int getMaxReturnedRanges()
```
    Description copied from interface: Preferences
    
    Specifies the maximum number of ranges to be returned per candidate. Default is 0. Use -1 to return all ranges
    
    Specified by:
    
    getMaxReturnedRanges in interface Preferences
    
    Returns:
    
    number ranges per candidate.
  - setMaxReturnedRanges
```
public void setMaxReturnedRanges(int count)
```
    Description copied from interface: Preferences
    
    Specifies the maximum number of ranges to be returned per candidate. Default is 0. Use -1 to return all ranges
    
    Specified by:
    
    setMaxReturnedRanges in interface Preferences
    
    Parameters:
    
    count - number of ranges to return
  - isFallbackToGeographic
```
public boolean isFallbackToGeographic()
```
    Description copied from interface: Preferences
    
    If true and an address level geocode fails to find a close candidate, wil attempt to find a geographic centroid based on the input address.
    
    Specified by:
    
    isFallbackToGeographic in interface Preferences
    
    Returns:
    
    if fallback to geographic centroid is on
  - setFallbackToGeographic
```
public void setFallbackToGeographic(boolean bFallback)
```
    Description copied from interface: Preferences
    
    If true and an address level geocode fails to find a close candidate, wil attempt to find a geographic centroid based on the input address.
    
    Specified by:
    
    setFallbackToGeographic in interface Preferences
    
    Parameters:
    
    bFallback - true to turn fallback on
  - isFallbackToPostal
```
public boolean isFallbackToPostal()
```
    Description copied from interface: Preferences
    
    If true and an address level geocode fails to find a close candidate, wil attempt to find a postal centroid based on the input address.
    
    Specified by:
    
    isFallbackToPostal in interface Preferences
    
    Returns:
    
    if fallback to postal centroid is on
  - setFallbackToPostal
```
public void setFallbackToPostal(boolean bFallback)
```
    Description copied from interface: Preferences
    
    If true and an address level geocode fails to find a close candidate, wil attempt to find a postal centroid based on the input address. GGS
    
    Specified by:
    
    setFallbackToPostal in interface Preferences
    
    Parameters:
    
    bFallback - true to turn fallback on
  - getMaxReturnedCandidates
```
public int getMaxReturnedCandidates()
```
    Description copied from interface: Preferences
    
    Specifies the maximum number of candidates to be returned. Default is 1. Use -1 to return all candidates found
    
    Specified by:
    
    getMaxReturnedCandidates in interface Preferences
    
    Returns:
    
    number of candidates to return
  - setMaxReturnedCandidates
```
public void setMaxReturnedCandidates(int max)
```
    Description copied from interface: Preferences
    
    Specifies the maximum number of candidates to be returned. Default is 1. Use -1 to return all candidates found
    
    Specified by:
    
    setMaxReturnedCandidates in interface Preferences
    
    Parameters:
    
    max - number of candidates to return
  - getMustMatchFields
```
public FieldsMatching getMustMatchFields()
```
    Description copied from interface: Preferences
    
    Allows you to specify what fields must match input in order for a candidate to be considered close
    
    Specified by:
    
    getMustMatchFields in interface Preferences
    
    Returns:
    
    object describing what fields must match input for close candidates
  - setMustMatchFields
```
public void setMustMatchFields(FieldsMatching mustMatchFields)
```
    Description copied from interface: Preferences
    
    Allows you to specify what fields must match input in order for a candidate to be considered close
    
    Specified by:
    
    setMustMatchFields in interface Preferences
    
    Parameters:
    
    mustMatchFields - fields to match
  - getMatchMode
```
public MatchMode getMatchMode()
```
    Description copied from interface: Preferences
    
    Returns the match mode
    
    Specified by:
    
    getMatchMode in interface Preferences
    
    Returns:
    
    match mode
  - setMatchMode
```
public void setMatchMode(MatchMode mode)
```
    Description copied from interface: Preferences
    
    sets the match mode
    
    Specified by:
    
    setMatchMode in interface Preferences
    
    Parameters:
    
    mode - mode to set
  - getBoundingBox
```
public BoundingBox getBoundingBox()
```
    Specified by:
    
    getBoundingBox in interface Preferences
    
    Returns:
    
    - boundary to constrain sugguested results
  - setBoundingBox
```
public void setBoundingBox(BoundingBox boundingBox)
```
    Description copied from interface: Preferences
    
    set the boundingBox
    
    Specified by:
    
    setBoundingBox in interface Preferences
    
    Parameters:
    
    boundingBox - - boundary to constrain sugguested results
  - getPoint
```
public com.mapinfo.midev.geometry.IPoint getPoint()
```
    Specified by:
    
    getPoint in interface Preferences
    
    Returns:
    
    - Origin point used for constraining suggested results
  - setPoint
```
public void setPoint(com.mapinfo.midev.geometry.IPoint point)
```
    Description copied from interface: Preferences
    
    set the origin point
    
    Specified by:
    
    setPoint in interface Preferences
    
    Parameters:
    
    point - - Origin point used for constraining suggested results
  - getDistance
```
public double getDistance()
```
    Description copied from interface: Preferences
    
    Defines the maximum distance to search for reverse geocode candidates. Reverse geocode is limited to 1 mile or 1.6 kilometers, but in highly populated areas setting a smaller distance will improve performance.
    
    Specified by:
    
    getDistance in interface Preferences
    
    Returns:
    
    The radius to search for a reverse geocode address.
  - setDistance
```
public void setDistance(double distance)
```
    Description copied from interface: Preferences
    
    Defines the maximum distance to search for reverse geocode candidates. Reverse geocode is limited to 1 mile or 1.6 kilometers, but in highly populated areas setting a smaller distance will improve performance.
    
    Specified by:
    
    setDistance in interface Preferences
    
    Parameters:
    
    distance - The radius to search for a reverse geocode address.
  - getDistanceUnits
```
public DistanceUnit getDistanceUnits()
```
    Description copied from interface: Preferences
    
    Units for the distance of the reverse geocode search distance defined with getDistance
    
    Specified by:
    
    getDistanceUnits in interface Preferences
    
    Returns:
    
    units for the reverse geocode search distance
  - setDistanceUnits
```
public void setDistanceUnits(DistanceUnit LinearUnits)
```
    Description copied from interface: Preferences
    
    Units for the distance of the reverse geocode search distance defined with setDistance
    
    Specified by:
    
    setDistanceUnits in interface Preferences
    
    Parameters:
    
    LinearUnits - units for the reverse geocode search distance
  - getClientLocaleString
```
public String getClientLocaleString()
```
    (non-Javadoc)
    
    Specified by:
    
    getClientLocaleString in interface Preferences
    
    Returns:
    
    the string locale composed of "<Language>_<Country>", for example "fr_FR".
    
    See Also:
    
    Preferences
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class GeocoderPreferences

Field Summary

Fields inherited from interface com.mapinfo.geocode.api.Preferences

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FALL_BACK_TO_GEOGRAPHIC

DEFAULT_FALL_BACK_TO_POSTAL

DEFAULT_MAX_RETURN_CANDIDATES

DEFAULT_MAX_RETURN_RANGES

DEFAULT_STREET_OFFSET

DEFAULT_CORNER_OFFSET

DEFAULT_DISTANCE

DEFAULT_MATCHMODE

DEFAULT_LOCALE

DEFAULT_STREET_OFFSET_UNITS

DEFAULT_CORNER_OFFSET_UNITS

DEFAULT_DISTANCE_UNITS

DEFAULT_CLIENT_COORD_SYS_NAME

FALLBACK_TO_WORLD

SEARCH_WORLD_PLACES

Constructor Detail

GeocoderPreferences

GeocoderPreferences

Method Detail

getClientLocale

setClientLocale

getClientCoordSysName

setClientCoordSysName

getMaxReturnedRangeUnits

setMaxReturnedRangeUnits

getStreetOffset

setStreetOffset

getCornerOffset

setCornerOffset

getStreetOffsetUnits

setStreetOffsetUnits

getCornerOffsetUnits

setCornerOffsetUnits

isReturnAllCandidateInfo

setReturnAllCandidateInfo

getReturnFieldsDescriptor

setReturnFieldsDescriptor

getPreferredDictionaryOrder

setPreferredDictionaryOrder

getCustomPreferences

setCustomPreferences

addCustomPreference

toString

getMaxReturnedRanges

setMaxReturnedRanges

isFallbackToGeographic

setFallbackToGeographic

isFallbackToPostal

setFallbackToPostal

getMaxReturnedCandidates

setMaxReturnedCandidates

getMustMatchFields

setMustMatchFields

getMatchMode

setMatchMode

getBoundingBox

setBoundingBox

getPoint

setPoint

getDistance

setDistance

getDistanceUnits

setDistanceUnits

getClientLocaleString

equals

hashCode