Preferences (geocodingservices - geocoding-api 5.1.854 API)

All Superinterfaces:: Serializable

All Known Implementing Classes:: GeocoderPreferences, InteractivePreferences

public interface Preferences
extends Serializable

Preferences object pre-loaded with necessary preferences for interactive api

For overriding specific preferences without impacting all others this is how the object should be initialized for interactive api


 Preferences preferences = DefaultPreferencesProvider
         .getInstance().getDefaultInteractivePreferences();

 //will override default distance of 5 Miles to 6 Miles
 preferences.setDistance(6);
 preferences.setDistanceUnits(DistanceUnit.MILES);

For geocoding services:


 Preferences preferences = DefaultPreferencesProvider
         .getInstance().getDefaultPreferences();

 //will override default corner offset of 7 Meters to 8 Feet
 preferences.setCornerOffset(8);
 preferences.setDistanceUnits(DistanceUnit.FEET);

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`GEOHASH_LEVEL` indicator for precision level of geo hash
`static String`	`H3HEX_RESOLUTION` indicator for returning h3hex resolution of a location
`static String`	`KEY_CUSTOM_DICTIONARY_USAGE` Use this key in the custom preferences to define what to do when both custom and standard dictionaries are available in the geocoding engine.
`static String`	`PREFER_CUSTOM_DICTIONARIES` If this value is present for KEY_CUSTOM_DICTIONARY_USAGE in the custom preferences, then when candidates are found in both standard and custom dictionaries, the candidates from the custom dictionaries are preferred.
`static String`	`PREFER_POBOX_OVER_STREET` If this key is present in the custom preference with a value of "true" then when both a po box and a street address are given on input, the PO Box will be used if valid.
`static String`	`PREFER_STANDARD_DICTIONARIES` If this value is present for KEY_CUSTOM_DICTIONARY_USAGE in the custom preferences, then when candidates are found in both standard and custom dictionaries, the candidates from the standard dictionaries are preferred.
`static String`	`RETURN_GEOHASH` indicator for returning geo hash of a location
`static String`	`RETURN_H3HEX` indicator for returning h3hex of a location
`static String`	`RETURN_PARSED_INPUT` If this key is present in the custom preference with a value of "true" then will return parsed input address in the Response.
`static String`	`USE_CUSTOM_DICTIONARIES_ONLY` If this value is present for KEY_CUSTOM_DICTIONARY_USAGE in the custom preferences, then only custom dictionaries will be searched during the geocode request.
`static String`	`USE_STANDARD_DICTIONARIES_ONLY` If this value is present for KEY_CUSTOM_DICTIONARY_USAGE in the custom preferences, then only standard dictionaries will be searched during the geocode request.

Method Summary

All Methods Instance Methods Abstract 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.
`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()` Returns an uppercase ISO 3166 2-letter code.
`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
`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 units)` 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 origin)` 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

- Field Detail
  - KEY_CUSTOM_DICTIONARY_USAGE
```
static final String KEY_CUSTOM_DICTIONARY_USAGE
```
    Use this key in the custom preferences to define what to do when both custom and standard dictionaries are available in the geocoding engine. Note that is a "preferredDictionaryOrder" has been defined then this key will be ignored.
    
    See Also:
    
    Constant Field Values
  - PREFER_CUSTOM_DICTIONARIES
```
static final String PREFER_CUSTOM_DICTIONARIES
```
    If this value is present for KEY_CUSTOM_DICTIONARY_USAGE in the custom preferences, then when candidates are found in both standard and custom dictionaries, the candidates from the custom dictionaries are preferred.
    
    See Also:
    
    Constant Field Values
  - PREFER_STANDARD_DICTIONARIES
```
static final String PREFER_STANDARD_DICTIONARIES
```
    If this value is present for KEY_CUSTOM_DICTIONARY_USAGE in the custom preferences, then when candidates are found in both standard and custom dictionaries, the candidates from the standard dictionaries are preferred.
    
    See Also:
    
    Constant Field Values
  - USE_CUSTOM_DICTIONARIES_ONLY
