com.esri.arcgis.location
Class GeocodedFeatureClassExtension

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

All Implemented Interfaces:

IClassExtension, IFeatureClassExtension, IGeocodedFeatureClass, IObjectClassExtension, IRelatedObjectClassEvents, ISupportErrorInfo, java.io.Serializable

public class GeocodedFeatureClassExtension

extends java.lang.Object

implements IClassExtension, IObjectClassExtension, IFeatureClassExtension, IRelatedObjectClassEvents, IGeocodedFeatureClass, ISupportErrorInfo

A class extension for automatically maintaining geocoded feature classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

See Also:

RelationshipClass, Serialized Form

Constructor Summary

GeocodedFeatureClassExtension()
Constructs a GeocodedFeatureClassExtension using ArcGIS Engine.

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
void	geocodeAddress(IObject address, IFeature result) Updates the geocoded feature.
IClassExtension	getAsIClassExtension() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IFeatureClassExtension	getAsIFeatureClassExtension() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGeocodedFeatureClass	getAsIGeocodedFeatureClass() 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
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

Constructor Detail

GeocodedFeatureClassExtension

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

Constructs a GeocodedFeatureClassExtension using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GeocodedFeatureClassExtension

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

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

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.
GeocodedFeatureClassExtension theGeocodedFeatureClassExtension = (GeocodedFeatureClassExtension) 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.

getAsIFeatureClassExtension

public IFeatureClassExtension getAsIFeatureClassExtension()

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.

getAsIGeocodedFeatureClass

public IGeocodedFeatureClass getAsIGeocodedFeatureClass()

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

needsUpdate

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

Description copied from interface: IGeocodedFeatureClass

Indicates if a geocoded feature needs to be updated.

Supported Platforms

Windows, Solaris, Linux

Remarks

The address parameter is an Object from the address Table.

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

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:

AutomationException - If the ArcObject component throws an exception.

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

geocodeAddress

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

Description copied from interface: IGeocodedFeatureClass

Updates the geocoded feature.

Supported Platforms

Windows, Solaris, Linux

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.

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:

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.