Dictionary (geocodingservices - geocoding-api 5.1.854 API)

All Known Implementing Classes:

GeocoderDictionary
```
public interface Dictionary
```
This class describes a single geocoder dictionary. A geocoder may have multiple dictionaries, representing different data sources or levels of geocoding supported. Dictionaries may also be created by a user for specific data in some countries.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Set<CountrySupport>`	`getCountrySupportInformation()` Holds information on the quality of data for each supported country
`String`	`getDescription()` A description of the dictionary
`String`	`getPath()` The path to the actual data dictionary on the server.
`String`	`getProduct()` A product code associated with the data
`String`	`getRegion()` A region of the dictionary
`String`	`getRepositoryName()` The name of the dictionary.
`String`	`getSource()` The source data vendor for this data
`String`	`getVintage()` The vintage of the source data for this dictionary
`boolean`	`isCustomDictionary()` True if this is a user created dictionary
`void`	`setCountrySupportInformation(Set<CountrySupport> countries)` Sets information on the quality of data for each supported country
`void`	`setCustomDictionary(boolean bCustom)` Set to true if this is a user created dictionary
`void`	`setDescription(String desc)` Sets a description of the dictionary
`void`	`setPath(String path)` Path to the actual data dictionary.
`void`	`setProduct(String product)` Set productCode for the data
`void`	`setRegion(String region)` Sets a region of the dictionary
`void`	`setRepositoryName(String name)` Set the name of the dictionary.
`void`	`setSource(String source)` Sets the source data vendor for this data
`void`	`setVintage(String vintage)` Sets the vintage of the source data for this dictionary

- Method Detail
  - getRepositoryName
```
String getRepositoryName()
```
    The name of the dictionary. Repositories are not yet in use.
    
    Returns:
    
    name of dictionary
  - setRepositoryName
```
void setRepositoryName(String name)
```
    Set the name of the dictionary. In the future, this will be the name used in the repository, but currently repositories are not supported.
    
    Parameters:
    
    name - name of dictionary
  - getPath
```
String getPath()
```
    The path to the actual data dictionary on the server. This may not be available to client users.
    
    Returns:
    
    path to actual data
  - setPath
```
void setPath(String path)
```
    Path to the actual data dictionary. This has no effect on the actual location of the data.
    
    Parameters:
    
    path - path to actual data
  - getCountrySupportInformation
```
Set<CountrySupport> getCountrySupportInformation()
```
    Holds information on the quality of data for each supported country
    
    Returns:
    
    country support information
  - setCountrySupportInformation
```
void setCountrySupportInformation(Set<CountrySupport> countries)
```
    Sets information on the quality of data for each supported country
    
    Parameters:
    
    countries - set of country support information
  - getVintage
```
String getVintage()
```
    The vintage of the source data for this dictionary
    
    Returns:
    
    vintage
  - setVintage
```
void setVintage(String vintage)
```
    Sets the vintage of the source data for this dictionary
    
    Parameters:
    
    vintage - description of data vintage
  - getSource
```
String getSource()
```
    The source data vendor for this data
    
    Returns:
    
    data vendor name
  - setSource
```
void setSource(String source)
```
    Sets the source data vendor for this data
    
    Parameters:
    
    source - data vendor name
  - isCustomDictionary
```
boolean isCustomDictionary()
```
    True if this is a user created dictionary
    
    Returns:
    
    true for user dictionary
  - setCustomDictionary
```
void setCustomDictionary(boolean bCustom)
```
    Set to true if this is a user created dictionary
    
    Parameters:
    
    bCustom - true for user dictionary
  - getDescription
```
String getDescription()
```
    A description of the dictionary
    
    Returns:
    
    dictionary description
  - setDescription
```
void setDescription(String desc)
```
    Sets a description of the dictionary
    
    Parameters:
    
    desc - dictionary description string
  - getRegion
```
String getRegion()
```
    A region of the dictionary
    
    Returns:
    
    dictionary region
  - setRegion
```
void setRegion(String region)
```
    Sets a region of the dictionary
    
    Parameters:
    
    region - dictionary region string
  - getProduct
```
String getProduct()
```
    A product code associated with the data
    
    Returns:
    
    productCode
  - setProduct
```
void setProduct(String product)
```
    Set productCode for the data
    
    Parameters:
    
    product - a product code associated with data

Interface Dictionary

Method Summary

Method Detail

getRepositoryName

setRepositoryName

getPath

setPath

getCountrySupportInformation

setCountrySupportInformation

getVintage

setVintage

getSource

setSource

isCustomDictionary

setCustomDictionary

getDescription

setDescription

getRegion

setRegion

getProduct

setProduct