public class

LocatorGeocodeParameters

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

Class Overview

Class holding the parameters to support the findAddressCandidates operation for a geocoding service or local locator. The findAddressCandidates operation is used for multi field geocoding, for example:

Street Address:

  • Field : Value
  • Address : 380 New York St.
  • City : Redlands
  • Region : CA
  • Postal : 92373

Summary

Public Constructors
LocatorGeocodeParameters()
Default constructor.
Public Methods
Map<String, String> getAddressFields()
Gets the multi-field address pairs.
SpatialReference getInSR()
Gets the input spatial reference, as set by setSearchExtent(Envelope, SpatialReference).
List<String> getOutFields()
Gets the output fields.
SpatialReference getOutSR()
Gets the output spatial reference.
Envelope getSearchExtent()
Gets the search extent used to spatially filter the results.
void setAddressFields(Map<String, String> addressFields)
Sets the multi-field address pairs.
void setOutFields(List<String> outputFields)
Sets the output fields.
void setOutSR(SpatialReference outputSpatialReference)
Sets the output spatial reference of the returned candidates.
void setSearchExtent(Envelope searchExtent, SpatialReference inputSpatialReference)
Sets the search extent to spatially filter the search results.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public LocatorGeocodeParameters ()

Default constructor.

Public Methods

public Map<String, String> getAddressFields ()

Gets the multi-field address pairs.

Returns
Map<String, String> the list of <key,value> address pairs

public SpatialReference getInSR ()

Gets the input spatial reference, as set by setSearchExtent(Envelope, SpatialReference).

Returns
SpatialReference the input spatial reference

public List<String> getOutFields ()

Gets the output fields.

Returns
List<String> the list of output fields

public SpatialReference getOutSR ()

Gets the output spatial reference.

Returns
SpatialReference the output spatial reference

public Envelope getSearchExtent ()

Gets the search extent used to spatially filter the results.

Returns
Envelope the search extent

public void setAddressFields (Map<String, String> addressFields)

Sets the multi-field address pairs.

Parameters
addressFields Map: the list of <key,value> address pairs

public void setOutFields (List<String> outputFields)

Sets the output fields. If null or empty, no output fields will be returned on the result. Pass a list with an asterisk ("*") to return all output fields. Output fields do not affect the score, geometry, or address returned on each LocatorGeocodeResult.

Parameters
outputFields List: the list of output fields

public void setOutSR (SpatialReference outputSpatialReference)

Sets the output spatial reference of the returned candidates. If null, candidates will be returned in the default spatial reference of the service / local data.

Parameters
outputSpatialReference SpatialReference: the desired output spatial reference for the geometries of the geocoding results

public void setSearchExtent (Envelope searchExtent, SpatialReference inputSpatialReference)

Sets the search extent to spatially filter the search results. All results outside of the search extent will not be returned.

Parameters
searchExtent Envelope: the envelope (xmin, ymin, xmax, ymax) to be used to filter results
inputSpatialReference SpatialReference: the spatial reference of the search envelope