com.esri.core.tasks.ags.geocode
Class LocatorServiceInfo

java.lang.Object
  com.esri.core.tasks.ags.geocode.LocatorServiceInfo

public class LocatorServiceInfo
extends Object

Class containing the information for a ArcGIS Geocode service. It contains notably the address fields the service expects to successfully geocode an address.

Constructor Summary

LocatorServiceInfo()

Method Summary

static LocatorServiceInfo	fromJson(org.codehaus.jackson.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() Gets single-line address field.
SpatialReference	getSpatialReference() Returns the default spatial reference defined for the Geocode service.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LocatorServiceInfo

public LocatorServiceInfo()

Method Detail

getServiceDescription

public String getServiceDescription()

Returns the description of the service, if any.

Returns:

the description of the service.

getAddressFields

public List<LocatorFieldInfo> getAddressFields()

Returns the address fields defined for the Geocode service.

Returns:

address fields

getSingleLineAddressField

public LocatorFieldInfo getSingleLineAddressField()

Gets single-line address field.

Returns:

single-line address field.

getCandidateFields

public List<LocatorFieldInfo> getCandidateFields()

Returns the candidate fields defined for the Geocode service.

Returns:

candidate fields.

getIntersectionCandidateFields

public List<LocatorFieldInfo> getIntersectionCandidateFields()

Gets the intersection candidate fields.

Returns:

intersection candidate fields.

getSpatialReference

public SpatialReference getSpatialReference()

Returns the default spatial reference defined for the Geocode service.

Returns:

spatial reference.

getLocatorProperties

public Map<String,String> getLocatorProperties()

Returns the properties defined for the Geocode service.

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

Returns:

The properties of the Geocode service.

fromJson

public static LocatorServiceInfo fromJson(org.codehaus.jackson.JsonParser parser)
                                   throws Exception

Parses the JSON representation pointed by JsonParser into a LocatorServiceInfo object

Parameters:

parser - JsonParser pointing to a Json string representation of LocatorServiceInfo.

Returns:

LocatorServiceInfo object.

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object