com.esri.arcgis.location
Interface IAddressCandidates

All Superinterfaces:

Serializable

All Known Subinterfaces:

IAddressCandidates2

All Known Implementing Classes:

AGSAddressLocator, ESRIFDOAddressLocator, ESRIGen2AddressLocator, IAddressCandidates2Proxy, 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:

• From - The beginning of the address range.
• FromLeft - The beginning of the address range on the left side of the street.
• FromRight - The beginning of the address range on the right side of the street.
• HouseNum - The street number of the address.
• KeyField - The single field describing the address.
• LeftCity - The city on the left side of the street.
• LeftZip - The ZIP code on the left side of the street.
• LeftZone - The zone on the left side of the street.
• PreDir - The street prefix direction.
• PreType - The street prefix type.
• RightCity - The city on the right side of the street.
• RightZip - The ZIP code on the right side of the street.
• RightZone - The zone on the right side of the street.
• Score - A score between 0 and 100 that indicates how well a candidate matches an address. A score of 100 represents an exact match.
• Shape - The geometry of the match candidate.
• Side - For geocoding services that can match addresses to a particular side of a street, the side of the street on which the address matches the candidate. A value of "L" indicates the left side of the street, and a value of "R" indicates the left side of the street.
• State - The state.
• StreetName - The street name.
• StreetType - The street type.
• SufDir - The street suffix direction.
• To - The end of the address range.
• ToLeft - The end of the address range on the left side of the street.
• ToRight - The end of the address range on the right side of the street.
• Zip - The ZIP code.
• Zip4 - The last four digits of a ZIP+4 code.
• Zip4Low - The lowest four digit code of a ZIP+4 range.
• Zip4High - The highest four digit code of a ZIP+4 range.
• Zone - The zone.

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.

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