Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.location
Interface IGPAddressLocatorStyle

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
GPAddressLocatorStyle, IGPAddressLocatorStyleProxy
public interface IGPAddressLocatorStyle
extends java.io.Serializable

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

Description: 'Provides access to members describing the address locator style 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 IID4352d4db_7256_4b52_abfb_cfb59a78a26d
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 IFields getAddressFields()
          Fields needed to do geocoding with an address locator created with this style.
 IDETable getAliasTable()
          Table mapped as the place name alias table.
 java.lang.Object getDefaultAliasFieldNames()
          Default field names for the place name alias table.
 java.lang.Object getDefaultFieldNames(int tableIndex, int fieldIndex)
          Default field names for the indicated reference data field.
 java.lang.Object getDefaultInputFieldNames(java.lang.String addressFieldName)
          Default field names for the indicated address field of an address locator created with this style.
 IDETable getMappedTable(java.lang.String refDataTable)
          Table mapped to the indicated reference data table.
 IFields getMatchFields()
          Fields output by an address locator created with this style.
 java.lang.String getName()
          Name of the locator style.
 IFields getReferenceDataFields(int index)
          Reference data fields for the indicated reference data table.
 IArray getReferenceDataFilters(int index)
          Filters for the indicated reference data table.
 IArray getReferenceDataFilterUIDs(int index)
          Filters for the indicated reference data table.
 int getReferenceDataTableCount()
          Number of reference data tables needed for the style.
 java.lang.String getReferenceDataTableName(int index)
          Display name of the indicated reference data table.
 IFields getSimpleStandardizeFields()
          Fields needed to do address standardization.
 boolean isSupportsPlaceNameAliasTable()
          Indicates if the locator style supports a place name alias table.
 void setAddressFieldsByRef(IFields addressFields)
          Fields needed to do geocoding with an address locator created with this style.
 void setAliasTableByRef(IDETable aliasTable)
          Table mapped as the place name alias table.
 void setDefaultAliasFieldNames(java.lang.Object defaultAliasFieldNames)
          Default field names for the place name alias table.
 void setDefaultFieldNamesByRef(int tableIndex, int fieldIndex, java.lang.Object defaultNames)
          Default field names for the indicated reference data field.
 void setDefaultInputFieldNames(java.lang.String addressFieldName, java.lang.Object defaultNames)
          Default field names for the indicated address field of an address locator created with this style.
 void setMappedTableByRef(java.lang.String refDataTable, IDETable table)
          Table mapped to the indicated reference data table.
 void setMatchFieldsByRef(IFields matchFields)
          Fields output by an address locator created with this style.
 void setName(java.lang.String name)
          Name of the locator style.
 void setReferenceDataFieldsByRef(int index, IFields fields)
          Reference data fields for the indicated reference data table.
 void setReferenceDataFilterUIDsByRef(int index, IArray filters)
          Filters for the indicated reference data table.
 void setReferenceDataTableCount(int count)
          Number of reference data tables needed for the style.
 void setReferenceDataTableName(int index, java.lang.String name)
          Display name of the indicated reference data table.
 void setSimpleStandardizeFieldsByRef(IFields standardizeFields)
          Fields needed to do address standardization.
 void setSupportsPlaceNameAliasTable(boolean supportsPNAT)
          Indicates if the locator style supports a place name alias table.
 

Field Detail

IID4352d4db_7256_4b52_abfb_cfb59a78a26d

static final int IID4352d4db_7256_4b52_abfb_cfb59a78a26d
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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Name of the locator style.

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

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
Name of the locator style.

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

getSimpleStandardizeFields

IFields getSimpleStandardizeFields()
                                   throws java.io.IOException,
                                          AutomationException
Fields needed to do address standardization.

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.

setSimpleStandardizeFieldsByRef

void setSimpleStandardizeFieldsByRef(IFields standardizeFields)
                                     throws java.io.IOException,
                                            AutomationException
Fields needed to do address standardization.

Parameters:
standardizeFields - 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.

getAddressFields

IFields getAddressFields()
                         throws java.io.IOException,
                                AutomationException
Fields needed to do geocoding with an address locator created with this style.

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
Fields needed to do geocoding with an address locator created with this style.

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 field names for the indicated address field of an address locator created with this style.

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 defaultNames)
                               throws java.io.IOException,
                                      AutomationException
