Package com.esri.arcgisruntime.tasks.geocode

Class LocatorInfo

java.lang.Object

com.esri.arcgisruntime.tasks.geocode.LocatorInfo

public final class LocatorInfo
extends Object

Holds information about a LocatorTask.

Since:

100.0.0

See Also:

LocatorTask

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the description of the LocatorTask.
List<LocatorAttribute>	getIntersectionResultAttributes()	Gets the attribute fields that can be returned in the results of geocode or reverse geocode operations when searching for street intersections.
String	getName()	Gets the name of the LocatorTask.
Map<String,String>	getProperties()	Gets the locator properties.
List<LocatorAttribute>	getResultAttributes()	Gets the attributes that can be returned in the results of geocode or reverse geocode operations.
List<LocatorAttribute>	getSearchAttributes()	Gets the search attributes that can be used as inputs to multi-line geocode operations.
SpatialReference	getSpatialReference()	Gets the default spatial reference.
String	getVersion()	Gets the version of the LocatorTask.
boolean	isSupportsAddresses()	Indicates if the LocatorTask supports geocoding of addresses (point addresses or street addresses).
boolean	isSupportsIntersections()	Indicates if the LocatorTask supports geocoding of intersections.
boolean	isSupportsPoi()	Indicates if the LocatorTask supports geocoding of Points Of Interest.
boolean	isSupportsSuggestions()	Indicates if the LocatorTask supports suggestions.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Gets the name of the LocatorTask.

Returns:

the name

Since:

100.0.0

getDescription

public String getDescription()

Gets the description of the LocatorTask.

Returns:

the description

Since:

100.0.0

getResultAttributes

public List<LocatorAttribute> getResultAttributes()

Gets the attributes that can be returned in the results of geocode or reverse geocode operations.

Returns:

an unmodifiable List of locator attributes

Since:

100.0.0

See Also:

GeocodeParameters.getResultAttributeNames(), ReverseGeocodeParameters.getResultAttributeNames(), GeocodeResult.getAttributes()

getIntersectionResultAttributes

public List<LocatorAttribute> getIntersectionResultAttributes()

Gets the attribute fields that can be returned in the results of geocode or reverse geocode operations when searching for street intersections.

Returns:

an unmodifiable List of locator attributes

Since:

100.0.0

See Also:

GeocodeParameters.getResultAttributeNames(), ReverseGeocodeParameters.getResultAttributeNames(), GeocodeResult.getAttributes()

getSearchAttributes

public List<LocatorAttribute> getSearchAttributes()

Gets the search attributes that can be used as inputs to multi-line geocode operations.

Returns:

an unmodifiable List of search attributes

Since:

100.0.0

See Also:

LocatorTask.geocodeAsync(Map), LocatorTask.geocodeAsync(Map, GeocodeParameters)

getProperties

public Map<String,String> getProperties()

Gets the locator properties. For example, MinimumCandidateScore, SideOffsetUnits, SpellingSensitivity, MinimumMatchScore and so on.

Returns:

an unmodifiable Map; the keys are Strings containing the names of the properties and the values are Strings containing the values of the properties

Since:

100.0.0

getSpatialReference

public SpatialReference getSpatialReference()

Gets the default spatial reference.

Returns:

the default spatial reference

Since:

100.0.0

isSupportsIntersections

public boolean isSupportsIntersections()

Indicates if the LocatorTask supports geocoding of intersections.

Returns:

true if it supports intersections

Since:

100.0.0

isSupportsSuggestions

public boolean isSupportsSuggestions()

Indicates if the LocatorTask supports suggestions.

Returns:

true if it supports suggestions

Since:

100.0.0

isSupportsPoi

public boolean isSupportsPoi()

Indicates if the LocatorTask supports geocoding of Points Of Interest.

Returns:

true if it supports Points Of Interest

Since:

100.0.0

isSupportsAddresses

public boolean isSupportsAddresses()

Indicates if the LocatorTask supports geocoding of addresses (point addresses or street addresses). If supported, these can be specified as x/y coordinate pairs in the search text for geocode operations, where the spatial reference of the coordinates is WGS84. For example:

 future = locatorTask.geocodeAsync("-115.172783,36.114789");
 

Returns:

true if it supports point or street addresses

Since:

100.0.0

getVersion

public String getVersion()

Gets the version of the LocatorTask.

Returns:

the version

Since:

100.0.0