com.mapinfo.geocode.interactive

Class InteractivePreferences

java.lang.Object

com.mapinfo.geocode.GeocoderPreferences

com.mapinfo.geocode.interactive.InteractivePreferences

All Implemented Interfaces:

Preferences, Serializable

public class InteractivePreferences
extends GeocoderPreferences

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

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

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_DISTANCE Default search distance for interactive is 5 MILES(8046.72m)
static DistanceUnit	DEFAULT_DISTANCE_UNITS Default interactive search distance unit is MILES
static int	DEFAULT_MAX_RANGE Defaults to return top 3 matched ranges
static int	DEFAULT_MAX_RANGE_UNITS Defaults to return top 3 units within a range
static int	DEFAULT_MAX_RETURN_CANDIDATES Defaults to return top 10 matched candidates

Fields inherited from class com.mapinfo.geocode.GeocoderPreferences

DEFAULT_CLIENT_COORD_SYS_NAME, DEFAULT_CORNER_OFFSET, DEFAULT_CORNER_OFFSET_UNITS, DEFAULT_FALL_BACK_TO_GEOGRAPHIC, DEFAULT_FALL_BACK_TO_POSTAL, DEFAULT_LOCALE, DEFAULT_MATCHMODE, DEFAULT_MAX_RETURN_RANGES, DEFAULT_STREET_OFFSET, DEFAULT_STREET_OFFSET_UNITS, FALLBACK_TO_WORLD, 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
InteractivePreferences()
InteractivePreferences(Preferences preferences)

Method Summary

Methods inherited from class com.mapinfo.geocode.GeocoderPreferences

addCustomPreference, equals, getBoundingBox, getClientCoordSysName, getClientLocale, getClientLocaleString, getCornerOffset, getCornerOffsetUnits, getCustomPreferences, getDistance, getDistanceUnits, getMatchMode, getMaxReturnedCandidates, getMaxReturnedRanges, getMaxReturnedRangeUnits, getMustMatchFields, getPoint, getPreferredDictionaryOrder, getReturnFieldsDescriptor, getStreetOffset, getStreetOffsetUnits, hashCode, isFallbackToGeographic, isFallbackToPostal, isReturnAllCandidateInfo, setBoundingBox, setClientCoordSysName, setClientLocale, setCornerOffset, setCornerOffsetUnits, setCustomPreferences, setDistance, setDistanceUnits, setFallbackToGeographic, setFallbackToPostal, setMatchMode, setMaxReturnedCandidates, setMaxReturnedRanges, setMaxReturnedRangeUnits, setMustMatchFields, setPoint, setPreferredDictionaryOrder, setReturnAllCandidateInfo, setReturnFieldsDescriptor, setStreetOffset, setStreetOffsetUnits, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_MAX_RETURN_CANDIDATES

public static final int DEFAULT_MAX_RETURN_CANDIDATES

Defaults to return top 10 matched candidates

See Also:

Constant Field Values

DEFAULT_DISTANCE

public static final int DEFAULT_DISTANCE

Default search distance for interactive is 5 MILES(8046.72m)

See Also:

Constant Field Values

DEFAULT_DISTANCE_UNITS

public static final DistanceUnit DEFAULT_DISTANCE_UNITS

Default interactive search distance unit is MILES

DEFAULT_MAX_RANGE

public static final int DEFAULT_MAX_RANGE

Defaults to return top 3 matched ranges

See Also:

Constant Field Values

DEFAULT_MAX_RANGE_UNITS

public static final int DEFAULT_MAX_RANGE_UNITS

Defaults to return top 3 units within a range

See Also:

Constant Field Values

Constructor Detail

InteractivePreferences

public InteractivePreferences()

InteractivePreferences

public InteractivePreferences(Preferences preferences)