```
static final String USE_CUSTOM_DICTIONARIES_ONLY
```
    If this value is present for KEY_CUSTOM_DICTIONARY_USAGE in the custom preferences, then only custom dictionaries will be searched during the geocode request.
    
    See Also:
    
    Constant Field Values
  - USE_STANDARD_DICTIONARIES_ONLY
```
static final String USE_STANDARD_DICTIONARIES_ONLY
```
    If this value is present for KEY_CUSTOM_DICTIONARY_USAGE in the custom preferences, then only standard dictionaries will be searched during the geocode request.
    
    See Also:
    
    Constant Field Values
  - RETURN_PARSED_INPUT
```
static final String RETURN_PARSED_INPUT
```
    If this key is present in the custom preference with a value of "true" then will return parsed input address in the Response.
    
    See Also:
    
    Constant Field Values
  - PREFER_POBOX_OVER_STREET
```
static final String PREFER_POBOX_OVER_STREET
```
    If this key is present in the custom preference with a value of "true" then when both a po box and a street address are given on input, the PO Box will be used if valid.
    
    See Also:
    
    Constant Field Values
  - RETURN_GEOHASH
```
static final String RETURN_GEOHASH
```
    indicator for returning geo hash of a location
    
    See Also:
    
    Constant Field Values
  - GEOHASH_LEVEL
```
static final String GEOHASH_LEVEL
```
    indicator for precision level of geo hash
    
    See Also:
    
    Constant Field Values
  - RETURN_H3HEX
```
static final String RETURN_H3HEX
```
    indicator for returning h3hex of a location
    
    See Also:
    
    Constant Field Values
  - H3HEX_RESOLUTION
```
static final String H3HEX_RESOLUTION
```
    indicator for returning h3hex resolution of a location
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getClientLocale
```
Locale getClientLocale()
```
    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.
    
    Returns:
    
    users locale
  - setClientLocale
```
void setClientLocale(Locale locale)
```
    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.
    
    Parameters:
    
    locale - the locale
  - getClientCoordSysName
```
String getClientCoordSysName()
```
    coordinate system to return points in, specified in teh "codespace:code" format. Default is "epsg:4326" (WGS 84)
    
    Returns:
    
    requested coordinate system
  - setClientCoordSysName
```
void setClientCoordSysName(String name)
```
    Set coordinate system to return points in, using format "codespace:code". Default is "epsg:4326" (WGS 84)
    
    Parameters:
    
    name - requested coordinate system
  - getMaxReturnedRangeUnits
```
int getMaxReturnedRangeUnits()
```
    Maximum number of unit objects to be returned on a range. Default is zero.
    
    Returns:
    
    maximum units to return
  - setMaxReturnedRangeUnits
```
void setMaxReturnedRangeUnits(int count)
```
    Set maximum number of unit objects to be returned on a range. Default is zero. To return all units, enter -1.
    
    Parameters:
    
    count - maximum units to return
  - getDistance
```
double getDistance()
```
    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.
    
    Returns:
    
    The radius to search for a reverse geocode address.
  - setDistance
```
void setDistance(double distance)
```
    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.
    
    Parameters:
    
    distance - The radius to search for a reverse geocode address.
  - getStreetOffset
```
double getStreetOffset()
```
    Used for interpolating the closest house number on a range. This value is the offset from the center of the street.
    
    Returns:
    
    The street offset used to interpolate house numbers.
  - setStreetOffset
```
void setStreetOffset(double offset)
```
    Used for interpolating the closest house number on a range. This value is the offset from the center of the street.
    
    Parameters:
    
    offset - The street offset used to interpolate house numbers.
  - getCornerOffset
```
double getCornerOffset()
```
    Used for interpolating the closest house number on a range. This value is the offset from the end of the street.
    
    Returns:
    
    The corner offset used to interpolate house numbers.
  - setCornerOffset
