com.esri.arcgis.location
Interface IDEAddressLocator

All Superinterfaces:
Serializable
All Known Implementing Classes:
DEAddressLocator

public interface IDEAddressLocator
extends Serializable

Provides access to members describing the address locator data element.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IFields getAddressFields()
          The set of address input fields used by the address locator.
 IDETable getAddressTable()
          Table of addresses to geocode using the locator.
 Object getDefaultInputFieldNames(String addressFieldName)
          Default input field names for the address field.
 IFields getMatchFields()
          Fields output by geocoding.
 boolean isLocatorPropsRetrieved()
          Indicates if the locator propertries been retrieved.
 void setAddressFieldsByRef(IFields addressFields)
          The set of address input fields used by the address locator.
 void setAddressTableByRef(IDETable addressTable)
          Table of addresses to geocode using the locator.
 void setDefaultInputFieldNames(String addressFieldName, Object defaultFieldNames)
          Default input field names for the address field.
 void setLocatorPropsRetrieved(boolean propsRetrieved)
          Indicates if the locator propertries been retrieved.
 void setMatchFieldsByRef(IFields matchFields)
          Fields output by geocoding.
 

Method Detail

getAddressFields

IFields getAddressFields()
                         throws IOException,
                                AutomationException
The set of address input fields used by the address locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAddressFieldsByRef

void setAddressFieldsByRef(IFields addressFields)
                           throws IOException,
                                  AutomationException
The set of address input fields used by the address locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
addressFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultInputFieldNames

Object getDefaultInputFieldNames(String addressFieldName)
                                 throws IOException,
                                        AutomationException
Default input field names for the address field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
addressFieldName - The addressFieldName (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultInputFieldNames

void setDefaultInputFieldNames(String addressFieldName,
                               Object defaultFieldNames)
                               throws IOException,
                                      AutomationException
Default input field names for the address field.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:
addressFieldName - The addressFieldName (in)
defaultFieldNames - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMatchFields

IFields getMatchFields()
                       throws IOException,
                              AutomationException
Fields output by geocoding.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMatchFieldsByRef

void setMatchFieldsByRef(IFields matchFields)
                         throws IOException,
                                AutomationException
Fields output by geocoding.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
matchFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAddressTable

IDETable getAddressTable()
                         throws IOException,
                                AutomationException
Table of addresses to geocode using the locator. Used for validiation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.IDETable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAddressTableByRef

void setAddressTableByRef(IDETable addressTable)
                          throws IOException,
                                 AutomationException
Table of addresses to geocode using the locator. Used for validiation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
addressTable - A reference to a com.esri.arcgis.geodatabase.IDETable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLocatorPropsRetrieved

boolean isLocatorPropsRetrieved()
                                throws IOException,
                                       AutomationException
Indicates if the locator propertries been retrieved.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The propsRetrieved
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocatorPropsRetrieved

void setLocatorPropsRetrieved(boolean propsRetrieved)
                              throws IOException,
                                     AutomationException
Indicates if the locator propertries been retrieved.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
propsRetrieved - The propsRetrieved (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.