com.esri.arcgis.geodatabase
Interface INetworkQuery

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
INetworkQuery2, INetworkQuery3
All Known Implementing Classes:
INetworkQuery2Proxy, INetworkQuery3Proxy, INetworkQueryProxy, NetworkDataset

public interface INetworkQuery
extends java.io.Serializable

COM Interface 'INetworkQuery'. Generated 3/19/2015 1:20:57 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description: 'Provides access to members that query the elements of the network dataset.' 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 =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID73bed6fc_fda9_45b0_a82d_1b42d52a26d0
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void clearIDCache()
          Empties the contents of the index used for finding network elements by source.
 INetworkForwardStar createForwardStar()
          Creates a NetworkForwardStar object for traversing the network dataset.
 INetworkForwardStarAdjacencies createForwardStarAdjacencies()
          Creates a NetworkForwardStarAdjacencies container object for forward star queries.
 INetworkElement createNetworkElement(int elementType)
          Creates an uninitialized network element of the specified type for use in network dataset queries.
 int getComplexTurnCount()
          Number of turn elements in the network dataset having more than two edge elements participating.
 IEnumNetworkElement getEdgesByPosition(int sourceID, int oID, double position, boolean includeRelatedSDCHyperEdges)
          Edge elements in the network dataset with a from and to position that includes the given position for the given source object.
 IEnumNetworkElement getEdgesBySegment(int sourceID, int oID, double fromPosition, double toPosition)
          Edge elements in the network dataset with a from and to position included in the given range for the given source object.
 int getElementCount(int elementType)
          Number of network elements of the given type in the network dataset.
 IEnumNetworkElement getElements(int elementType)
          Enumeration of all elements in the network dataset of the given type.
 IEnumNetworkElement getElementsByOID(int sourceID, int oID)
          Elements in the network dataset corresponding to the given source object.
 IEnumNetworkElement getElementsByOIDs(int sourceID, ILongArray oids)
          Elements in the network dataset corresponding to the given source objects.
 IEnumNetworkElement getElementsForSource(int sourceID)
          Enumeration of all elements in the network dataset corresponding to the given source.
 int getMaxEID(int elementType)
          Highest element ID in the network dataset for the given element type.
 int getMaxValence()
          Maximum number of edge elements connected to any single junction element.
 void populateIDCache(int sourceID)
          Initializes the index used for quickly finding network elements for the given source ID.
 void queryEdge(int eID, int direction, INetworkEdge edge)
          Performs a network edge element query by element ID and edge direction and populates the given edge element object.
 void queryJunction(int eID, INetworkJunction junction)
          Performs a network junction element query by element ID and populates the given junction element object.
 void queryTurn(int eID, INetworkTurn turn)
          Performs a network turn element query by element ID and populates the given turn element object.
 

Field Detail

IID73bed6fc_fda9_45b0_a82d_1b42d52a26d0

static final int IID73bed6fc_fda9_45b0_a82d_1b42d52a26d0
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getMaxEID

int getMaxEID(int elementType)
              throws java.io.IOException,
                     AutomationException
Highest element ID in the network dataset for the given element type.

Parameters:
elementType - A com.esri.arcgis.geodatabase.esriNetworkElementType constant (in)
Returns:
The maxEID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxValence

int getMaxValence()
                  throws java.io.IOException,
                         AutomationException
Maximum number of edge elements connected to any single junction element.

Returns:
The maxValence
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElementCount

int getElementCount(int elementType)
                    throws java.io.IOException,
                           AutomationException
Number of network elements of the given type in the network dataset.

Parameters:
elementType - A com.esri.arcgis.geodatabase.esriNetworkElementType constant (in)
Returns:
The elementCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getComplexTurnCount

int getComplexTurnCount()
                        throws java.io.IOException,
                               AutomationException
Number of turn elements in the network dataset having more than two edge elements participating.

Returns:
The complexTurnCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createForwardStar

INetworkForwardStar createForwardStar()
                                      throws java.io.IOException,
                                             AutomationException
Creates a NetworkForwardStar object for traversing the network dataset.

