com.esri.arcgis.location
Interface IGPAddressLocatorStyle

All Superinterfaces:

Serializable

All Known Implementing Classes:

GPAddressLocatorStyle

public interface IGPAddressLocatorStyle
extends Serializable

Provides access to members describing the address locator style data element.

Product Availability

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

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.
Object	getDefaultAliasFieldNames() Default field names for the place name alias table.
Object	getDefaultFieldNames(int tableIndex, int fieldIndex) Default field names for the indicated reference data field.
Object	getDefaultInputFieldNames(String addressFieldName) Default field names for the indicated address field of an address locator created with this style.
IDETable	getMappedTable(String refDataTable) Table mapped to the indicated reference data table.
IFields	getMatchFields() Fields output by an address locator created with this style.
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.
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(Object defaultAliasFieldNames) Default field names for the place name alias table.
void	setDefaultFieldNamesByRef(int tableIndex, int fieldIndex, Object defaultNames) Default field names for the indicated reference data field.
void	setDefaultInputFieldNames(String addressFieldName, Object defaultNames) Default field names for the indicated address field of an address locator created with this style.
void	setMappedTableByRef(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(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, 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.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the locator style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

Name of the locator style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSimpleStandardizeFields

IFields getSimpleStandardizeFields()
                                   throws IOException,
                                          AutomationException

Fields needed to do address standardization.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

setSimpleStandardizeFieldsByRef

void setSimpleStandardizeFieldsByRef(IFields standardizeFields)
                                     throws IOException,
                                            AutomationException

Fields needed to do address standardization.

Product Availability

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

Parameters:

standardizeFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAddressFields

IFields getAddressFields()
                         throws IOException,
                                AutomationException

Fields needed to do geocoding with an address locator created with this style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

setAddressFieldsByRef

void setAddressFieldsByRef(IFields addressFields)
                           throws IOException,
                                  AutomationException

Fields needed to do geocoding with an address locator created with this style.

Product Availability

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

Parameters:

addressFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultInputFieldNames

Object getDefaultInputFieldNames(String addressFieldName)
                                 throws IOException,
                                        AutomationException

Default field names for the indicated address field of an address locator created with this style.

Product Availability

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

Parameters:

addressFieldName - The addressFieldName (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultInputFieldNames

void setDefaultInputFieldNames(String addressFieldName,
                               Object defaultNames)
                               throws IOException,
                                      AutomationException

Default field names for the indicated address field of an address locator created with this style.

Product Availability

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

Parameters:

addressFieldName - The addressFieldName (in)

defaultNames - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMatchFields

IFields getMatchFields()
                       throws IOException,
                              AutomationException

Fields output by an address locator created with this style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

setMatchFieldsByRef

void setMatchFieldsByRef(IFields matchFields)
                         throws IOException,
                                AutomationException

Fields output by an address locator created with this style.

Product Availability

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

Parameters:

matchFields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceDataTableCount

int getReferenceDataTableCount()
                               throws IOException,
                                      AutomationException

Number of reference data tables needed for the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceDataTableCount

void setReferenceDataTableCount(int count)
                                throws IOException,
                                       AutomationException

Number of reference data tables needed for the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

count - The count (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceDataTableName

String getReferenceDataTableName(int index)
                                 throws IOException,
                                        AutomationException

Display name of the indicated reference data table.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceDataTableName

void setReferenceDataTableName(int index,
                               String name)
                               throws IOException,
                                      AutomationException

Display name of the indicated reference data table.

Product Availability

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

Parameters:

index - The index (in)

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceDataFilters

IArray getReferenceDataFilters(int index)
                               throws IOException,
                                      AutomationException

Filters for the indicated reference data table.

Product Availability

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

Parameters:

index - The index (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.

getReferenceDataFilterUIDs

IArray getReferenceDataFilterUIDs(int index)
                                  throws IOException,
                                         AutomationException

Filters for the indicated reference data table.

Product Availability

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

Parameters:

index - The index (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.

setReferenceDataFilterUIDsByRef

void setReferenceDataFilterUIDsByRef(int index,
                                     IArray filters)
                                     throws IOException,
                                            AutomationException

Filters for the indicated reference data table.

Product Availability

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

Parameters:

index - The index (in)

filters - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceDataFields

IFields getReferenceDataFields(int index)
                               throws IOException,
                                      AutomationException

Reference data fields for the indicated reference data table.

Product Availability

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

Parameters:

index - The index (in)

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.

setReferenceDataFieldsByRef

void setReferenceDataFieldsByRef(int index,
                                 IFields fields)
                                 throws IOException,
                                        AutomationException

Reference data fields for the indicated reference data table.

Product Availability

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

Parameters:

index - The index (in)

fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultFieldNames

Object getDefaultFieldNames(int tableIndex,
                            int fieldIndex)
                            throws IOException,
                                   AutomationException

Default field names for the indicated reference data field.

Product Availability

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

Parameters:

tableIndex - The tableIndex (in)

fieldIndex - The fieldIndex (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultFieldNamesByRef

void setDefaultFieldNamesByRef(int tableIndex,
                               int fieldIndex,
                               Object defaultNames)
                               throws IOException,
                                      AutomationException

Default field names for the indicated reference data field.

Product Availability

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

Parameters:

tableIndex - The tableIndex (in)

fieldIndex - The fieldIndex (in)

defaultNames - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMappedTable

IDETable getMappedTable(String refDataTable)
                        throws IOException,
                               AutomationException

Table mapped to the indicated reference data table.

Product Availability

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

Parameters:

refDataTable - The refDataTable (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IDETable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMappedTableByRef

void setMappedTableByRef(String refDataTable,
                         IDETable table)
                         throws IOException,
                                AutomationException

Table mapped to the indicated reference data table.

Product Availability

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

Parameters:

refDataTable - The refDataTable (in)

table - A reference to a com.esri.arcgis.geodatabase.IDETable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportsPlaceNameAliasTable

boolean isSupportsPlaceNameAliasTable()
                                      throws IOException,
                                             AutomationException

Indicates if the locator style supports a place name alias table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The supportsPNAT

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSupportsPlaceNameAliasTable

void setSupportsPlaceNameAliasTable(boolean supportsPNAT)
                                    throws IOException,
                                           AutomationException

Indicates if the locator style supports a place name alias table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

supportsPNAT - The supportsPNAT (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultAliasFieldNames

Object getDefaultAliasFieldNames()
                                 throws IOException,
                                        AutomationException

Default field names for the place name alias table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultAliasFieldNames

void setDefaultAliasFieldNames(Object defaultAliasFieldNames)
                               throws IOException,
                                      AutomationException

Default field names for the place name alias table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

defaultAliasFieldNames - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAliasTable

IDETable getAliasTable()
                       throws IOException,
                              AutomationException

Table mapped as the place name alias table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.IDETable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAliasTableByRef

void setAliasTableByRef(IDETable aliasTable)
                        throws IOException,
                               AutomationException

Table mapped as the place name alias table.

Product Availability

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

Parameters:

aliasTable - A reference to a com.esri.arcgis.geodatabase.IDETable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.