com.esri.arcgis.arcweb
Class ArcWebAddressFinder

java.lang.Object
  extended by com.esri.arcgis.arcweb.ArcWebAddressFinder
All Implemented Interfaces:
IArcWebAddressFinder, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArcWebAddressFinder
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebAddressFinder

A description of the address used for geocoding or reverse geocoding.

Description

ArcWebAddressFinder provides geocoding and reverse geocoding for your Internet applications. You can use ArcWebAddressFinder to input a street address, phone number, or IP address and receive a candidate list and associated x,y coordinates. You can also use this object to input x,y coordinates and receive a street address.

ArcWebAddressFinder allows you to perform the following functions:

For successful address matching (also called geocoding) at the house-level, the address must contain a certain combination of fields.

Possible combinations for successful geocoding are:

Note: European geocoding doesn't use the State/Province field, but does require the Country field.

Geocoding costs

Each address you attempt to geocode costs the credit charge for the address data source you use.

Partial address support

Partial address support means that if you do not provide the complete address, you can still get a list of candidates based on the information you have entered. For example, if you only enter a city name, the result list contains cities whose name matches the name you entered. Address Finder can perform four levels of geocoding, with levels 3 and 4 representing partial address geocoding.

Level 1: House-level geocoding, returning the x, y coordinates of a complete address, such as 380 New York St, Redlands, CA 92373

Level 2: Intersection geocoding, returning the x,y of the intersection of two cross streets, such as
New York St AT Pine Ave, Redlands, CA 92373

Level 3: Street-level geocoding, returning the centroids of each street segment and area, such as 100-200 New York St, 92373 or New York St, 92373

Level 4: Place-level geocoding, returning the centroid of the place, such as Redlands, CA.

To turn on partial address support, first use the method ArcWenAddressFinder.GetDataSourceInfo to see which data sources support partial addresses, then set the object parameter ArcWebAddressFinderOptions.partialAddress.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ArcWebAddressFinder()
          Constructs a ArcWebAddressFinder using ArcGIS Engine.
ArcWebAddressFinder(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebAddressFinder theArcWebAddressFinder = (ArcWebAddressFinder) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 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.
static String getClsid()
          getClsid.
 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.
 int hashCode()
          the hashcode for this object
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ArcWebAddressFinder

public ArcWebAddressFinder()
                    throws IOException,
                           UnknownHostException
Constructs a ArcWebAddressFinder using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ArcWebAddressFinder

public ArcWebAddressFinder(Object obj)
                    throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebAddressFinder theArcWebAddressFinder = (ArcWebAddressFinder) obj;

Construct a ArcWebAddressFinder using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcWebAddressFinder.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getDataSourceInfo

public 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.

Specified by:
getDataSourceInfo in interface IArcWebAddressFinder
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

public 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.

Specified by:
findLocationByAddress in interface IArcWebAddressFinder
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

public 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.

Specified by:
findLocationsByAddress in interface IArcWebAddressFinder
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

public 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.

Specified by:
findAddressByPoint in interface IArcWebAddressFinder
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

public 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.

Specified by:
findLocationByPhoneNumber in interface IArcWebAddressFinder
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

public 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.

Specified by:
findLocationByIPAddress in interface IArcWebAddressFinder
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

public 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.

Specified by:
getSupportedDataSources in interface IArcWebAddressFinder
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.