com.esri.arcgis.arcweb
Class ArcWebAddressFinderOptions

java.lang.Object
  com.esri.arcgis.arcweb.ArcWebAddressFinderOptions

All Implemented Interfaces:

IArcWebAddressFinderOptions, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArcWebAddressFinderOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebAddressFinderOptions

A set of parameters used in finding an address.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ArcWebAddressFinderOptions()
Constructs a ArcWebAddressFinderOptions using ArcGIS Engine.

ArcWebAddressFinderOptions(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebAddressFinderOptions theArcWebAddressFinderOptions = (ArcWebAddressFinderOptions) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getCount() The number of records that are returned in the results (default is 20).
String	getDataSource() The name of the data source to use for geocoding.
int	getSnapType() The snap type to be used with the method FindAddressByPoint.
int	getStartIndex() The number of records to skip in the query.
int	hashCode() the hashcode for this object
boolean	isExtendedPostalCode() Indicates if extended postal codes (for example, zip + 4) are returned (default is VARIANT_FALSE).
boolean	isPartialAddress() Indicates if partial addresses are returned when not enough address information exists in the request (default is VARIANT_FALSE).
void	setCount(int count) The number of records that are returned in the results (default is 20).
void	setDataSource(String dataSource) The name of the data source to use for geocoding.
void	setExtendedPostalCode(boolean extendedPostalCode) Indicates if extended postal codes (for example, zip + 4) are returned (default is VARIANT_FALSE).
void	setPartialAddress(boolean partialAddress) Indicates if partial addresses are returned when not enough address information exists in the request (default is VARIANT_FALSE).
void	setSnapType(int snapType) The snap type to be used with the method FindAddressByPoint.
void	setStartIndex(int startIndex) The number of records to skip in the query.

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

ArcWebAddressFinderOptions

public ArcWebAddressFinderOptions()
                           throws IOException,
                                  UnknownHostException

Constructs a ArcWebAddressFinderOptions using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArcWebAddressFinderOptions

public ArcWebAddressFinderOptions(Object obj)
                           throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebAddressFinderOptions theArcWebAddressFinderOptions = (ArcWebAddressFinderOptions) obj;

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

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

getDataSource

public String getDataSource()
                     throws IOException,
                            AutomationException

The name of the data source to use for geocoding.

Product Availability

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

Specified by:

getDataSource in interface IArcWebAddressFinderOptions

Returns:

The dataSource

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataSource

public void setDataSource(String dataSource)
                   throws IOException,
                          AutomationException

The name of the data source to use for geocoding.

Product Availability

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

Specified by:

setDataSource in interface IArcWebAddressFinderOptions

Parameters:

dataSource - The dataSource (in)

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 returned (default is VARIANT_FALSE).

Product Availability

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

Specified by:

isExtendedPostalCode in interface IArcWebAddressFinderOptions

Returns:

The extendedPostalCode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendedPostalCode

public void setExtendedPostalCode(boolean extendedPostalCode)
                           throws IOException,
                                  AutomationException

Indicates if extended postal codes (for example, zip + 4) are returned (default is VARIANT_FALSE).

Product Availability

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

Specified by:

setExtendedPostalCode in interface IArcWebAddressFinderOptions

Parameters:

extendedPostalCode - The extendedPostalCode (in)

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 returned when not enough address information exists in the request (default is VARIANT_FALSE).

Product Availability

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

Specified by:

isPartialAddress in interface IArcWebAddressFinderOptions

Returns:

The partialAddress

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPartialAddress

public void setPartialAddress(boolean partialAddress)
                       throws IOException,
                              AutomationException

Indicates if partial addresses are returned when not enough address information exists in the request (default is VARIANT_FALSE).

Product Availability

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

Specified by:

setPartialAddress in interface IArcWebAddressFinderOptions

Parameters:

partialAddress - The partialAddress (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException

The number of records that are returned in the results (default is 20).

Product Availability

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

Specified by:

getCount in interface IArcWebAddressFinderOptions

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCount

public void setCount(int count)
              throws IOException,
                     AutomationException

The number of records that are returned in the results (default is 20).

Product Availability

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

Specified by:

setCount in interface IArcWebAddressFinderOptions

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartIndex

public int getStartIndex()
                  throws IOException,
                         AutomationException

The number of records to skip in the query. To get records 11-15, set startIndex to "10".

Product Availability

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

Specified by:

getStartIndex in interface IArcWebAddressFinderOptions

Returns:

The startIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartIndex

public void setStartIndex(int startIndex)
                   throws IOException,
                          AutomationException

The number of records to skip in the query. To get records 11-15, set startIndex to "10".

Product Availability

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

Specified by:

setStartIndex in interface IArcWebAddressFinderOptions

Parameters:

startIndex - The startIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapType

public int getSnapType()
                throws IOException,
                       AutomationException

The snap type to be used with the method FindAddressByPoint.

Product Availability

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

Specified by:

getSnapType in interface IArcWebAddressFinderOptions

Returns:

A com.esri.arcgis.arcweb.esriArcWebSnapType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapType

public void setSnapType(int snapType)
                 throws IOException,
                        AutomationException

The snap type to be used with the method FindAddressByPoint.

Product Availability

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

Specified by:

setSnapType in interface IArcWebAddressFinderOptions

Parameters:

snapType - A com.esri.arcgis.arcweb.esriArcWebSnapType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.