com.esri.arcgis.location
Interface IAddressInputs

All Superinterfaces:
Serializable
All Known Subinterfaces:
IGeocodingProperties
All Known Implementing Classes:
AGSAddressLocator, CompositeLocator, ESRIFDOAddressLocator, ESRIFDOAddressLocatorStyle, IAddressInputsProxy, IGeocodingPropertiesProxy, RSLocator, StreetMapAddressLocator, StreetMapAddressLocatorStyle

public interface IAddressInputs
extends Serializable

Provides access to members that specify fields for address tables.

When To Use

Use the IAddressInputs interface to examine the set of input fields used by the address locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
com.esri.arcgis.locationui.IAddressUI, com.esri.arcgis.locationui.ILocatorExtension, IAdvancedGeocoding.matchStandardizedAddress(com.esri.arcgis.system.IPropertySet), com.esri.arcgis.locationui.FindAddresses, IAddressGeocoding.matchTable(com.esri.arcgis.geodatabase.ITable, String, String, com.esri.arcgis.geodatabase.IFeatureClass, String, com.esri.arcgis.system.IPropertySet, com.esri.arcgis.system.ITrackCancel), com.esri.arcgis.locationui.AddressFindData, IAdvancedGeocoding.rematchTable(com.esri.arcgis.geodatabase.ITable, String, String, com.esri.arcgis.geodatabase.IFeatureClass, String, String, String, com.esri.arcgis.system.ITrackCancel), com.esri.arcgis.locationui.LocatorExtension, com.esri.arcgis.locationui.IAddressFindData, IAddressGeocoding.matchAddress(com.esri.arcgis.system.IPropertySet), ILocatorUI.matchTable(int, com.esri.arcgis.geodatabase.ITable, com.esri.arcgis.geodatabase.ILocator, String[]), IAddressGeocoding

Method Summary
 IFields getAddressFields()
          Fields needed to geocode a table of addresses.
 Object getDefaultInputFieldNames(String addressField)
          Recognized names for an input field.
 

Method Detail

getAddressFields

IFields getAddressFields()
                         throws IOException,
                                AutomationException
Fields needed to geocode a table of addresses.

Remarks

The AddressFields property returns a Fields object that specifies the fields that the locator uses to geocode addresses. The IField::Name property of each Field object in the collection is the internal field name used by the locator.

The IField::Required property of each Field indicates whether or not the locator requires this field to geocode addresses. Fields with a Required value of False are not required by the Locator, but may improve the match scores of the addresses.

You can use the Fields returned by this property to determine which fields in a table contain address information using the DefaultInputFieldNames property.

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.

getDefaultInputFieldNames

Object getDefaultInputFieldNames(String addressField)
                                 throws IOException,
                                        AutomationException
Recognized names for an input field.

Product Availability

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

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