com.esri.arcgis.arcweb
Class ArcWebAddressFinderInfo

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

public class ArcWebAddressFinderInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebAddressFinderInfo

The information describing an ArcWebAddressFinder.

Description

Output from Address Finder GetDataSourceInfo method. Contains requested information about a geocoding data source, including the countries supported, if teh datasource supports extended postal codes, partial addresses, reverse geocoding and snaptypes.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ArcWebAddressFinderInfo(Object obj)
          Construct a ArcWebAddressFinderInfo using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 IEnumArcWebCountry getCountries()
          An enumerator of countries supported by the data source.
 String getDataSource()
          The name of the data source used for geocoding.
 int hashCode()
          the hashcode for this object
 boolean isExtendedPostalCode()
          Indicates if extended postal codes (for example, zip + 4) are supported by the data source.
 boolean isPartialAddress()
          Indicates if partial addresses are supported by the data source.
 boolean isReverseGeocode()
          Indicates if reverse geocoding is supported by the data source.
 
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

ArcWebAddressFinderInfo

public ArcWebAddressFinderInfo(Object obj)
                        throws IOException
Construct a ArcWebAddressFinderInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcWebAddressFinderInfo.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ArcWebAddressFinderInfo o = (ArcWebAddressFinderInfo)obj; // will not work

ArcWebAddressFinderInfo o = new ArcWebAddressFinderInfo(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems ArcWebAddressFinderInfo theArcWebAddressFinderInfo = (ArcWebAddressFinderInfo) obj;
Method Detail

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

getDataSource

public String getDataSource()
                     throws IOException,
                            AutomationException
The name of the data source used for geocoding.

Product Availability

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

Specified by:
getDataSource in interface IArcWebAddressFinderInfo
Returns:
The dataSource
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExtendedPostalCode

public boolean isExtendedPostalCode()
                             throws IOException,
                                    AutomationException
Indicates if extended postal codes (for example, zip + 4) are supported by the data source.

Product Availability

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

Specified by:
isExtendedPostalCode in interface IArcWebAddressFinderInfo
Returns:
The extendedPostalCode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPartialAddress

public boolean isPartialAddress()
                         throws IOException,
                                AutomationException
Indicates if partial addresses are supported by the data source.

Product Availability

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

Specified by:
isPartialAddress in interface IArcWebAddressFinderInfo
Returns:
The partialAddress
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReverseGeocode

public boolean isReverseGeocode()
                         throws IOException,
                                AutomationException
Indicates if reverse geocoding is supported by the data source.

Product Availability

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

Specified by:
isReverseGeocode in interface IArcWebAddressFinderInfo
Returns:
The reverseGeocode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCountries

public IEnumArcWebCountry getCountries()
                                throws IOException,
                                       AutomationException
An enumerator of countries supported by the data source.

Product Availability

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

Specified by:
getCountries in interface IArcWebAddressFinderInfo
Returns:
A reference to a com.esri.arcgis.arcweb.IEnumArcWebCountry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.