com.esri.arcgis.location
Class GeocodingIndexClassExtension

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

All Implemented Interfaces:

IClassExtension, IGeocodingIndexCompute, IObjectClassExtension, IRelatedObjectClassEvents, ISupportErrorInfo, java.io.Serializable

public class GeocodingIndexClassExtension

extends java.lang.Object

implements IClassExtension, IObjectClassExtension, IRelatedObjectClassEvents, IGeocodingIndexCompute, ISupportErrorInfo

A class extension for building and maintaining geocoding indexes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

See Also:

Serialized Form

Constructor Summary

GeocodingIndexClassExtension()
Constructs a GeocodingIndexClassExtension using ArcGIS Engine.

GeocodingIndexClassExtension(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

void	computeIndexRow(IObject sourceRow, IObject indexRow) Generates the index row values for a reference data row.
boolean	equals(java.lang.Object o) Compare this object with another
IClassExtension	getAsIClassExtension() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGeocodingIndexCompute	getAsIGeocodingIndexCompute() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IObjectClassExtension	getAsIObjectClassExtension() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IRelatedObjectClassEvents	getAsIRelatedObjectClassEvents() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISupportErrorInfo	getAsISupportErrorInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
static java.lang.String	getClsid()
int	hashCode() the hashcode for this object
void	init(IClassHelper pClassHelper, IPropertySet pExtensionProperties) Initializes the extension, passing in a reference to its class helper.
void	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
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

Constructor Detail

GeocodingIndexClassExtension

public GeocodingIndexClassExtension()
                             throws java.io.IOException,
                                    java.net.UnknownHostException

Constructs a GeocodingIndexClassExtension using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GeocodingIndexClassExtension

public GeocodingIndexClassExtension(java.lang.Object obj)
                             throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
GeocodingIndexClassExtension theGeocodingIndexClassExtension = (GeocodingIndexClassExtension) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIClassExtension

public IClassExtension getAsIClassExtension()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIObjectClassExtension

public IObjectClassExtension getAsIObjectClassExtension()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIRelatedObjectClassEvents

public IRelatedObjectClassEvents getAsIRelatedObjectClassEvents()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGeocodingIndexCompute

public IGeocodingIndexCompute getAsIGeocodingIndexCompute()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

init

public void init(IClassHelper pClassHelper,
                 IPropertySet pExtensionProperties)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IClassExtension

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

init in interface IClassExtension

Parameters:

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

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

shutdown

public void shutdown()
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IClassExtension

Informs the extension that its class helper is going away.

Supported Platforms

Windows, Solaris, Linux

Specified by:

shutdown in interface IClassExtension

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

relatedObjectCreated

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

Description copied from interface: IRelatedObjectClassEvents

Notifies this object class that a related object was created.

Supported Platforms

Windows, Solaris, Linux

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.

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:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

See Also:

IRelationshipClass, IClassExtension

computeIndexRow

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

Description copied from interface: IGeocodingIndexCompute

Generates the index row values for a reference data row.

Supported Platforms

Windows, Solaris, Linux

Remarks

This method is deprecated.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.