com.esri.arcgis.location
Class IPlaceNameAliasProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.location.IPlaceNameAliasProxy

All Implemented Interfaces:

IPlaceNameAlias, Externalizable, Serializable

public class IPlaceNameAliasProxy
extends com.esri.arcgis.interop.Dispatch
implements IPlaceNameAlias, Serializable

Provides access to memebers that specify a place name alias table.

Remarks

Place name alias tables store aliases for addresses, such as “City Hall”, so that you can geocode addresses using alias names rather than addresses.

When using the IPlaceNameAlias interface to specify the place name alias table for a locator, only set the writeable properties immediately one after the other. Setting some of these properties, such as the Table property, can place the locator object in a state which can cause some of the readable properties and methods on the locator to raise errors until the other writeable properties on this interface are set.

When To Use

Use the IPlaceNameAlias interface to specify a table that the locator will use as a place name alias table.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IPlaceNameAliasProxy()
	IPlaceNameAliasProxy(Object obj)
protected	IPlaceNameAliasProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
String	getAliasField() Name of the alias field.
Object	getDefaultAliasFieldNames() Recognized names for the address fields in the place name alias table.
ITableName	getTable() Name object for the place name alias table.
String	IPlaceNameAlias_getAddressFields() Names of the address fields.
void	removeListener(String iidStr, Object theListener)
void	setAddressFields(String fieldList) Names of the address fields.
void	setAliasField(String name) Name of the alias field.
void	setDefaultAliasFieldNames(Object names) Recognized names for the address fields in the place name alias table.
void	setTableByRef(ITableName name) Name object for the place name alias table.

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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IPlaceNameAliasProxy

public IPlaceNameAliasProxy()

IPlaceNameAliasProxy

public IPlaceNameAliasProxy(Object obj)
                     throws IOException

Throws:

IOException

IPlaceNameAliasProxy

protected IPlaceNameAliasProxy(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

getTable

public ITableName getTable()
                    throws IOException,
                           AutomationException

Name object for the place name alias table.

Remarks

Locators can use place name alias tables during the geocoding process. A place name alias table is a table that contains place names (for example, "City Hall"), and the addresses for those places. When geocoding, the locator searches the place name alias table for matches to the input address. If a match is found, then locator replaces the input address with the corresponding address from the place name alias table. In this way, you can geocode addresses by place name, without having to know the proper street address for those places.

The Table property returns a reference to a TableName object representing the place name alias table.

When using the IPlaceNameAlias interface to specify the place name alias table for a locator, only set the writeable properties immediately one after the other. Setting some of these properties, such as the Table property, can place the locator object in a state which can cause some of the readable properties and methods on the locator to raise errors until the other writeable properties on this interface are set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTable in interface IPlaceNameAlias

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableByRef

public void setTableByRef(ITableName name)
                   throws IOException,
                          AutomationException

Name object for the place name alias table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTableByRef in interface IPlaceNameAlias

Parameters:

name - A reference to a com.esri.arcgis.geodatabase.ITableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAliasField

public String getAliasField()
                     throws IOException,
                            AutomationException

Name of the alias field.

Remarks

The AliasField property returns the name of the field in the place name alias table that contains the place name aliases.

When using the IPlaceNameAlias interface to specify the place name alias table for a locator, only set the writeable properties immediately one after the other. Setting some of these properties, such as the Table property, can place the locator object in a state which can cause some of the readable properties and methods on the locator to raise errors until the other writeable properties on this interface are set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAliasField in interface IPlaceNameAlias

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAliasField

public void setAliasField(String name)
                   throws IOException,
                          AutomationException

Name of the alias field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAliasField in interface IPlaceNameAlias

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IPlaceNameAlias_getAddressFields

public String IPlaceNameAlias_getAddressFields()
                                        throws IOException,
                                               AutomationException

Names of the address fields.

Product Availability

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

Specified by:

IPlaceNameAlias_getAddressFields in interface IPlaceNameAlias

Returns:

The fieldList

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddressFields

public void setAddressFields(String fieldList)
                      throws IOException,
                             AutomationException

Names of the address fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAddressFields in interface IPlaceNameAlias

Parameters:

fieldList - The fieldList (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultAliasFieldNames

public Object getDefaultAliasFieldNames()
                                 throws IOException,
                                        AutomationException

Recognized names for the address fields in the place name alias table.

Remarks

The DefaultAliasFieldNames property is an array of strings containing recognized field names for the alias field in a place name alias table. You can use the contents of this array to search through your place name alias table to determine which field contains the place name alias information. If the locator contains no default alias field names, calling this property returns an error.

When using the IPlaceNameAlias interface to specify the place name alias table for a locator, only set the writeable properties immediately one after the other. Setting some of these properties, such as the Table property, can place the locator object in a state which can cause some of the readable properties and methods on the locator to raise errors until the other writeable properties on this interface are set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultAliasFieldNames in interface IPlaceNameAlias

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultAliasFieldNames

public void setDefaultAliasFieldNames(Object names)
                               throws IOException,
                                      AutomationException

Recognized names for the address fields in the place name alias table.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultAliasFieldNames in interface IPlaceNameAlias

Parameters:

names - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.