net.motionintelligence.client.api.response.esri

Class Candidate

java.lang.Object

net.motionintelligence.client.api.response.esri.Candidate

public class Candidate
extends Object

Geocoding candidate for a requested address. It is immutable with a private constructor since it is only meant to be created from a json object (as a REST response).

Method Summary

Modifier and Type	Method and Description
DefaultTargetCoordinate	getLocation() Returns the geocode as DefaultTargetCoordinate according to the spatial reference from the request.
double	getScore() Return the Score of the candidate.

Methods inherited from class java.lang.Object

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

Method Detail

getScore

public double getScore()

Return the Score of the candidate. The higher the score the more confidence into the candidate as the correct representative. Maximum score is 100.0; Minimum 0.0.

Returns:

the score of the candidate

getLocation

public DefaultTargetCoordinate getLocation()

Returns the geocode as DefaultTargetCoordinate according to the spatial reference from the request. Default reference is "EPSG 4326" (.i.e. if not otherwise specified)

Returns:

the geo location of the candidate