com.esri.arcgis.location
Interface IAddressCandidates2

All Superinterfaces:
IAddressCandidates, Serializable
All Known Implementing Classes:
RSLocator

public interface IAddressCandidates2
extends IAddressCandidates, Serializable

Provides access to members for generating matching candidates for an address.

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 IAddressCandidates2 interface to find and inspect candidates for a single address.

Product Availability

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


Method Summary
 IArray findMatchingAddressCandidates(IPropertySet address)
          Generates candidates for an address, including only matching ones.
 
Methods inherited from interface com.esri.arcgis.location.IAddressCandidates
findAddressCandidates, getCandidateFields
 

Method Detail

findMatchingAddressCandidates

IArray findMatchingAddressCandidates(IPropertySet address)
                                     throws IOException,
                                            AutomationException
Generates candidates for an address, including only matching ones.

Remarks

The FindMatchingAddressCandidates method is similar to the FindAddressCandidates method, with the exception that FindMatchingAddressCandidates returns only candidates with scores greater than or equal to the minimum match score for the locator.

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.

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