java.lang.Object
com.esri.arcgisruntime.tasks.geocode.GeocodeResult
A match candidate returned from a
LocatorTask
geocode or reverse geocode operation.
GeocodeResult
provides information about the candidate, such as a collection of requested attribute
values, user-friendly label text, and locations suited for accurate match display or for routing input.
- Since:
- 100.0.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionGets a collection of attributes as requested byGeocodeParameters.getResultAttributeNames()
orReverseGeocodeParameters.getResultAttributeNames()
.Gets the location of the candidate suitable for display on a map.Gets an extent suitable for zooming the map to display the candidate.ThePoint
provided as input toLocatorTask.reverseGeocodeAsync(Point)
.getLabel()
Gets a user-friendly text that describes this result.Gets the nearest street location for the result.double
getScore()
Gets a value that indicates how well the address was matched.
-
Method Details
-
getAttributes
Gets a collection of attributes as requested byGeocodeParameters.getResultAttributeNames()
orReverseGeocodeParameters.getResultAttributeNames()
.Available attributes depend on the data stored with the locator, and can include things like place, name, URL, phone number, and so on.
- Returns:
- an unmodifiable Map; the keys are Strings containing the names of the attributes and the values are Objects containing the values of the attributes
- Since:
- 100.0.0
-
getExtent
Gets an extent suitable for zooming the map to display the candidate.- Returns:
- an Envelope describing the extent
- Since:
- 100.0.0
-
getLabel
Gets a user-friendly text that describes this result.- Returns:
- a formatted address string
- Since:
- 100.0.0
-
getDisplayLocation
Gets the location of the candidate suitable for display on a map. For example, this may provide a more precise rooftop location of a house, whereasgetRouteLocation()
represents the nearest street location.- Returns:
- the display location
- Since:
- 100.0.0
-
getInputLocation
ThePoint
provided as input toLocatorTask.reverseGeocodeAsync(Point)
. Only applicable for results of reverse-geocode operations.- Returns:
- the input location
- Since:
- 100.0.0
-
getRouteLocation
Gets the nearest street location for the result. Use this location if you want to use the candidate as a stop in a route. For example,getDisplayLocation()
provide a more precise rooftop location of a house, whereasgetRouteLocation()
will provide the nearest street location.- Returns:
- the route location
- Since:
- 100.0.0
-
getScore
public double getScore()Gets a value that indicates how well the address was matched. The score is in the range between 0 (no match) and 100 (perfect match).- Returns:
- a match score value in the range [0..100]
- Since:
- 100.0.0
-