com.mapinfo.geocode.api

Class CandidateRangeUnit

java.lang.Object

com.mapinfo.geocode.api.CandidateRangeUnit

All Implemented Interfaces:

GeoSerialize, Serializable

public class CandidateRangeUnit
extends Object
implements GeoSerialize, Serializable

This class holds information about a candidate range's units. The units contain specific information that may be different from the Candidate or CandidateRange they are associated with.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CandidateRangeUnit()

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	convertToMap() Convert this object to a "map of maps" where each map is Map<String, Object>
Set<String>	getCustomFieldKeys() If the range has custom key-value pairs, returns the keys hat may be used to retrieve values
protected String	getCustomFieldValue(AdditionalFieldKeys key)
String	getCustomFieldValue(String key) Return an individual custom field value
Map<String,String>	getCustomValues() Returns a map of custom values.
String	getFormattedAddress() This returns the street and location information, correctly formatted for the country the candidate is coming from.
String	getHighUnitValue() Returns the high unit number for this range unit
String	getIdentifier() Returns an identifier for this candidate.
String	getLowUnitValue() Returns the low unit number for this range unit
String	getPlaceName() This method will return the place name, which may be different that the one on the Candidate it is associated with
String	getUnitType() Returns the type associated with this unit
void	setFormattedAddress(String formattedAddress)
void	setHighUnitValue(String highUnitValue)
void	setIdentifier(String identifier)
void	setLowUnitValue(String lowUnitValue)
void	setPlaceName(String placeName)
void	setUnitType(String unitType)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CandidateRangeUnit

public CandidateRangeUnit()

Method Detail

getPlaceName

public String getPlaceName()

This method will return the place name, which may be different that the one on the Candidate it is associated with

Returns:

the place name

setPlaceName

public void setPlaceName(String placeName)

getUnitType

public String getUnitType()

Returns the type associated with this unit

Returns:

String describing unit type.

setUnitType

public void setUnitType(String unitType)

getLowUnitValue

public String getLowUnitValue()

Returns the low unit number for this range unit

Returns:

low unit number

setLowUnitValue

public void setLowUnitValue(String lowUnitValue)

getHighUnitValue

public String getHighUnitValue()

Returns the high unit number for this range unit

Returns:

high unit number

setHighUnitValue

public void setHighUnitValue(String highUnitValue)

getCustomValues

public Map<String,String> getCustomValues()

Returns a map of custom values.

Returns:

map of custom values

getCustomFieldKeys

public Set<String> getCustomFieldKeys()

If the range has custom key-value pairs, returns the keys hat may be used to retrieve values

Returns:

set containing any custom keys

getCustomFieldValue

public String getCustomFieldValue(String key)

Return an individual custom field value

Parameters:

key - key of the custom field

Returns:

any value associated with the given key, or null if no value found

getCustomFieldValue

protected String getCustomFieldValue(AdditionalFieldKeys key)

getFormattedAddress

public String getFormattedAddress()

This returns the street and location information, correctly formatted for the country the candidate is coming from. For example, it might be "Troy NY 12180" in USA, or "Firenze 50123" in ITA.

Returns:

String describing fully formatted address

setFormattedAddress

public void setFormattedAddress(String formattedAddress)

getIdentifier

public String getIdentifier()

Returns an identifier for this candidate. For street or point level candidates, this is usually the segment ID.

Returns:

range identifier

setIdentifier

public void setIdentifier(String identifier)

toString

public String toString()

Overrides:

toString in class Object

convertToMap

public Map<String,Object> convertToMap()

Convert this object to a "map of maps" where each map is Map<String, Object>

Specified by:

convertToMap in interface GeoSerialize

Returns:

a map of the properties in this class, one entry of whnd a map containing a map of custom values