com.esri.arcgis.location
Interface IDEAddressLocator

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
DEAddressLocator, IDEAddressLocatorProxy

public interface IDEAddressLocator
extends java.io.Serializable

COM Interface 'IDEAddressLocator'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriLocation.olb'

Description: 'Provides access to members describing the address locator data element.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDecd14972_5ecd_4a6f_b62f_b741dd429e3c
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 IFields getAddressFields()
          The set of address input fields used by the address locator.
 IDETable getAddressTable()
          Table of addresses to geocode using the locator.
 java.lang.Object getDefaultInputFieldNames(java.lang.String addressFieldName)
          Default input field names for the address field.
 IFields getMatchFields()
          Fields output by geocoding.
 boolean isLocatorPropsRetrieved()
          Indicates if the locator propertries been retrieved.
 void setAddressFieldsByRef(IFields addressFields)
          The set of address input fields used by the address locator.
 void setAddressTableByRef(IDETable addressTable)
          Table of addresses to geocode using the locator.
 void setDefaultInputFieldNames(java.lang.String addressFieldName, java.lang.Object defaultFieldNames)
          Default input field names for the address field.
 void setLocatorPropsRetrieved(boolean propsRetrieved)
          Indicates if the locator propertries been retrieved.
 void setMatchFieldsByRef(IFields matchFields)
          Fields output by geocoding.
 

Field Detail

IIDecd14972_5ecd_4a6f_b62f_b741dd429e3c

static final int IIDecd14972_5ecd_4a6f_b62f_b741dd429e3c
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getAddressFields

IFields getAddressFields()
                         throws java.io.IOException,
                                AutomationException
The set of address input fields used by the address locator.

Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAddressFieldsByRef

void setAddressFieldsByRef(IFields addressFields)
                           throws java.io.IOException,
                                  AutomationException
The set of address input fields used by the address locator.

Parameters:
addressFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultInputFieldNames

java.lang.Object getDefaultInputFieldNames(java.lang.String addressFieldName)
                                           throws java.io.IOException,
                                                  AutomationException
Default input field names for the address field.

Parameters:
addressFieldName - The addressFieldName (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultInputFieldNames

void setDefaultInputFieldNames(java.lang.String addressFieldName,
                               java.lang.Object defaultFieldNames)
                               throws java.io.IOException,
                                      AutomationException
Default input field names for the address field.

Parameters:
addressFieldName - The addressFieldName (in)
defaultFieldNames - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMatchFields

IFields getMatchFields()
                       throws java.io.IOException,
                              AutomationException
Fields output by geocoding.

Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMatchFieldsByRef

void setMatchFieldsByRef(IFields matchFields)
                         throws java.io.IOException,
                                AutomationException
Fields output by geocoding.

Parameters:
matchFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAddressTable

IDETable getAddressTable()
                         throws java.io.IOException,
                                AutomationException
Table of addresses to geocode using the locator. Used for validiation.

Returns:
A reference to a com.esri.arcgis.geodatabase.IDETable
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAddressTableByRef

void setAddressTableByRef(IDETable addressTable)
                          throws java.io.IOException,
                                 AutomationException
Table of addresses to geocode using the locator. Used for validiation.

Parameters:
addressTable - A reference to a com.esri.arcgis.geodatabase.IDETable (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLocatorPropsRetrieved

boolean isLocatorPropsRetrieved()
                                throws java.io.IOException,
                                       AutomationException
Indicates if the locator propertries been retrieved.

Returns:
The propsRetrieved
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLocatorPropsRetrieved

void setLocatorPropsRetrieved(boolean propsRetrieved)
                              throws java.io.IOException,
                                     AutomationException
Indicates if the locator propertries been retrieved.

Parameters:
propsRetrieved - The propsRetrieved (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.