com.esri.arcgis.location
Interface ISingleLineAddressInput

All Superinterfaces:

Serializable

All Known Implementing Classes:

AGSAddressLocator, CompositeLocator, ESRIGen2AddressLocator, ESRIGen2AddressLocatorStyle, ISingleLineAddressInputProxy

public interface ISingleLineAddressInput
extends Serializable

Provides access to members for working with single line address information.

When To Use

Use the ISingleLineAddressInput interface to determine if a locator supports geocoding an address in a single line format. Address locators created in ArcGIS 10 support single line input geocoding.

Product Availability

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

Method Summary

Object	getDefaultInputFieldNames() Recognized names for the single line input field.
IField	getSingleLineAddressField() Field needed to geocode a single line address.

Method Detail

getSingleLineAddressField

IField getSingleLineAddressField()
                                 throws IOException,
                                        AutomationException

Field needed to geocode a single line address.

Remarks

The SingleLineAddressField property returns a Field object that specifies the field that the locator uses to geocode addresses in a single line format. The IField::Name property is the internal field name used by the locator.

You can use the Field returned by this property to determine which field in a table contains address information using the DefaultInputFieldNames property.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geodatabase.IField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultInputFieldNames

Object getDefaultInputFieldNames()
                                 throws IOException,
                                        AutomationException

Recognized names for the single line input field.

Remarks

The DefaultInputFieldNames property returns an Array of field names that you can use to determine which field in an address table contains the full address for single line geocoding.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.