```
void setCornerOffset(double offset)
```
    Used for interpolating the closest house number on a range. This value is the offset from the end of the street.
    
    Parameters:
    
    offset - The corner offset used to interpolate house numbers.
  - getDistanceUnits
```
DistanceUnit getDistanceUnits()
```
    Units for the distance of the reverse geocode search distance defined with getDistance
    
    Returns:
    
    units for the reverse geocode search distance
  - setDistanceUnits
```
void setDistanceUnits(DistanceUnit units)
```
    Units for the distance of the reverse geocode search distance defined with setDistance
    
    Parameters:
    
    units - units for the reverse geocode search distance
  - getStreetOffsetUnits
```
DistanceUnit getStreetOffsetUnits()
```
    Units for the street offset
    
    Returns:
    
    units for the street offset
  - setStreetOffsetUnits
```
void setStreetOffsetUnits(DistanceUnit units)
```
    Units for the street offset
    
    Parameters:
    
    units - units for the street offset
  - getCornerOffsetUnits
```
DistanceUnit getCornerOffsetUnits()
```
    Units for the corner offset
    
    Returns:
    
    units for the corner offset
  - setCornerOffsetUnits
```
void setCornerOffsetUnits(DistanceUnit units)
```
    Units for the corner offset
    
    Parameters:
    
    units - units for the corner offset
  - isReturnAllCandidateInfo
```
boolean isReturnAllCandidateInfo()
```
    If set to true, all available information will be returned for each candidate. If false you may specify what to return in the ReturnFieldsDescriptor
    
    Returns:
    
    true to return all available information on a candidate
  - setReturnAllCandidateInfo
```
void setReturnAllCandidateInfo(boolean bAll)
```
    If set to true, all available information will be returned for each candidate. If false you may specify what to return in the ReturnFieldsDescriptor
    
    Parameters:
    
    bAll - true to return all available information on a candidate
  - getReturnFieldsDescriptor
```
ReturnFieldsDescriptor getReturnFieldsDescriptor()
```
    Allows you to select what parts of a candidate to return. Ignored if isReturnAllCandidateInfo is true
    
    Returns:
    
    return fields object
  - setReturnFieldsDescriptor
```
void setReturnFieldsDescriptor(ReturnFieldsDescriptor descriptor)
```
    Allows you to select what parts of a candidate to return. Ignored if isReturnAllCandidateInfo is true
    
    Parameters:
    
    descriptor - return fields object
  - getPreferredDictionaryOrder
```
List<String> getPreferredDictionaryOrder()
```
    If a non empty list is returned, it contains the indexes of the dictionaries to be searched.
    
    Returns:
    
    list of dictionaries to be searched. If list is empty all available dictionaries will be searched
  - setPreferredDictionaryOrder
```
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. 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.
    
    Parameters:
    
    orderedList - list containing strings indexes describing order and dictionaries to be searched
  - getCustomPreferences
```
Map<String,String> getCustomPreferences()
```
    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.
    
    Returns:
    
    Map of custom input values
  - setCustomPreferences
```
void setCustomPreferences(Map<String,String> customPreferences)
```
    Used to map of custom fields
    
    Parameters:
    
    customPreferences - map of custom fields
  - addCustomPreference
```
void addCustomPreference(String key,
                         String value)
```
    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.
    
    Parameters:
    
    key - this preference must be defined and understood by the target geocoder
    
    value - the value to be input
  - getMaxReturnedRanges
```
int getMaxReturnedRanges()
```
    Specifies the maximum number of ranges to be returned per candidate. Default is 0. Use -1 to return all ranges
    
    Returns:
    
    number ranges per candidate.
  - setMaxReturnedRanges
```
void setMaxReturnedRanges(int count)
```
    Specifies the maximum number of ranges to be returned per candidate. Default is 0. Use -1 to return all ranges
    
    Parameters:
    
    count - number of ranges to return
  - isFallbackToGeographic
```
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.
    
    Returns:
    
    if fallback to geographic centroid is on
  - setFallbackToGeographic
