com.precisely.addressing.v1.model

Class GeocoderDictionary

java.lang.Object

com.precisely.addressing.v1.model.GeocoderDictionary

All Implemented Interfaces:

Dictionary, Serializable

public class GeocoderDictionary
extends Object
implements Dictionary, Serializable

This class represents a Geocode Dictionary.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GeocoderDictionary()
GeocoderDictionary(Dictionary dict)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
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
int	hashCode()
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
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GeocoderDictionary

public GeocoderDictionary()

GeocoderDictionary

public GeocoderDictionary(Dictionary dict)

Method Detail

getRepositoryName

public String getRepositoryName()

Description copied from interface: Dictionary

The name of the dictionary. Repositories are not yet in use.

Specified by:

getRepositoryName in interface Dictionary

Returns:

name of dictionary

setRepositoryName

public void setRepositoryName(String name)

Description copied from interface: Dictionary

Set the name of the dictionary. In the future, this will be the name used in the repository, but currently repositories are not supported.

Specified by:

setRepositoryName in interface Dictionary

Parameters:

name - name of dictionary

getPath

public String getPath()

Description copied from interface: Dictionary

The path to the actual data dictionary on the server. This may not be available to client users.

Specified by:

getPath in interface Dictionary

Returns:

path to actual data

setPath

public void setPath(String path)

Description copied from interface: Dictionary

Path to the actual data dictionary. This has no effect on the actual location of the data.

Specified by:

setPath in interface Dictionary

Parameters:

path - path to actual data

getCountrySupportInformation

public Set<CountrySupport> getCountrySupportInformation()

Description copied from interface: Dictionary

Holds information on the quality of data for each supported country

Specified by:

getCountrySupportInformation in interface Dictionary

Returns:

country support information

setCountrySupportInformation

public void setCountrySupportInformation(Set<CountrySupport> countries)

Description copied from interface: Dictionary

Sets information on the quality of data for each supported country

Specified by:

setCountrySupportInformation in interface Dictionary

Parameters:

countries - set of country support information

getVintage

public String getVintage()

Description copied from interface: Dictionary

The vintage of the source data for this dictionary

Specified by:

getVintage in interface Dictionary

Returns:

vintage

setVintage

public void setVintage(String vintage)

Description copied from interface: Dictionary

Sets the vintage of the source data for this dictionary

Specified by:

setVintage in interface Dictionary

Parameters:

vintage - description of data vintage

getSource

public String getSource()

Description copied from interface: Dictionary

The source data vendor for this data

Specified by:

getSource in interface Dictionary

Returns:

data vendor name

setSource

public void setSource(String source)

Description copied from interface: Dictionary

Sets the source data vendor for this data

Specified by:

setSource in interface Dictionary

Parameters:

source - data vendor name

isCustomDictionary

public boolean isCustomDictionary()

Description copied from interface: Dictionary

True if this is a user created dictionary

Specified by:

isCustomDictionary in interface Dictionary

Returns:

true for user dictionary

setCustomDictionary

public void setCustomDictionary(boolean bCustom)

Description copied from interface: Dictionary

Set to true if this is a user created dictionary

Specified by:

setCustomDictionary in interface Dictionary

Parameters:

bCustom - true for user dictionary

getDescription

public String getDescription()

Description copied from interface: Dictionary

A description of the dictionary

Specified by:

getDescription in interface Dictionary

Returns:

dictionary description

setDescription

public void setDescription(String desc)

Description copied from interface: Dictionary

Sets a description of the dictionary

Specified by:

setDescription in interface Dictionary

Parameters:

desc - dictionary description string

getRegion

public String getRegion()

Description copied from interface: Dictionary

A region of the dictionary

Specified by:

getRegion in interface Dictionary

Returns:

dictionary region

setRegion

public void setRegion(String region)

Description copied from interface: Dictionary

Sets a region of the dictionary

Specified by:

setRegion in interface Dictionary

Parameters:

region - dictionary region string

getProduct

public String getProduct()

Description copied from interface: Dictionary

A product code associated with the data

Specified by:

getProduct in interface Dictionary

Returns:

productCode

setProduct

public void setProduct(String product)

Description copied from interface: Dictionary

Set productCode for the data

Specified by:

setProduct in interface Dictionary

Parameters:

product - a product code associated with data

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object