Setting Searching and Matching Preferences When Using Standard and Custom Dictionaries

For countries that support both custom user dictionaries and standard geocoding datasets, a shortcut is provided for specifying which datasets to use for matching. You can set a custom preference with the key KEY_CUSTOM_DICTIONARY_USAGE that will define what to do when both custom and standard dictionaries are available in the geocoding engine. This key is only supported in forward geocoding.

Note that when preferredDictionaryOrder has been defined, then this key will be ignored.

The possible values allowed for this key are:

USE_CUSTOM_DICTIONARIES_ONLY

If both custom and standard dictionaries are configured, only search in the custom dictionaries. If no custom dictionaries are configured, this setting is ignored.

USE_STANDARD_DICTIONARIES_ONLY

If both custom and standard dictionaries are configured, only search in the standard dictionaries. If no standard dictionaries are configured, this setting is ignored.

PREFER_CUSTOM_DICTIONARIES

When equivalent candidates are found in both custom and standard dictionaries, prefer the candidates from the custom dictionaries. Note that the best quality match candidate will be returned, even if the match is from a non-preferred dictionary.

PREFER_STANDARD_DICTIONARIES

When equivalent candidates are found in both custom and standard dictionaries, prefer the candidates from the standard dictionaries. Note that the best quality match candidate will be returned, even if the match is from a non-preferred dictionary.

For information on setting up a custom option, see Custom Options.