Returns:
A reference to a com.esri.arcgis.geodatabase.INetworkForwardStar
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createForwardStarAdjacencies

INetworkForwardStarAdjacencies createForwardStarAdjacencies()
                                                            throws java.io.IOException,
                                                                   AutomationException
Creates a NetworkForwardStarAdjacencies container object for forward star queries.

Returns:
A reference to a com.esri.arcgis.geodatabase.INetworkForwardStarAdjacencies
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createNetworkElement

INetworkElement createNetworkElement(int elementType)
                                     throws java.io.IOException,
                                            AutomationException
Creates an uninitialized network element of the specified type for use in network dataset queries.

Parameters:
elementType - A com.esri.arcgis.geodatabase.esriNetworkElementType constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.INetworkElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryEdge

void queryEdge(int eID,
               int direction,
               INetworkEdge edge)
               throws java.io.IOException,
                      AutomationException
Performs a network edge element query by element ID and edge direction and populates the given edge element object.

Parameters:
eID - The eID (in)
direction - A com.esri.arcgis.geodatabase.esriNetworkEdgeDirection constant (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.

queryJunction

void queryJunction(int eID,
                   INetworkJunction junction)
                   throws java.io.IOException,
                          AutomationException
Performs a network junction element query by element ID and populates the given junction element object.

Parameters:
eID - The eID (in)
junction - 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.

queryTurn

void queryTurn(int eID,
               INetworkTurn turn)
               throws java.io.IOException,
                      AutomationException
Performs a network turn element query by element ID and populates the given turn element object.

Parameters:
eID - The eID (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.

getElementsByOID

IEnumNetworkElement getElementsByOID(int sourceID,
                                     int oID)
                                     throws java.io.IOException,
                                            AutomationException
Elements in the network dataset corresponding to the given source object.

Parameters:
sourceID - The sourceID (in)
oID - The oID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumNetworkElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEdgesByPosition

IEnumNetworkElement getEdgesByPosition(int sourceID,
                                       int oID,
                                       double position,
                                       boolean includeRelatedSDCHyperEdges)
                                       throws java.io.IOException,
                                              AutomationException
Edge elements in the network dataset with a from and to position that includes the given position for the given source object.

Parameters:
sourceID - The sourceID (in)
oID - The oID (in)
position - The position (in)
includeRelatedSDCHyperEdges - The includeRelatedSDCHyperEdges (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumNetworkElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEdgesBySegment

IEnumNetworkElement getEdgesBySegment(int sourceID,
                                      int oID,
                                      double fromPosition,
                                      double toPosition)
                                      throws java.io.IOException,
                                             AutomationException
Edge elements in the network dataset with a from and to position included in the given range for the given source object.

Parameters:
sourceID - The sourceID (in)
oID - The oID (in)
fromPosition - The fromPosition (in)
toPosition - The toPosition (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumNetworkElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElements

IEnumNetworkElement getElements(int elementType)
                                throws java.io.IOException,
                                       AutomationException
Enumeration of all elements in the network dataset of the given type.

Parameters:
elementType - A com.esri.arcgis.geodatabase.esriNetworkElementType constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumNetworkElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElementsByOIDs

IEnumNetworkElement getElementsByOIDs(int sourceID,
                                      ILongArray oids)
                                      throws java.io.IOException,
                                             AutomationException
Elements in the network dataset corresponding to the given source objects.

Parameters:
sourceID - The sourceID (in)
oids - A reference to a com.esri.arcgis.system.ILongArray (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumNetworkElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElementsForSource

IEnumNetworkElement getElementsForSource(int sourceID)
                                         throws java.io.IOException,
                                                AutomationException
Enumeration of all elements in the network dataset corresponding to the given source.

Parameters:
sourceID - The sourceID (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumNetworkElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearIDCache

void clearIDCache()
                  throws java.io.IOException,
                         AutomationException
Empties the contents of the index used for finding network elements by source.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

populateIDCache

void populateIDCache(int sourceID)
                     throws java.io.IOException,
                            AutomationException
Initializes the index used for quickly finding network elements for the given source ID.

Parameters:
sourceID - The sourceID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.