com.esri.arcgis.location
Interface IAddressCandidates

All Superinterfaces:
Serializable
All Known Subinterfaces:
IAddressCandidates2
All Known Implementing Classes:
AGSAddressLocator, ESRIFDOAddressLocator, IAddressCandidatesProxy, RSLocator, StreetMapAddressLocator

public interface IAddressCandidates
extends Serializable

Provides access to members for generating candidates for an address.

Superseded By

IAddressCandidates2

Remarks

Address candidates are defined by a number of candidate fields. Each candidate field describes some part of the address information for the match candidate. An address locator uses these candidate fields to determine how well a candidate matches an address. The candidate fields that are generated by the address locator styles provided with ArcGIS are described below:

When To Use

Use the IAddressCandidates interface to find and inspect candidates for a single address.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IAddressCandidates

Method Summary
 IArray findAddressCandidates(IPropertySet address)
          Generates candidates for an address.
 IFields getCandidateFields()
          Fields contained in a list of candidates.
 

Method Detail

getCandidateFields

IFields getCandidateFields()
                           throws IOException,
                                  AutomationException
Fields contained in a list of candidates.

Remarks

When an address locator generates a set of match candidates for an address, the candidates are described by a certain set of candidate fields. Each style of address locator has its own set of candidate fields.

You can use the fields returned by this property to inspect candidates found using the FindAddressCandidates method.

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.
See Also:
IAddressCandidates

findAddressCandidates

IArray findAddressCandidates(IPropertySet address)
                             throws IOException,
                                    AutomationException
Generates candidates for an address.

Remarks

The address parameter is a PropertySet that contains one property for each of the address fields defined by the address locator. You can use the IAddressInputs::AddressFields method to get the address fields for a address locator.

This method returns an Array of PropertySets. Each PropertySet in the Array has properties specified by the CandidateFields property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
address - A reference to a com.esri.arcgis.system.IPropertySet (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
IAddressCandidates