com.esri.arcgis.location
Class GeocodingIndexClassExtension

java.lang.Object
  com.esri.arcgis.location.GeocodingIndexClassExtension

All Implemented Interfaces:

IClassExtension, IObjectClassExtension, IRelatedObjectClassEvents, com.esri.arcgis.interop.RemoteObjRef, IGeocodingIndexCompute, ISupportErrorInfo, Serializable

public class GeocodingIndexClassExtension
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IClassExtension, IObjectClassExtension, IRelatedObjectClassEvents, IGeocodingIndexCompute, ISupportErrorInfo

A class extension for building and maintaining geocoding indexes.

Description

The GeocodingIndexClassExtension is an object class extension for geocoding index Tables that are automatically maintained. This object only applies to pre-9.2 locator indexes.

Remarks

When you register a Table as a geocoding index, use the IClassSchemaEdit::AlterClassExtensionCLSID method. With this method, you must specify a PropertySet that contains properties for the object class extension. The properties that this PropertySet must contain are:

• LeftZoneFieldName - The name of the Field in the reference data Table or FeatureClass that contains the left zone attribute; this property is only required if your geocoding index indexes the left zone attribute.
• LeftZoneSoundexFieldName - The name of the Field in the geocoding index Table that contains the Soundex value for the left zone attribute; this property is only required if your geocoding index indexes the left zone attribute.
• RightZoneFieldName - The name of the Field in the reference data Table or FeatureClass that contains the right zone attribute; this property is only required if your geocoding index indexes the right zone attribute.
• RightZoneSoundexFieldName - The name of the Field in the geocoding index Table that contains the Soundex value for the right zone attribute; this property is only required if your geocoding index indexes the right zone attribute.
• SoundexFieldName - The name of the Field in the geocoding index Table that contains the Soundex value for the street name or place name.
• StreetNameFieldName - The name of the Field in the reference data Table or FeatureClass that contains the street name; this property is only required if your geocoding index indexes the street name or place name.
• ZoneFieldName - The name of the Field in the reference data Table or FeatureClass that contains the zone attribute; this property is only required if your geocoding index indexes the zone attribute.
• ZoneSoundexFieldName - The name of the Field in the geocoding index Table that contains the Soundex value for the zone attribute; this property is only required if your geocoding index indexes the zone attribute.

For an example of setting up a geocoding index Table so that it is maintained automatically, see the Geocoding Index Maintenance sample in the Developer Samples section of the ArcObjects Developer Help system.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

GeocodingIndexObject, GeocodingIndexClassExtension, ReferenceDataIndex, IReferenceDataTable.getGeocodingIndexes(), IGeocodingIndexCompute, IReferenceDataIndex, IReferenceDataIndexEdit, IAddressGeocoding.validate(), ReferenceDataIndexEnumerator, IEnumReferenceDataIndex, Serialized Form

Constructor Summary

GeocodingIndexClassExtension()
Constructs a GeocodingIndexClassExtension using ArcGIS Engine.

GeocodingIndexClassExtension(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeocodingIndexClassExtension theGeocodingIndexClassExtension = (GeocodingIndexClassExtension) obj;

Method Summary

void	computeIndexRow(IObject sourceRow, IObject indexRow) Generates the index row values for a reference data row.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
void	init(IClassHelper classHelper, IPropertySet extensionProperties) Initializes the extension, passing in a reference to its class helper.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	relatedObjectCreated(IRelationshipClass relationshipClass, IObject objectThatWasCreated) Notifies this object class that a related object was created.
void	shutdown() Informs the extension that its class helper is going away.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

GeocodingIndexClassExtension

public GeocodingIndexClassExtension()
                             throws IOException,
                                    UnknownHostException

Constructs a GeocodingIndexClassExtension using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GeocodingIndexClassExtension

public GeocodingIndexClassExtension(Object obj)
                             throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeocodingIndexClassExtension theGeocodingIndexClassExtension = (GeocodingIndexClassExtension) obj;

Construct a GeocodingIndexClassExtension using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GeocodingIndexClassExtension.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

init

public void init(IClassHelper classHelper,
                 IPropertySet extensionProperties)
          throws IOException,
                 AutomationException

Initializes the extension, passing in a reference to its class helper.

Remarks

If a reference to the class is required by other class extension members, the class helper should be stored in a member variable. Storing an object or feature class directly within a class extension is strongly discouraged.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

init in interface IClassExtension

Parameters:

classHelper - A reference to a com.esri.arcgis.geodatabase.IClassHelper (in)

extensionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws IOException,
                     AutomationException

Informs the extension that its class helper is going away.

Remarks

Shutdown is called when the extension's class is cleared from the client's memory, or when the extension is removed from the class. Note that if a class is deleted from a geodatabase, it may remain in memory, so this should not be relied upon for behavior that should be triggered by a class' deletion.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

shutdown in interface IClassExtension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

relatedObjectCreated

public void relatedObjectCreated(IRelationshipClass relationshipClass,
                                 IObject objectThatWasCreated)
                          throws IOException,
                                 AutomationException

Notifies this object class that a related object was created.

Remarks

The RelationshipClass argument is useful for establishing new relationships. Since an object class may often participate in many relationships, the properties of RelationshipClass can be used to modify behavior of this method.

In order for this method to be called, the relationship class must have messaging set. If the object class which this class extension is associated with is the origin class in the relationship class, then the messaging should be set to Backward or Both. If the object class is the destination class in the relationship, then messaging should be set to Forward or Both.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

relatedObjectCreated in interface IRelatedObjectClassEvents

Parameters:

relationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

objectThatWasCreated - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.editor.IShortTransactionObjectInspector

computeIndexRow

public void computeIndexRow(IObject sourceRow,
                            IObject indexRow)
                     throws IOException,
                            AutomationException

Generates the index row values for a reference data row.

Remarks

This method is deprecated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

computeIndexRow in interface IGeocodingIndexCompute

Parameters:

sourceRow - A reference to a com.esri.arcgis.geodatabase.IObject (in)

indexRow - A reference to a com.esri.arcgis.geodatabase.IObject (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.