com.esri.arcgis.location
Class IAddressCandidatesProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.location.IAddressCandidatesProxy
All Implemented Interfaces:
IAddressCandidates, Externalizable, Serializable

public class IAddressCandidatesProxy
extends com.esri.arcgis.interop.Dispatch
implements IAddressCandidates, 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:

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.

Supported Platforms

Windows, Solaris, Linux

See Also:
IAddressCandidates, Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IAddressCandidatesProxy()
           
  IAddressCandidatesProxy(Object obj)
           
protected IAddressCandidatesProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 IArray findAddressCandidates(IPropertySet address)
          Generates candidates for an address.
 IFields getCandidateFields()
          Fields contained in a list of candidates.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IAddressCandidatesProxy

public IAddressCandidatesProxy()

IAddressCandidatesProxy

public IAddressCandidatesProxy(Object obj)
                        throws IOException
Throws:
IOException

IAddressCandidatesProxy

protected IAddressCandidatesProxy(Object obj,
                                  String iid)
                           throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getCandidateFields

public 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

Specified by:
getCandidateFields in interface IAddressCandidates
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

public 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

Specified by:
findAddressCandidates in interface IAddressCandidates
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

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException