com.esri.arcgis.geodatabase
Class NetworkEdge

java.lang.Object
  extended by com.esri.arcgis.geodatabase.NetworkEdge
All Implemented Interfaces:
INetworkEdge, INetworkEdge2, INetworkElement, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class NetworkEdge
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INetworkElement, INetworkEdge, INetworkEdge2, ISupportErrorInfo

COM Class 'NetworkEdge'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'A container for querying information on a network dataset edge element.' 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.geodatabase.INetworkEdge2
DISPID_1610874881_GET_NAME, DISPID_1610874882_GET_NAME, DISPID_1610874883_GET_NAME, DISPID_1610874884_GET_NAME, DISPID_1610874885_NAME, DISPID_1610874886_GET_NAME, DISPID_1610874887_NAME, DISPID_210_GET_NAME, IID, IID97669d60_6fea_450d_aad4_a917f19fd420, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.INetworkEdge
DISPID_100_GET_NAME, DISPID_110_NAME, DISPID_130_GET_NAME, DISPID_140_GET_NAME, DISPID_150_GET_NAME, DISPID_160_GET_NAME, DISPID_170_GET_NAME, DISPID_180_NAME, DISPID_190_NAME, DISPID_200_NAME, IIDeadcd556_0857_41d9_9714_03b0dbb16dfb
 
Fields inherited from interface com.esri.arcgis.geodatabase.INetworkElement
DISPID_10_GET_NAME, DISPID_20_GET_NAME, DISPID_30_GET_NAME, DISPID_40_GET_NAME, DISPID_50_GET_NAME, DISPID_60_GET_NAME, IIDed843586_99b4_4e36_9684_5bec34938906
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
NetworkEdge(java.lang.Object obj)
          Construct a NetworkEdge using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 java.lang.Object getAttributeValue(int attributeID)
          Value of this network element for the given network attribute ID.
 java.lang.Object getAttributeValueAtTime(int attributeID, java.util.Date localTime, int timeUsage)
          Value of this network element for the given network attribute ID and local time.
 java.lang.Object getAttributeValueByName(java.lang.String attributeName)
          Value of this network element for the given network attribute name.
 int getCoveredEdgeCount()
          Returns the number of edges covered by this edge.
 int getDirection()
          Direction in which this network edge element is oriented relative to the direction of its source object.
 int getEID()
          Element ID for this network element.
 int getElementType()
          Type of this network element.
 double getFromAzimuth()
          Direction of travel at the from-end of the network edge element.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getOID()
          Object ID of the object corresponding to this network element.
 java.lang.Object getPartialEdgeAttributeValue(double fromPosition, double toPosition, int attributeID)
          Value of this edge element along the given range for the given network attribute ID.
 java.lang.Object getPartialEdgeAttributeValueAtTime(double fromPosition, double toPosition, int attributeID, java.util.Date localTime, int timeUsage)
          Value of this partial edge element for the given network attribute ID and local.
 double getPositionAlongObject(double positionAlongElement)
          Position along the source object at which the specified position along the network edge element lies.
 int getSourceID()
          ID of the network dataset source from which this network element was derived.
 double getToAzimuth()
          Direction of travel at the to-end of the network edge element.
 int getTurnCount()
          Number of network turn elements in which this network edge element participates.
 int getTurnParticipationType()
          Participation of this network edge element within a network turn element.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isHasCoveringHyperedge()
          Indicates if the network edge element has a covering hyperedge.
 boolean isHyperedge()
          Indicates if the network edge element is a hyperedge.
 void queryCoveredEdge(int index, INetworkEdge edge)
          Used to iterate over the edges covered by this edge.
 void queryCoveringHyperedge(INetworkEdge edge, double[] fromPosition, double[] toPosition)
          Queries the covering hyperedge of the network edge element and returns its related positions along the covering hyperedge.
 void queryEdgeInOtherDirection(INetworkEdge edge)
          Queries the network edge element corresponding to the reverse traversal of this network edge element.
 void queryJunctions(INetworkJunction fromJunction, INetworkJunction toJunction)
          Queries the network junction elements adjacent to this network edge element.
 void queryPositions(double[] fromPosition, double[] toPosition)
          Queries the positions along the source object at which the from-end and to-end of the network edge element lies.
 void queryTurn(int index, INetworkTurn turn)
          Queries the index'th network turn element in which this network edge element participates.
 void release()
          Release a NetworkEdge.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NetworkEdge

public NetworkEdge(java.lang.Object obj)
            throws java.io.IOException
Construct a NetworkEdge using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NetworkEdge.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
NetworkEdge o = (NetworkEdge)obj; // will not work

NetworkEdge o = new NetworkEdge(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
java.io.IOException - if there are interop problems NetworkEdge theNetworkEdge = (NetworkEdge) obj;
Method Detail

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getEID

public int getEID()
           throws java.io.IOException,
                  AutomationException
Element ID for this network element.

Specified by:
getEID in interface INetworkElement
Returns:
The eID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElementType

public int getElementType()
                   throws java.io.IOException,
                          AutomationException
Type of this network element.

Specified by:
getElementType in interface INetworkElement
Returns:
A com.esri.arcgis.geodatabase.esriNetworkElementType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSourceID

public int getSourceID()
                throws java.io.IOException,
                       AutomationException
ID of the network dataset source from which this network element was derived.

Specified by:
getSourceID in interface INetworkElement
Returns:
The sourceID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOID

public int getOID()
           throws java.io.IOException,
                  AutomationException
Object ID of the object corresponding to this network element.

Specified by:
getOID in interface INetworkElement
Returns:
The oID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttributeValue

public java.lang.Object getAttributeValue(int attributeID)
                                   throws java.io.IOException,
                                          AutomationException
Value of this network element for the given network attribute ID.

Specified by:
getAttributeValue in interface INetworkElement
Parameters:
attributeID - The attributeID (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttributeValueByName

public java.lang.Object getAttributeValueByName(java.lang.String attributeName)
                                         throws java.io.IOException,
                                                AutomationException
Value of this network element for the given network attribute name.

Specified by:
getAttributeValueByName in interface INetworkElement
Parameters:
attributeName - The attributeName (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDirection

public int getDirection()
                 throws java.io.IOException,
                        AutomationException
Direction in which this network edge element is oriented relative to the direction of its source object.

Specified by:
getDirection in interface INetworkEdge
Returns:
A com.esri.arcgis.geodatabase.esriNetworkEdgeDirection constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryPositions

public void queryPositions(double[] fromPosition,
                           double[] toPosition)
                    throws java.io.IOException,
                           AutomationException
Queries the positions along the source object at which the from-end and to-end of the network edge element lies.

Specified by:
queryPositions in interface INetworkEdge
Parameters:
fromPosition - The fromPosition (out: use single element array)
toPosition - The toPosition (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFromAzimuth

public double getFromAzimuth()
                      throws java.io.IOException,
                             AutomationException
Direction of travel at the from-end of the network edge element.

Specified by:
getFromAzimuth in interface INetworkEdge
Returns:
The fromAzimuth
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getToAzimuth

public double getToAzimuth()
                    throws java.io.IOException,
                           AutomationException
Direction of travel at the to-end of the network edge element.

Specified by:
getToAzimuth in interface INetworkEdge
Returns:
The toAzimuth
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTurnParticipationType

public int getTurnParticipationType()
                             throws java.io.IOException,
                                    AutomationException
Participation of this network edge element within a network turn element.

Specified by:
getTurnParticipationType in interface INetworkEdge
Returns:
A com.esri.arcgis.geodatabase.esriNetworkTurnParticipationType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPositionAlongObject

public double getPositionAlongObject(double positionAlongElement)
                              throws java.io.IOException,
                                     AutomationException
Position along the source object at which the specified position along the network edge element lies.

Specified by:
getPositionAlongObject in interface INetworkEdge
Parameters:
positionAlongElement - The positionAlongElement (in)
Returns:
The positionAlongObject
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTurnCount

public int getTurnCount()
                 throws java.io.IOException,
                        AutomationException
Number of network turn elements in which this network edge element participates.

Specified by:
getTurnCount in interface INetworkEdge
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryTurn

public void queryTurn(int index,
                      INetworkTurn turn)
               throws java.io.IOException,
                      AutomationException
Queries the index'th network turn element in which this network edge element participates.

Specified by:
queryTurn in interface INetworkEdge
Parameters:
index - The index (in)
turn - A reference to a com.esri.arcgis.geodatabase.INetworkTurn (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryEdgeInOtherDirection

public void queryEdgeInOtherDirection(INetworkEdge edge)
                               throws java.io.IOException,
                                      AutomationException
Queries the network edge element corresponding to the reverse traversal of this network edge element.

Specified by:
queryEdgeInOtherDirection in interface INetworkEdge
Parameters:
edge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryJunctions

public void queryJunctions(INetworkJunction fromJunction,
                           INetworkJunction toJunction)
                    throws java.io.IOException,
                           AutomationException
Queries the network junction elements adjacent to this network edge element.

Specified by:
queryJunctions in interface INetworkEdge
Parameters:
fromJunction - A reference to a com.esri.arcgis.geodatabase.INetworkJunction (in)
toJunction - A reference to a com.esri.arcgis.geodatabase.INetworkJunction (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPartialEdgeAttributeValue

public java.lang.Object getPartialEdgeAttributeValue(double fromPosition,
                                                     double toPosition,
                                                     int attributeID)
                                              throws java.io.IOException,
                                                     AutomationException
Value of this edge element along the given range for the given network attribute ID.

Specified by:
getPartialEdgeAttributeValue in interface INetworkEdge2
Parameters:
fromPosition - The fromPosition (in)
toPosition - The toPosition (in)
attributeID - The attributeID (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttributeValueAtTime

public java.lang.Object getAttributeValueAtTime(int attributeID,
                                                java.util.Date localTime,
                                                int timeUsage)
                                         throws java.io.IOException,
                                                AutomationException
Value of this network element for the given network attribute ID and local time.

Specified by:
getAttributeValueAtTime in interface INetworkEdge2
Parameters:
attributeID - The attributeID (in)
localTime - The localTime (in)
timeUsage - A com.esri.arcgis.geodatabase.esriNetworkTimeUsage constant (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPartialEdgeAttributeValueAtTime

public java.lang.Object getPartialEdgeAttributeValueAtTime(double fromPosition,
                                                           double toPosition,
                                                           int attributeID,
                                                           java.util.Date localTime,
                                                           int timeUsage)
                                                    throws java.io.IOException,
                                                           AutomationException
Value of this partial edge element for the given network attribute ID and local.

Specified by:
getPartialEdgeAttributeValueAtTime in interface INetworkEdge2
Parameters:
fromPosition - The fromPosition (in)
toPosition - The toPosition (in)
attributeID - The attributeID (in)
localTime - The localTime (in)
timeUsage - A com.esri.arcgis.geodatabase.esriNetworkTimeUsage constant (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHyperedge

public boolean isHyperedge()
                    throws java.io.IOException,
                           AutomationException
Indicates if the network edge element is a hyperedge.

Specified by:
isHyperedge in interface INetworkEdge2
Returns:
The isHyperedge
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasCoveringHyperedge

public boolean isHasCoveringHyperedge()
                               throws java.io.IOException,
                                      AutomationException
Indicates if the network edge element has a covering hyperedge.

Specified by:
isHasCoveringHyperedge in interface INetworkEdge2
Returns:
The hasCoveringHyperedge
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryCoveringHyperedge

public void queryCoveringHyperedge(INetworkEdge edge,
                                   double[] fromPosition,
                                   double[] toPosition)
                            throws java.io.IOException,
                                   AutomationException
Queries the covering hyperedge of the network edge element and returns its related positions along the covering hyperedge.

Specified by:
queryCoveringHyperedge in interface INetworkEdge2
Parameters:
edge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)
fromPosition - The fromPosition (out: use single element array)
toPosition - The toPosition (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCoveredEdgeCount

public int getCoveredEdgeCount()
                        throws java.io.IOException,
                               AutomationException
Returns the number of edges covered by this edge.

Specified by:
getCoveredEdgeCount in interface INetworkEdge2
Returns:
The coveredEdgeCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryCoveredEdge

public void queryCoveredEdge(int index,
                             INetworkEdge edge)
                      throws java.io.IOException,
                             AutomationException
Used to iterate over the edges covered by this edge.

Specified by:
queryCoveredEdge in interface INetworkEdge2
Parameters:
index - The index (in)
edge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (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
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.