Default field names for the indicated address field of an address locator created with this style.

Parameters:
addressFieldName - The addressFieldName (in)
defaultNames - 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 an address locator created with this style.

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 an address locator created with this style.

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.

getReferenceDataTableCount

int getReferenceDataTableCount()
                               throws java.io.IOException,
                                      AutomationException
Number of reference data tables needed for the style.

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

setReferenceDataTableCount

void setReferenceDataTableCount(int count)
                                throws java.io.IOException,
                                       AutomationException
Number of reference data tables needed for the style.

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

getReferenceDataTableName

java.lang.String getReferenceDataTableName(int index)
                                           throws java.io.IOException,
                                                  AutomationException
Display name of the indicated reference data table.

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

setReferenceDataTableName

void setReferenceDataTableName(int index,
                               java.lang.String name)
                               throws java.io.IOException,
                                      AutomationException
Display name of the indicated reference data table.

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

getReferenceDataFilters

IArray getReferenceDataFilters(int index)
                               throws java.io.IOException,
                                      AutomationException
Filters for the indicated reference data table.

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReferenceDataFilterUIDs

IArray getReferenceDataFilterUIDs(int index)
                                  throws java.io.IOException,
                                         AutomationException
Filters for the indicated reference data table.

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReferenceDataFilterUIDsByRef

void setReferenceDataFilterUIDsByRef(int index,
                                     IArray filters)
                                     throws java.io.IOException,
                                            AutomationException
Filters for the indicated reference data table.

Parameters:
index - The index (in)
filters - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReferenceDataFields

IFields getReferenceDataFields(int index)
                               throws java.io.IOException,
                                      AutomationException
Reference data fields for the indicated reference data table.

Parameters:
index - The index (in)
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.

setReferenceDataFieldsByRef

void setReferenceDataFieldsByRef(int index,
                                 IFields fields)
                                 throws java.io.IOException,
                                        AutomationException
Reference data fields for the indicated reference data table.

Parameters:
index - The index (in)
fields - 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.

getDefaultFieldNames

java.lang.Object getDefaultFieldNames(int tableIndex,
                                      int fieldIndex)
                                      throws java.io.IOException,
                                             AutomationException
Default field names for the indicated reference data field.

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

setDefaultFieldNamesByRef

void setDefaultFieldNamesByRef(int tableIndex,
                               int fieldIndex,
                               java.lang.Object defaultNames)
                               throws java.io.IOException,
                                      AutomationException
Default field names for the indicated reference data field.

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

getMappedTable

IDETable getMappedTable(java.lang.String refDataTable)
                        throws java.io.IOException,
                               AutomationException
Table mapped to the indicated reference data table.

Parameters:
refDataTable - The refDataTable (in)
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.

setMappedTableByRef

void setMappedTableByRef(java.lang.String refDataTable,
                         IDETable table)
                         throws java.io.IOException,
                                AutomationException
Table mapped to the indicated reference data table.

Parameters:
refDataTable - The refDataTable (in)
table - 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.

isSupportsPlaceNameAliasTable

boolean isSupportsPlaceNameAliasTable()
                                      throws java.io.IOException,
                                             AutomationException
Indicates if the locator style supports a place name alias table.

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

setSupportsPlaceNameAliasTable

void setSupportsPlaceNameAliasTable(boolean supportsPNAT)
                                    throws java.io.IOException,
                                           AutomationException
Indicates if the locator style supports a place name alias table.

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

getDefaultAliasFieldNames

java.lang.Object getDefaultAliasFieldNames()
                                           throws java.io.IOException,
                                                  AutomationException
Default field names for the place name alias table.

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

setDefaultAliasFieldNames

void setDefaultAliasFieldNames(java.lang.Object defaultAliasFieldNames)
                               throws java.io.IOException,
                                      AutomationException
Default field names for the place name alias table.

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

getAliasTable

IDETable getAliasTable()
                       throws java.io.IOException,
                              AutomationException
Table mapped as the place name alias table.

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.

setAliasTableByRef

void setAliasTableByRef(IDETable aliasTable)
                        throws java.io.IOException,
                               AutomationException
Table mapped as the place name alias table.

Parameters:
aliasTable - 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.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD