public class

LocatorServiceInfo

extends Object
java.lang.Object
   ↳ com.esri.core.tasks.geocode.LocatorServiceInfo

Class Overview

Class containing the information for a Locator, either an online locator created from an ArcGIS geocode service, or a local locator created from local data. It contains notably the address fields the service expects to successfully geocode an address, and the single-line geocoding field, if the locator supports single-line geocoding.

See also:

Summary

Public Constructors
LocatorServiceInfo()
Public Methods
static LocatorServiceInfo fromJson(JsonParser parser)
Parses the JSON representation pointed by JsonParser into a LocatorServiceInfo object
List<LocatorFieldInfo> getAddressFields()
Returns the address fields defined for the Geocode service.
List<LocatorFieldInfo> getCandidateFields()
Returns the candidate fields defined for the Geocode service.
List<LocatorFieldInfo> getIntersectionCandidateFields()
Gets the intersection candidate fields.
Map<String, String> getLocatorProperties()

Returns the properties defined for the Geocode service.

String getServiceDescription()
Returns the description of the service, if any.
LocatorFieldInfo getSingleLineAddressField()
Returns the single-line address field, or null if the service does not support single-line geocoding.
SpatialReference getSpatialReference()
Returns the default spatial reference defined for the Geocode service.
String toString()
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public LocatorServiceInfo ()

Public Methods

public static LocatorServiceInfo fromJson (JsonParser parser)

Parses the JSON representation pointed by JsonParser into a LocatorServiceInfo object

Parameters
parser JsonParser: JsonParser pointing to a JSON string representation of LocatorServiceInfo.
Returns
LocatorServiceInfo LocatorServiceInfo object.
Throws
Exception the exception

public List<LocatorFieldInfo> getAddressFields ()

Returns the address fields defined for the Geocode service.

Returns
List<LocatorFieldInfo> address fields

public List<LocatorFieldInfo> getCandidateFields ()

Returns the candidate fields defined for the Geocode service.

Returns
List<LocatorFieldInfo> candidate fields.

public List<LocatorFieldInfo> getIntersectionCandidateFields ()

Gets the intersection candidate fields.

Returns
List<LocatorFieldInfo> intersection candidate fields.

public Map<String, String> getLocatorProperties ()

Returns the properties defined for the Geocode service.

e.g.: MinimumCandidateScore, SideOffsetUnits, SpellingSensitivity, MinimumMatchScore, ...

Returns
Map<String, String> The properties of the Geocode service.

public String getServiceDescription ()

Returns the description of the service, if any.

Returns
String the description of the service.

public LocatorFieldInfo getSingleLineAddressField ()

Returns the single-line address field, or null if the service does not support single-line geocoding.

Returns
LocatorFieldInfo single-line address field.

public SpatialReference getSpatialReference ()

Returns the default spatial reference defined for the Geocode service.

Returns
SpatialReference spatial reference.

public String toString ()

Returns
String