com.mapinfo.geocode.api

Class CandidateRange

java.lang.Object

com.mapinfo.geocode.api.CandidateRange

All Implemented Interfaces:

GeoSerialize, Serializable

public class CandidateRange
extends Object
implements GeoSerialize, Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CandidateRange()

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	getHighHouse() This method gets the String of the highest house number on the range
String	getIdentifier() Returns an identifier for this candidate.
String	getLowHouse() This method gets the String of the lowest house number on the range
OddEvenIndicator	getOddEvenIndicator() Returns information on the house numbers on this range
String	getPlaceName() Returns the place name associated with this range, if any
StreetSideIndicator	getStreetSide() Returns which side of the street this range is on
List<CandidateRangeUnit>	getUnits() Returns a list containing any unit information associated with this range, if units were requested and they exist on the range
void	setFormattedAddress(String formattedAddress)
void	setHighHouse(String num)
void	setIdentifier(String identifier)
void	setLowHouse(String num)
void	setOddEvenIndicator(OddEvenIndicator oddEvenIndicator)
void	setPlaceName(String name)
void	setSide(StreetSideIndicator side)
void	setUnits(List<CandidateRangeUnit> units)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CandidateRange

public CandidateRange()

Method Detail

getPlaceName

public String getPlaceName()

Returns the place name associated with this range, if any

Returns:

The place name

setPlaceName

public void setPlaceName(String name)

getLowHouse

public String getLowHouse()

This method gets the String of the lowest house number on the range

Returns:

the lowest house number on this range

setLowHouse

public void setLowHouse(String num)

getHighHouse

public String getHighHouse()

This method gets the String of the highest house number on the range

Returns:

the highest house number on this range

setHighHouse

public void setHighHouse(String num)

getUnits

public List<CandidateRangeUnit> getUnits()

Returns a list containing any unit information associated with this range, if units were requested and they exist on the range

Returns:

list containing associated units.

setUnits

public void setUnits(List<CandidateRangeUnit> units)

getCustomValues

public Map<String,String> getCustomValues()

Returns a map of custom values.

Returns:

map of custom values

getOddEvenIndicator

public OddEvenIndicator getOddEvenIndicator()

Returns information on the house numbers on this range

Returns:

odd even status

setOddEvenIndicator

public void setOddEvenIndicator(OddEvenIndicator oddEvenIndicator)

getStreetSide

public StreetSideIndicator getStreetSide()

Returns which side of the street this range is on

Returns:

left right status

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)

setSide

public void setSide(StreetSideIndicator side)

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 which is a contained map containing a map of custom values