com.esri.arcgis.networkanalysis
Class EIDHelper

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

All Implemented Interfaces:

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

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

A container for getting the features and/or geometries from an enumeration of element IDs.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

EIDHelper()
Constructs a EIDHelper using ArcGIS Engine.

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

Method Summary

void	addField(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(Object o) Compare this object with another
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

EIDHelper

public EIDHelper()
          throws IOException,
                 UnknownHostException

Constructs a EIDHelper using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

EIDHelper

public EIDHelper(Object obj)
          throws 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:

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

setGeometricNetworkByRef

public void setGeometricNetworkByRef(IGeometricNetwork rhs1)
                              throws IOException,
                                     AutomationException

Geometric network from which these element IDs come.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGeometricNetworkByRef in interface IEIDHelper

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addField

public void addField(String field)
              throws IOException,
                     AutomationException

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

Remarks

Feature objects returned by this EIDHelper object are meant only for querying attribute values from the features and not for editing the features. These feature objects will only contain those fields specified using AddField. For optimization purposes, if no calls are made to AddField before calling CreateEnumEIDInfo, the feature objects returned will only contain the OID and Shape fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addField in interface IEIDHelper

Parameters:

field - The field (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearFields

public void clearFields()
                 throws IOException,
                        AutomationException

Clears the list of fields to return with the feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

clearFields in interface IEIDHelper

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnGeometries

public void setReturnGeometries(boolean rhs1)
                         throws IOException,
                                AutomationException

Indicates if the created EIDInfo enumeration should contain geometries.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setReturnGeometries in interface IEIDHelper

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnFeatures

public void setReturnFeatures(boolean rhs1)
                       throws IOException,
                              AutomationException

Indicates if the created IEIDInfo enumeration should contain features.

Remarks

Feature objects returned by this EIDHelper object are meant only for querying attribute values from the features and not for editing the features. These feature objects will only contain those fields specified using AddField. For optimization purposes, if no calls are made to AddField before calling CreateEnumEIDInfo, the feature objects returned will only contain the OID and Shape fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setReturnFeatures in interface IEIDHelper

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

public void setOutputSpatialReferenceByRef(ISpatialReference rhs1)
                                    throws IOException,
                                           AutomationException

Spatial reference the returned geometries should be in.

Remarks

If the OutputSpatialReference property is set to Nothing, then each geometry is returned in the spatial reference of the corresponding source feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOutputSpatialReferenceByRef in interface IEIDHelper

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPartialComplexEdgeGeometry

public void setPartialComplexEdgeGeometry(boolean rhs1)
                                   throws IOException,
                                          AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPartialComplexEdgeGeometry in interface IEIDHelper

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createEnumEIDInfo

public IEnumEIDInfo createEnumEIDInfo(IEnumNetEID netEIDs)
                               throws IOException,
                                      AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayEnvelopeByRef

public void setDisplayEnvelopeByRef(IEnvelope rhs1)
                             throws IOException,
                                    AutomationException

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

Remarks

If the DisplayEnvelope property is set to null, then all features and/or geometries corresponding to the EIDs are returned, regardless of their spatial position.

If a DisplayEnvelope is specified, then only those features and geometries that intersect the specified envelope will be populated in the enumeration. Note that there will still be an EIDInfo object returned for every element in the network, but the Feature and Geometry properties on the IEIDInfo interface will return null for those elements that lie outside of the envelope.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDisplayEnvelopeByRef in interface IEIDHelper

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.