com.esri.arcgis.location
Class GeocodedFeatureClassExtension

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

All Implemented Interfaces:

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

public class GeocodedFeatureClassExtension
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IClassExtension, IObjectClassExtension, IFeatureClassExtension, IRelatedObjectClassEvents, IGeocodedFeatureClass, ISupportErrorInfo

A class extension for automatically maintaining geocoded feature classes.

Description

The GeocodedFeatureClassExtension is a feature class extension for geocoded FeatureClasses that are automatically maintained.

Remarks

When you register a FeatureClass as a geocoded feature class, use the IClassSchemaEdit::AlterClassExtensionCLSID method. With this method, you must specify a PropertySet that contains properties for the feature class extension. The properties that this PropertySet must contain are:

• OriginalAddressFieldNames - The names of the Fields in the related address Table that contain the address attributes; this property is a string that contains the names of the Fields in the same order as specified by the IAddressInputs:AddressFields property.
• UnmatchOnly - A boolean value that indicates that new unmatched Features should be created in the geocoded FeatureClass if new records are added to the address Table.
• UpdateOnEdit - A boolean value that indicates if features in the geocoded FeatureClass should be updated if the corresponding records in the address Table are edited.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

RelationshipClass, GeocodedFeature, IRelationshipClassEvents, esriRelRole, Serialized Form

Constructor Summary

GeocodedFeatureClassExtension()
Constructs a GeocodedFeatureClassExtension using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
void	geocodeAddress(IObject address, IFeature result) Updates the geocoded feature.
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
boolean	needsUpdate(IObject address, IFeature shape) Indicates if a geocoded feature needs to be updated.
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

GeocodedFeatureClassExtension

public GeocodedFeatureClassExtension()
                              throws IOException,
                                     UnknownHostException

Constructs a GeocodedFeatureClassExtension using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GeocodedFeatureClassExtension

public GeocodedFeatureClassExtension(Object obj)
                              throws IOException

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

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

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

needsUpdate

public boolean needsUpdate(IObject address,
                           IFeature shape)
                    throws IOException,
                           AutomationException

Indicates if a geocoded feature needs to be updated.

Remarks

The address parameter is an Object from the address Table.

The result parameter is a Feature representing the geocoded location of the Object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

needsUpdate in interface IGeocodedFeatureClass

Parameters:

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

shape - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Returns:

The bNeedsUpdate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

GeocodedFeature

geocodeAddress

public void geocodeAddress(IObject address,
                           IFeature result)
                    throws IOException,
                           AutomationException

Updates the geocoded feature.

Remarks

This method returns a boolean value that indicates if the geometry of a GeocodedFeature needs to be updated.

The address parameter is an Object from the address Table.

The Shape parameter is a Feature representing the geocoded location of the Object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

geocodeAddress in interface IGeocodedFeatureClass

Parameters:

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

result - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

GeocodedFeature

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.