com.esri.arcgis.networkanalysis
Class EIDHelper

java.lang.Object
  com.esri.arcgis.networkanalysis.EIDHelper

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IEIDHelper, java.io.Serializable

public class EIDHelper
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IEIDHelper

COM Class 'EIDHelper'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriNetworkAnalysis.olb'

Description 'A container for getting the features and/or geometries from an enumeration of element IDs.' 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.networkanalysis.IEIDHelper

IID, IID212ad7b8_747a_11d4_a68d_0008c7d3bbfa, xxDummy

Constructor Summary

EIDHelper()
Constructs a EIDHelper using ArcGIS Engine.

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

Method Summary

void	addField(java.lang.String field) Adds a field to the list of fields to return with the feature.
void	clearFields() Clears the list of fields to return with the feature.
IEnumEIDInfo	createEnumEIDInfo(IEnumNetEID netEIDs) Creates an enumeration of EIDInfo objects based on the specified EIDs and parameters on this EIDHelper object.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	hashCode() the hashcode for this object
void	release() Release a EIDHelper.
void	setDisplayEnvelopeByRef(IEnvelope rhs1) Envelope in which valid geometries and features must reside to be returned in the EnumEIDInfo object.
void	setGeometricNetworkByRef(IGeometricNetwork rhs1) Geometric network from which these element IDs come.
void	setOutputSpatialReferenceByRef(ISpatialReference rhs1) Spatial reference the returned geometries should be in.
void	setPartialComplexEdgeGeometry(boolean rhs1) Indicates if the EIDs representing partial complex edges return the geometry of the partial complex edge.
void	setReturnFeatures(boolean rhs1) Indicates if the created IEIDInfo enumeration should contain features.
void	setReturnGeometries(boolean rhs1) Indicates if the created EIDInfo enumeration should contain geometries.

Methods inherited from class java.lang.Object

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

Constructor Detail

EIDHelper

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

Constructs a EIDHelper using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

EIDHelper

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

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

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

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 EIDHelper.

Specified by:

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

setGeometricNetworkByRef

public void setGeometricNetworkByRef(IGeometricNetwork rhs1)
                              throws java.io.IOException,
                                     AutomationException

Geometric network from which these element IDs come.

Specified by:

setGeometricNetworkByRef in interface IEIDHelper

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IGeometricNetwork (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addField

public void addField(java.lang.String field)
              throws java.io.IOException,
                     AutomationException

Adds a field to the list of fields to return with the feature.

Specified by:

addField in interface IEIDHelper

Parameters:

field - The field (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearFields

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

Clears the list of fields to return with the feature.

Specified by:

clearFields in interface IEIDHelper

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnGeometries

public void setReturnGeometries(boolean rhs1)
                         throws java.io.IOException,
                                AutomationException

Indicates if the created EIDInfo enumeration should contain geometries.

Specified by:

setReturnGeometries in interface IEIDHelper

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnFeatures

public void setReturnFeatures(boolean rhs1)
                       throws java.io.IOException,
                              AutomationException

Indicates if the created IEIDInfo enumeration should contain features.

Specified by:

setReturnFeatures in interface IEIDHelper

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

public void setOutputSpatialReferenceByRef(ISpatialReference rhs1)
                                    throws java.io.IOException,
                                           AutomationException

Spatial reference the returned geometries should be in.

Specified by:

setOutputSpatialReferenceByRef in interface IEIDHelper

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPartialComplexEdgeGeometry

public void setPartialComplexEdgeGeometry(boolean rhs1)
                                   throws java.io.IOException,
                                          AutomationException

Indicates if the EIDs representing partial complex edges return the geometry of the partial complex edge.

Specified by:

setPartialComplexEdgeGeometry in interface IEIDHelper

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createEnumEIDInfo

public IEnumEIDInfo createEnumEIDInfo(IEnumNetEID netEIDs)
                               throws java.io.IOException,
                                      AutomationException

Creates an enumeration of EIDInfo objects based on the specified EIDs and parameters on this EIDHelper object.

Specified by:

createEnumEIDInfo in interface IEIDHelper

Parameters:

netEIDs - A reference to a com.esri.arcgis.geodatabase.IEnumNetEID (in)

Returns:

A reference to a com.esri.arcgis.networkanalysis.IEnumEIDInfo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayEnvelopeByRef

public void setDisplayEnvelopeByRef(IEnvelope rhs1)
                             throws java.io.IOException,
                                    AutomationException

Envelope in which valid geometries and features must reside to be returned in the EnumEIDInfo object.

Specified by:

setDisplayEnvelopeByRef in interface IEIDHelper

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.