com.esri.arcgis.geodatabase
Class INetElementsProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geodatabase.INetElementsProxy
All Implemented Interfaces:
INetElements, Externalizable, Serializable

public class INetElementsProxy
extends com.esri.arcgis.interop.Dispatch
implements INetElements, Serializable

Provides access to members that convert between user IDs and network element IDs (EIDs).

Remarks

Each element in a logical network has a unique Element ID (EID). The EID can be accessed by providing the following three IDs: UserClassID, UserID, and UserSubID. If the network is part of a geometric network, the UserClassID and UserID correspond to the FeatureClassID and OID of the feature. The UserSubID is the ID of the subelement of the feature.

When To Use

Use the INetElements interface to convert between Element IDs (EIDs) and user-friendly IDs of individual elements in your network, or to check the validity of an EID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
INetElementDescription, INetElementDescriptionEdit, INetElementClass, INetElements, Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  INetElementsProxy()
           
  INetElementsProxy(Object obj)
           
protected INetElementsProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 int getEID(int userClassID, int userID, int userSubID, int elementType)
          Returns the network element ID (EID).
 int getEIDCount(int userClassID, int userID, int elementType)
          Returns the number of network element IDs (EIDs) corresponding to the specified user class ID and user ID.
 IEnumNetEID getEIDs(int userClassID, int userID, int elementType)
          Returns the network element IDs (EIDs) corresponding to the specified user classID and user ID.
 boolean isValidElement(int eID, int elementType)
          Returns whether the specified element is part of the network.
 void queryIDs(int eID, int elementType, int[] userClassID, int[] userID, int[] userSubID)
          Returns the user class ID, user ID, and user sub ID for the specified network element.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

INetElementsProxy

public INetElementsProxy()

INetElementsProxy

public INetElementsProxy(Object obj)
                  throws IOException
Throws:
IOException

INetElementsProxy

protected INetElementsProxy(Object obj,
                            String iid)
                     throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

isValidElement

public boolean isValidElement(int eID,
                              int elementType)
                       throws IOException,
                              AutomationException
Returns whether the specified element is part of the network.

Remarks

The valid state of an element can be either true or false. A state of true means the element is part of the network while a state of false means it is not part of the network.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isValidElement in interface INetElements
Parameters:
eID - The eID (in)
elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)
Returns:
The validState
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEID

public int getEID(int userClassID,
                  int userID,
                  int userSubID,
                  int elementType)
           throws IOException,
                  AutomationException
Returns the network element ID (EID).

Remarks

Pass in a valid UserClassID, UserID, UserSubID, and esriElementType and the corresponding Element ID (EID) in the logical network is returned. If no network elements match the given UserClassID, UserID, UserSubID, and esriElementType, then 0 is returned.
If the network is part of a geometric network, the UserClassID and UserID correspond to the FeatureClassID and OID of the feature. The UserSubID is the ID of the subelement of the feature.
Entering a negative value for the UserSubID will return the first EID in the table that matches the specified UserClassID and UserID. This is not necessarily the lowest-valued EID matching the specified UserClassID and UserID, nor necessarily the EID corresponding to the lowest-valued SubID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEID in interface INetElements
Parameters:
userClassID - The userClassID (in)
userID - The userID (in)
userSubID - The userSubID (in)
elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)
Returns:
The eID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEIDCount

public int getEIDCount(int userClassID,
                       int userID,
                       int elementType)
                throws IOException,
                       AutomationException
Returns the number of network element IDs (EIDs) corresponding to the specified user class ID and user ID.

Remarks

Pass in a valid UserClassID, UserID, and esriElementType and the number of corresponding Element IDs (EIDs) in the logical network is returned. If no network elements match the given UserClassID, UserID, and esriElementType, then 0 is returned.
If the network is part of a geometric network, then the UserClassID and UserID correspond to the FeatureClassID and OID of the feature. For complex edge and junction features, this method returns then number of corresponding Element IDs (EIDs) in the logical network. For simple edge and junction features, this method will return 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEIDCount in interface INetElements
Parameters:
userClassID - The userClassID (in)
userID - The userID (in)
elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)
Returns:
The eIDCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEIDs

public IEnumNetEID getEIDs(int userClassID,
                           int userID,
                           int elementType)
                    throws IOException,
                           AutomationException
Returns the network element IDs (EIDs) corresponding to the specified user classID and user ID.

Remarks

Pass in a valid UserClassID, UserID, and esriElementType and an enumeration of the corresponding Element IDs (EIDs) in the logical network is returned. If no network elements match the given UserClassID, UserID, and esriElementType, then an empty enumeration of EIDs is returned.
If the network is part of a geometric network, then the UserClassID and UserID correspond to the FeatureClassID and OID of the feature. For complex edge and junction features, this method returns an enumeration of the corresponding Element IDs in the logical network. For simple edge and junction features, the enumeration will always contain only one Element ID (EID).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEIDs in interface INetElements
Parameters:
userClassID - The userClassID (in)
userID - The userID (in)
elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumNetEID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryIDs

public void queryIDs(int eID,
                     int elementType,
                     int[] userClassID,
                     int[] userID,
                     int[] userSubID)
              throws IOException,
                     AutomationException
Returns the user class ID, user ID, and user sub ID for the specified network element.

Remarks

Pass an a valid Element ID (EID) and its esriElementType and the IDs of the corresponding feature in the geometric network are returned.
If the network is part of a geometric network, the UserClassID and UserID correspond to the FeatureClassID and OID of the feature. The UserSubID is the ID of the subelement of the feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
queryIDs in interface INetElements
Parameters:
eID - The eID (in)
elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)
userClassID - The userClassID (out: use single element array)
userID - The userID (out: use single element array)
userSubID - The userSubID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException