Candidate (geocodingservices - geocoding-api 5.1.796 API)

java.lang.Object
- com.mapinfo.geocode.api.Candidate

All Implemented Interfaces:

GeoSerialize, Serializable
```
public class Candidate
extends Object
implements GeoSerialize, Serializable
```
A Candidate is a returned address with additional data from the geocoder, such as the location. Inside the Candidate's Address object are custom fields, which may no

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Address`	`address`
`protected String`	`formattedAddress`
`protected String`	`formattedLocationAddress`
`protected String`	`formattedStreetAddress`
`protected String`	`identifier`
`protected FieldsMatching`	`matchedFields`
`protected com.mapinfo.midev.geometry.IPoint`	`point`
`protected String`	`precisionCode`
`protected int`	`precisionLevel`
`protected List<CandidateRange>`	`ranges`
`static String`	`REVERSE_GEOCODE_DISTANCE`
`static String`	`REVERSE_GEOCODE_DISTANCE_UNIT`

Constructor Summary

Constructors
Constructor and Description

Candidate()

Constructors
Constructor and Description
`Candidate()`

Method Summary

All Methods Instance Methods Concrete Methods
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>
`boolean`	`equals(Object o)`
`Address`	`getAddress()`
`String`	`getAddressNumber()` Contains the house number information
`String`	`getAreaName1()` Contains the largest geographic division in an area, such as a state, province, or region
`String`	`getAreaName2()` Contains the secondary geographic division in an area, such as a county or district.
`String`	`getAreaName3()` Contains the city or town name
`String`	`getAreaName4()` Contains the smallest geographic division in an area, such as a city subdivision or locality
`String`	`getCoordinateSystemName()` Shortcut to provide information on the coordinate system projection of the candidate's location point
`String`	`getCountry()` The country of the address.
`Set<String>`	`getCustomFieldKeys()` The custom fields allow return of String key-value pairs.
`String`	`getCustomFieldValue(String key)` Allows retrieval of a custom field value
`String`	`getFormattedAddress()` This returns the street and location information, correctly formatted for the country the candidate is coming from.
`String`	`getFormattedLocationAddress()` This returns the location line information, correctly formatted for the country the candidate is coming from.
`String`	`getFormattedStreetAddress()` This returns the street line information, correctly formatted for the country the candidate is coming from.
`String`	`getIdentifier()` Returns an identifier for this candidate.
`FieldsMatching`	`getMatchedFields()` If requested in the input preference, this object will contain a description of what input fields matched this candidate.
`String`	`getPlaceName()` Represents the name of a business, building, or location.
`com.mapinfo.midev.geometry.IPoint`	`getPoint()` The point lists the actual coordinate value of the candidate being returned.
`String`	`getPostCode1()` Contains the main postal code.
`String`	`getPostCode2()` Contains the secondary postal code, if used.
`String`	`getPrecisionCode()` Returns the geocoder precisionLevel code.
`int`	`getPrecisionLevel()` This method will return an int representing the precisionLevel of the point returned by a call to getPoint().
`List<CandidateRange>`	`getRanges()` Returns requested candidate ranges, if any, ordered from closest to furthest.
`String`	`getSourceDictionary()` Returns the name of the source dictionary the candidate is from
`String`	`getStreetName()` Contains the street name, e.g., "West Main St".
`String`	`getUnitType()` Represents the unit type (such as "Apt" or "Suite") where appropriate
`String`	`getUnitValue()` Represents the unit value (e.g., "3B") where appropriate
`Double`	`getX()` Shortcut to provide the X value of the candidate's location point
`Double`	`getY()` Shortcut to provide the Y value of the candidate's location point
`int`	`hashCode()`
`void`	`setFormattedLocationAddress(String formattedLocationAddress)`
`void`	`setFormattedStreetAddress(String formattedStreetAddress)`
`void`	`setIdentifier(String identifier)`
`void`	`setPoint(com.mapinfo.midev.geometry.IPoint point)`
`void`	`setPrecisionCode(String precisionCode)`
`void`	`setPrecisionLevel(int precisionLevel)`
`void`	`setSourceDictionary(String sourceDictionary)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - REVERSE_GEOCODE_DISTANCE
```
public static final String REVERSE_GEOCODE_DISTANCE
```
    See Also:
    
    Constant Field Values
  - REVERSE_GEOCODE_DISTANCE_UNIT
```
public static final String REVERSE_GEOCODE_DISTANCE_UNIT
```
    See Also:
    
    Constant Field Values
  - address
```
protected final Address address
```
  - ranges
```
protected final List<CandidateRange> ranges
```
  - formattedStreetAddress
```
protected String formattedStreetAddress
```
  - formattedLocationAddress
```
protected String formattedLocationAddress
```
  - point
```
protected com.mapinfo.midev.geometry.IPoint point
```
  - identifier
```
protected String identifier
```
  - formattedAddress
```
protected String formattedAddress
```
  - precisionCode
```
protected String precisionCode
```
  - precisionLevel
```
protected int precisionLevel
```
  - matchedFields
```
protected FieldsMatching matchedFields
```
- Constructor Detail
  - Candidate
```
public Candidate()
```
- Method Detail
  - getFormattedStreetAddress
```
public String getFormattedStreetAddress()
```
    This returns the street line information, correctly formatted for the country the candidate is coming from. For example, it might be "123 Main St" in USA, or "Via Garibaldi 27" in ITA.
    
    Returns:
    
    String describing the main address line
  - setFormattedStreetAddress
```
public void setFormattedStreetAddress(String formattedStreetAddress)
```
  - getFormattedLocationAddress
```
public String getFormattedLocationAddress()
```
    This returns the location line 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 the address lastline information.
  - setFormattedLocationAddress
```
public void setFormattedLocationAddress(String formattedLocationAddress)
```
  - getPlaceName
```
public String getPlaceName()
```
    Represents the name of a business, building, or location.
    
    Returns:
    
    String representing place name.
  - getAreaName1
```
public String getAreaName1()
```
    Contains the largest geographic division in an area, such as a state, province, or region
    
    Returns:
    
    String representing largest geographic division of a country
  - getAreaName2
```
public String getAreaName2()
```
    Contains the secondary geographic division in an area, such as a county or district.
    
    Returns:
    
    String representing secondary geographic division of a country
  - getAreaName3
```
public String getAreaName3()
```
    Contains the city or town name
    
    Returns:
    
    String representing city or town name
  - getAreaName4
```
public String getAreaName4()
```
    Contains the smallest geographic division in an area, such as a city subdivision or locality
    
    Returns:
    
    String representing smallest geographic division of a country
  - getPostCode1
```
public String getPostCode1()
```
    Contains the main postal code.
    
    Returns:
    
    String representing main postal code
  - getPostCode2
```
public String getPostCode2()
```
    Contains the secondary postal code, if used. An example of a secondary postal code is the optional "plus 4" 4 digit extension to the USA 5 digit main postal code.
    
    Returns:
    
    String representing main postal code
  - getCountry
```
public String getCountry()
```
    The country of the address. This is represented by the ISO-3166 3 character abbreviation for the country
    
    Returns:
    
    String representing country
  - getAddressNumber
```
public String getAddressNumber()
```
    Contains the house number information
    
    Returns:
    
    String representing house number
  - getStreetName
```
public String getStreetName()
```
    Contains the street name, e.g., "West Main St".
    
    Returns:
    
    String representing the street name
  - getUnitType
```
public String getUnitType()
```
    Represents the unit type (such as "Apt" or "Suite") where appropriate
    
    Returns:
    
    String representing the unit type
  - getUnitValue
```
public String getUnitValue()
```
    Represents the unit value (e.g., "3B") where appropriate
    
    Returns:
    
    String representing the unit value
  - getCustomFieldKeys
```
public Set<String> getCustomFieldKeys()
```
    The custom fields allow return of String key-value pairs. The custom fields depend on what geocoder is used
    
    Returns:
    
    Set of custom keys used for retrieving custom information
  - getCustomFieldValue
```
public String getCustomFieldValue(String key)
```
    Allows retrieval of a custom field value
    
    Parameters:
    
    key - key for this field
    
    Returns:
    
    custom value if found, else null
  - getPoint
```
public com.mapinfo.midev.geometry.IPoint getPoint()
```
    The point lists the actual coordinate value of the candidate being returned. Refer to the precisionLevel code to determine if this represents an address point, an interpolated street value, or a centroid.
    
    Returns:
    
    location of this candidate
  - setPoint
```
public void setPoint(com.mapinfo.midev.geometry.IPoint point)
```
  - getIdentifier
```
public String getIdentifier()
```
    Returns an identifier for this candidate. For street or point level candidates, this is usually the segment ID.
    
    Returns:
    
    candidate identifier
  - setIdentifier
```
public void setIdentifier(String identifier)
```
  - 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
  - getPrecisionCode
```
public String getPrecisionCode()
```
    Returns the geocoder precisionLevel code.
    The format of the geocode result string is match_category [additional_match_information]. Possible match categories are:
    - Z1 = point located at postal centroid of post code 1
    - Z2 = point located at postal centroid of partial post code 2
    - Z3 = point located at postal centroid of post code 2
    - G1 = point located at geographic area name 1 centroid
    - G2 = point located at geographic area name 2 centroid
    - G3 = point located at geographic area name 3 centroid
    - G4 = point located at geographic area name 4 centroid
    - SX = point located at street intersection (no further street information returned)
    - S* = additional match information to follow.
    For the street locations with additional match information, the following categories exist:
    - SC = point house precision projected from nearest segment
    - S8 = point house precision
    - S7 = street address interpolated between point house locations
    - S5 = point located at street address
    - S4 = point located at street centroid
    - S0 = no coordinates are available, but parts of the address may have matched source data
    The additional match information will be of the format HPNTSCZA. If a match did not occur for the specified component a dash (-) will appear in place of the letter. Possible components are:
    - H = House Number
    - P = Street Prefix direction
    - N = Street Name
    - T = Street Type
    - S = Street Suffix direction
    - C = Town Name
    - Z = Postcode
    - A = Dictionary type. (A for address dictionary, U for user dictionary)
    Returns:
    
    precisionLevel code as described above
  - setPrecisionCode
```
public void setPrecisionCode(String precisionCode)
```
  - getSourceDictionary
```
public String getSourceDictionary()
```
    Returns the name of the source dictionary the candidate is from
    
    Returns:
    
    name of dictionary
  - setSourceDictionary
```
public void setSourceDictionary(String sourceDictionary)
```
  - getPrecisionLevel
```
public int getPrecisionLevel()
```
    This method will return an int representing the precisionLevel of the point returned by a call to getPoint().
    
    Returns:
    
    an int representing the precisionLevel of the CandidateAddress's point
  - setPrecisionLevel
```
public void setPrecisionLevel(int precisionLevel)
```
  - getMatchedFields
```
public FieldsMatching getMatchedFields()
```
    If requested in the input preference, this object will contain a description of what input fields matched this candidate. If matching information was not requested it will return null.
    
    Returns:
    
    requested match description or null
  - getRanges
```
public List<CandidateRange> getRanges()
```
    Returns requested candidate ranges, if any, ordered from closest to furthest.
    
    Returns:
    
    list of candidate ranges
  - getAddress
```
public Address getAddress()
```
  - 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
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getX
```
public Double getX()
```
    Shortcut to provide the X value of the candidate's location point
    
    Returns:
    
    double representing the X value of the candidate's location point
  - getY
```
public Double getY()
```
    Shortcut to provide the Y value of the candidate's location point
    
    Returns:
    
    double representing the Y value of the candidate's location point
  - getCoordinateSystemName
```
public String getCoordinateSystemName()
```
    Shortcut to provide information on the coordinate system projection of the candidate's location point
    
    Returns:
    
    name of the coordinate system in "codespace:code" format
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Candidate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REVERSE_GEOCODE_DISTANCE

REVERSE_GEOCODE_DISTANCE_UNIT

address

ranges

formattedStreetAddress

formattedLocationAddress

point

identifier

formattedAddress

precisionCode

precisionLevel

matchedFields

Constructor Detail

Candidate

Method Detail

getFormattedStreetAddress

setFormattedStreetAddress

getFormattedLocationAddress

setFormattedLocationAddress

getPlaceName

getAreaName1

getAreaName2

getAreaName3

getAreaName4

getPostCode1

getPostCode2

getCountry

getAddressNumber

getStreetName

getUnitType

getUnitValue

getCustomFieldKeys

getCustomFieldValue

getPoint

setPoint

getIdentifier

setIdentifier

getFormattedAddress

getPrecisionCode

setPrecisionCode

getSourceDictionary

setSourceDictionary

getPrecisionLevel

setPrecisionLevel

getMatchedFields

getRanges

getAddress

convertToMap

toString

getX

getY

getCoordinateSystemName

equals

hashCode