com.esri.arcgis.geodatabase

Interface INetworkQuery

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

INetworkQueryProxy

public interface INetworkQuery
extends java.io.Serializable

COM Interface 'INetworkQuery'. Generated 9/24/2024 11:01:30 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

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

Fields

Modifier and Type	Field and Description
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

Modifier and Type	Method and Description
void	clearIDCache() Empties the contents of the index used for finding network elements by source.
java.util.Date	convertLocalTimeToUTCTime(int localTimeZoneID, java.util.Date localTime) Converts local time for the given time zone to UTC time.
java.util.Date	convertUTCTimeToLocalTime(int localTimeZoneID, java.util.Date utcTime) Converts UTC time to local time for the given time zone.
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, long oID, double position) 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, long 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, long oID) Elements in the network dataset corresponding to the given source object.
IEnumNetworkElement	getElementsByOIDs(int sourceID, ILongLongArray 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.
long	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.
int	getTimeZoneID(INetworkElement networkElement) The time zone ID for the given network element.
void	populateIDCache(int sourceID) Initializes the index used for quickly finding network elements for the given source ID.
void	queryEdge(long 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(long eID, INetworkJunction junction) Performs a network junction element query by element ID and populates the given junction element object.
void	queryTurn(long eID, INetworkTurn turn) Performs a network turn element query by element ID and populates the given turn element object.
void	refreshDynamicTrafficData(java.util.Date utcTime, int utcTimeUsage, java.util.Date[] pDynamicTrafficUTCStartTime, java.util.Date[] pDynamicTrafficUTCEndTime) Refreshes the current dynamic traffic data referenced by the network dataset based on the specified time and usage.

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

long 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:

Signed 64-bit int

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(long 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 - Signed 64-bit int (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(long 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 - Signed 64-bit int (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(long 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 - Signed 64-bit int (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,
                                     long oID)
                              throws java.io.IOException,
                                     AutomationException

Elements in the network dataset corresponding to the given source object.

Parameters:

sourceID - The sourceID (in)

oID - Signed 64-bit int (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,
                                       long oID,
                                       double position)
                                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 - Signed 64-bit int (in)

position - The position (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,
                                      long 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 - Signed 64-bit int (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,
                                      ILongLongArray 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.ILongLongArray (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.

getTimeZoneID

int getTimeZoneID(INetworkElement networkElement)
           throws java.io.IOException,
                  AutomationException

The time zone ID for the given network element.

Parameters:

networkElement - A reference to a com.esri.arcgis.geodatabase.INetworkElement (in)

Returns:

The timeZoneID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertLocalTimeToUTCTime

java.util.Date convertLocalTimeToUTCTime(int localTimeZoneID,
                                         java.util.Date localTime)
                                  throws java.io.IOException,
                                         AutomationException

Converts local time for the given time zone to UTC time.

Parameters:

localTimeZoneID - The localTimeZoneID (in)

localTime - The localTime (in)

Returns:

The utcTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertUTCTimeToLocalTime

java.util.Date convertUTCTimeToLocalTime(int localTimeZoneID,
                                         java.util.Date utcTime)
                                  throws java.io.IOException,
                                         AutomationException

Converts UTC time to local time for the given time zone.

Parameters:

localTimeZoneID - The localTimeZoneID (in)

utcTime - The utcTime (in)

Returns:

The localTime

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refreshDynamicTrafficData

void refreshDynamicTrafficData(java.util.Date utcTime,
                               int utcTimeUsage,
                               java.util.Date[] pDynamicTrafficUTCStartTime,
                               java.util.Date[] pDynamicTrafficUTCEndTime)
                        throws java.io.IOException,
                               AutomationException

Refreshes the current dynamic traffic data referenced by the network dataset based on the specified time and usage.

Parameters:

utcTime - The utcTime (in)

utcTimeUsage - A com.esri.arcgis.geodatabase.esriNetworkTimeUsage constant (in)

pDynamicTrafficUTCStartTime - The pDynamicTrafficUTCStartTime (out: use single element array)

pDynamicTrafficUTCEndTime - The pDynamicTrafficUTCEndTime (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.