com.esri.arcgis.controls
Class EngineFeatureSnap

java.lang.Object
  com.esri.arcgis.controls.EngineFeatureSnap

All Implemented Interfaces:

IEngineFeatureSnapAgent, IEngineSnapAgent, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class EngineFeatureSnap
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IEngineFeatureSnapAgent

COM Class 'EngineFeatureSnap'. Generated 3/19/2015 1:20:48 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description 'An engine snap agent that snaps to features in a specific feature class.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.controls.IEngineFeatureSnapAgent

IID, IID5d8681b3_01b9_41d5_b4db_c35b745ca15b, xxDummy

Fields inherited from interface com.esri.arcgis.controls.IEngineSnapAgent

IIDe7ecdd8e_a513_47a1_9695_172823c329c9

Constructor Summary

EngineFeatureSnap()
Constructs a EngineFeatureSnap using ArcGIS Engine.

EngineFeatureSnap(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EngineFeatureSnap theEngineFeatureSnap = (EngineFeatureSnap) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
IFeatureCache	getFeatureCache() The FeatureCache associated with the engine feature snap agent.
IFeatureClass	getFeatureClass() The featureclass the feature snap agent snaps to.
int	getHitType() The part of a geometry the engine feature snap agent snaps to.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The name of the engine snap agent.
int	hashCode() the hashcode for this object
void	release() Release a EngineFeatureSnap.
void	setFeatureClassByRef(IFeatureClass featClass) The featureclass the feature snap agent snaps to.
void	setHitType(int hitType) The part of a geometry the engine feature snap agent snaps to.
boolean	snap(IGeometry geom, IPoint point, double tolerance) Fired by the Engine Editor to perform the actual snapping logic.

Methods inherited from class java.lang.Object

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

Constructor Detail

EngineFeatureSnap

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

Constructs a EngineFeatureSnap using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

EngineFeatureSnap

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

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

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

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()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a EngineFeatureSnap.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setFeatureClassByRef

public void setFeatureClassByRef(IFeatureClass featClass)
                          throws java.io.IOException,
                                 AutomationException

The featureclass the feature snap agent snaps to.

Specified by:

setFeatureClassByRef in interface IEngineFeatureSnapAgent

Parameters:

featClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureClass

public IFeatureClass getFeatureClass()
                              throws java.io.IOException,
                                     AutomationException

The featureclass the feature snap agent snaps to.

Specified by:

getFeatureClass in interface IEngineFeatureSnapAgent

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHitType

public void setHitType(int hitType)
                throws java.io.IOException,
                       AutomationException

The part of a geometry the engine feature snap agent snaps to.

Specified by:

setHitType in interface IEngineFeatureSnapAgent

Parameters:

hitType - A com.esri.arcgis.geometry.esriGeometryHitPartType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHitType

public int getHitType()
               throws java.io.IOException,
                      AutomationException

The part of a geometry the engine feature snap agent snaps to.

Specified by:

getHitType in interface IEngineFeatureSnapAgent

Returns:

A com.esri.arcgis.geometry.esriGeometryHitPartType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureCache

public IFeatureCache getFeatureCache()
                              throws java.io.IOException,
                                     AutomationException

The FeatureCache associated with the engine feature snap agent.

Specified by:

getFeatureCache in interface IEngineFeatureSnapAgent

Returns:

A reference to a com.esri.arcgis.carto.IFeatureCache

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the engine snap agent.

Specified by:

getName in interface IEngineSnapAgent

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

snap

public boolean snap(IGeometry geom,
                    IPoint point,
                    double tolerance)
             throws java.io.IOException,
                    AutomationException

Fired by the Engine Editor to perform the actual snapping logic.

Specified by:

snap in interface IEngineSnapAgent

Parameters:

geom - A reference to a com.esri.arcgis.geometry.IGeometry (in)

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

tolerance - The tolerance (in)

Returns:

The snapped

Throws:

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

AutomationException - If the ArcObject component throws an exception.