```
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.
    
    Parameters:
    
    bFallback - true to turn fallback on
  - isFallbackToPostal
```
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.
    
    Returns:
    
    if fallback to postal centroid is on
  - setFallbackToPostal
```
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. GGS
    
    Parameters:
    
    bFallback - true to turn fallback on
  - getMaxReturnedCandidates
```
int getMaxReturnedCandidates()
```
    Specifies the maximum number of candidates to be returned. Default is 1. Use -1 to return all candidates found
    
    Returns:
    
    number of candidates to return
  - setMaxReturnedCandidates
```
void setMaxReturnedCandidates(int max)
```
    Specifies the maximum number of candidates to be returned. Default is 1. Use -1 to return all candidates found
    
    Parameters:
    
    max - number of candidates to return
  - getMustMatchFields
```
FieldsMatching getMustMatchFields()
```
    Allows you to specify what fields must match input in order for a candidate to be considered close
    
    Returns:
    
    object describing what fields must match input for close candidates
  - setMustMatchFields
```
void setMustMatchFields(FieldsMatching mustMatchFields)
```
    Allows you to specify what fields must match input in order for a candidate to be considered close
    
    Parameters:
    
    mustMatchFields - fields to match
  - getMatchMode
```
MatchMode getMatchMode()
```
    Returns the match mode
    
    Returns:
    
    match mode
  - setMatchMode
```
void setMatchMode(MatchMode mode)
```
    sets the match mode
    
    Parameters:
    
    mode - mode to set
  - getClientLocaleString
```
String getClientLocaleString()
```
    Returns an uppercase ISO 3166 2-letter code. For non-Java API such as web services.
    
    Returns:
    
    the string locale
  - getBoundingBox
```
BoundingBox getBoundingBox()
```
    Returns:
    
    - boundary to constrain sugguested results
  - setBoundingBox
```
void setBoundingBox(BoundingBox boundingBox)
```
    set the boundingBox
    
    Parameters:
    
    boundingBox - - boundary to constrain sugguested results
  - getPoint
```
com.mapinfo.midev.geometry.IPoint getPoint()
```
    Returns:
    
    - Origin point used for constraining suggested results
  - setPoint
```
void setPoint(com.mapinfo.midev.geometry.IPoint origin)
```
    set the origin point
    
    Parameters:
    
    origin - - Origin point used for constraining suggested results

Interface Preferences

Field Summary

Method Summary

Field Detail

KEY_CUSTOM_DICTIONARY_USAGE

PREFER_CUSTOM_DICTIONARIES

PREFER_STANDARD_DICTIONARIES

USE_CUSTOM_DICTIONARIES_ONLY

USE_STANDARD_DICTIONARIES_ONLY

RETURN_PARSED_INPUT

PREFER_POBOX_OVER_STREET

RETURN_GEOHASH

GEOHASH_LEVEL

RETURN_H3HEX

H3HEX_RESOLUTION

Method Detail

getClientLocale

setClientLocale

getClientCoordSysName

setClientCoordSysName

getMaxReturnedRangeUnits

setMaxReturnedRangeUnits

getDistance

setDistance

getStreetOffset

setStreetOffset

getCornerOffset

setCornerOffset

getDistanceUnits

setDistanceUnits

getStreetOffsetUnits

setStreetOffsetUnits

getCornerOffsetUnits

setCornerOffsetUnits

isReturnAllCandidateInfo

setReturnAllCandidateInfo

getReturnFieldsDescriptor

setReturnFieldsDescriptor

getPreferredDictionaryOrder

setPreferredDictionaryOrder

getCustomPreferences

setCustomPreferences

addCustomPreference

getMaxReturnedRanges

setMaxReturnedRanges

isFallbackToGeographic

setFallbackToGeographic

isFallbackToPostal

setFallbackToPostal

getMaxReturnedCandidates

setMaxReturnedCandidates

getMustMatchFields

setMustMatchFields

getMatchMode

setMatchMode

getClientLocaleString

getBoundingBox

setBoundingBox

getPoint

setPoint