com.esri.arcgis.arcweb
Interface IArcWebAddressFinder

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArcWebAddressFinder

public interface IArcWebAddressFinder
extends Serializable

Provides access to members that support address finding using both geocoding and reverse geocoding.

Product Availability

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


Method Summary
 IArcWebAddress findAddressByPoint(IPoint point, IArcWebAddressFinderOptions addressFinderOptions, ITrackCancel cancelTracker)
          Returns an address for an x,y coordinate.
 IArcWebLocationInfo findLocationByAddress(IArcWebAddress arcWebAddress, IArcWebAddressFinderOptions addressFinderOptions, ITrackCancel cancelTracker)
          Returns location information related to a specific address.
 IArcWebLocationInfo findLocationByIPAddress(String iPAddress, IArcWebAddressFinderOptions addressFinderOptions, ITrackCancel cancelTracker)
          Returns location information for an IP address.
 IArcWebLocationInfo findLocationByPhoneNumber(String phoneNumber, IArcWebAddressFinderOptions addressFinderOptions, ITrackCancel cancelTracker)
          Returns location information for a phone number.
 IEnumArcWebLocationInfo findLocationsByAddress(ITable addressTable, IArcWebAddressFinderMapping fieldMapping, IArcWebAddressFinderOptions addressFinderOptions, ITrackCancel cancelTracker)
          Returns location information related to several addresses.
 IEnumArcWebAddressFinderInfo getDataSourceInfo(IEnumArcWebDataSourceInfo dataSourceInfo, ITrackCancel cancelTracker)
          Gets information about geocoding data sources.
 IEnumArcWebDataSourceInfo getSupportedDataSources(ITrackCancel pCancelTracker)
          Gets the data sources information that can support this service.
 

Method Detail

getDataSourceInfo

IEnumArcWebAddressFinderInfo getDataSourceInfo(IEnumArcWebDataSourceInfo dataSourceInfo,
                                               ITrackCancel cancelTracker)
                                               throws IOException,
                                                      AutomationException
Gets information about geocoding data sources.

Product Availability

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

Parameters:
dataSourceInfo - A reference to a com.esri.arcgis.arcweb.IEnumArcWebDataSourceInfo (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.arcweb.IEnumArcWebAddressFinderInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findLocationByAddress

IArcWebLocationInfo findLocationByAddress(IArcWebAddress arcWebAddress,
                                          IArcWebAddressFinderOptions addressFinderOptions,
                                          ITrackCancel cancelTracker)
                                          throws IOException,
                                                 AutomationException
Returns location information related to a specific address.

Product Availability

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

Parameters:
arcWebAddress - A reference to a com.esri.arcgis.arcweb.IArcWebAddress (in)
addressFinderOptions - A reference to a com.esri.arcgis.arcweb.IArcWebAddressFinderOptions (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.arcweb.IArcWebLocationInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findLocationsByAddress

IEnumArcWebLocationInfo findLocationsByAddress(ITable addressTable,
                                               IArcWebAddressFinderMapping fieldMapping,
                                               IArcWebAddressFinderOptions addressFinderOptions,
                                               ITrackCancel cancelTracker)
                                               throws IOException,
                                                      AutomationException
Returns location information related to several addresses.

Product Availability

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

Parameters:
addressTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
fieldMapping - A reference to a com.esri.arcgis.arcweb.IArcWebAddressFinderMapping (in)
addressFinderOptions - A reference to a com.esri.arcgis.arcweb.IArcWebAddressFinderOptions (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.arcweb.IEnumArcWebLocationInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findAddressByPoint

IArcWebAddress findAddressByPoint(IPoint point,
                                  IArcWebAddressFinderOptions addressFinderOptions,
                                  ITrackCancel cancelTracker)
                                  throws IOException,
                                         AutomationException
Returns an address for an x,y coordinate.

Product Availability

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

Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
addressFinderOptions - A reference to a com.esri.arcgis.arcweb.IArcWebAddressFinderOptions (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.arcweb.IArcWebAddress
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findLocationByPhoneNumber

IArcWebLocationInfo findLocationByPhoneNumber(String phoneNumber,
                                              IArcWebAddressFinderOptions addressFinderOptions,
                                              ITrackCancel cancelTracker)
                                              throws IOException,
                                                     AutomationException
Returns location information for a phone number.

Product Availability

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

Parameters:
phoneNumber - The phoneNumber (in)
addressFinderOptions - A reference to a com.esri.arcgis.arcweb.IArcWebAddressFinderOptions (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.arcweb.IArcWebLocationInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findLocationByIPAddress

IArcWebLocationInfo findLocationByIPAddress(String iPAddress,
                                            IArcWebAddressFinderOptions addressFinderOptions,
                                            ITrackCancel cancelTracker)
                                            throws IOException,
                                                   AutomationException
Returns location information for an IP address.

Product Availability

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

Parameters:
iPAddress - The iPAddress (in)
addressFinderOptions - A reference to a com.esri.arcgis.arcweb.IArcWebAddressFinderOptions (in)
cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.arcweb.IArcWebLocationInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSupportedDataSources

IEnumArcWebDataSourceInfo getSupportedDataSources(ITrackCancel pCancelTracker)
                                                  throws IOException,
                                                         AutomationException
Gets the data sources information that can support this service.

Product Availability

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

Parameters:
pCancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.arcweb.IEnumArcWebDataSourceInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.