com.esri.arcgis.geodatabase

Interface IUtilityNetworkQuery

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IUtilityNetworkQuery2

All Known Implementing Classes:

IUtilityNetworkQuery2Proxy, IUtilityNetworkQueryProxy

public interface IUtilityNetworkQuery
extends java.io.Serializable

COM Interface 'IUtilityNetworkQuery'. 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 utility network.' 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	IID7342c13e_0f9b_44d6_a210_1eec7295b4cd
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
void	getAllEIDs(long[][] eIDs, int[][] elementTypes) Returns all network index EIDs.
IUtilityNetworkAttribute	getAttributeByName(java.lang.String name) Returns the network attribute with the given name.
java.lang.Object	getAttributeValueByName(int elementType, long eID, java.lang.String attributeName) Returns the value of this network element for the given network attribute name.
java.lang.Object	getAttributeValueByUsageType(int elementType, long eID, int usageType) Returns the value of this network element for the given network attribute usage type.
void	getDirtyFeaturesOrObjects(ILongLongArray junctionEIDs, ILongLongArray edgeEIDs, ILongArray[] dirtyNetworkSourceIDs, IStringArray[] dirtyGlobalIDs) Return the corresponding network source ID and global ID information for any of the given set of junction and edge elements that are dirty based on matching global IDs in the dirty area table or relevant status bits set in the associations table.
void	getElements(GUID globalID, java.lang.Object[] eIDs, java.lang.Object[] elementTypes) Returns the elements in the utility network corresponding to the given source objects.
void	getElementsForSet(java.lang.String[] globalIDs, java.lang.Object[] eIDs, java.lang.Object[] elementTypes) Returns the elements in the utility network corresponding to the given source objects.
void	getFlowDirections(IEnvelope extent, int maxFlowDirectionCount, IArray[] arrows) Returns the flow directions.
IGeometry	getGeometry(int elementType, long eID) Returns the geometry in the utility network corresponding to the given element ID.
void	getSourceFeatureGlobalID(int elementType, long eID, int[] sourceID, GUID[] globalID) Performs a network source feature query for globalID by element ID.
void	getSourceFeatureOID(int elementType, long eID, int[] sourceID, int[] objectID) Performs a network source feature query for OID by element ID.
boolean	isHasDirtyElement(long[] junctionEIDs, long[] edgeEIDs) Returns whether any of the given set of junction and edge elements correspond to a feature in the dirty area table.
boolean	isSourceElementDirty(int elementType, long eID) Returns whether the feature that the source element represents is dirty.
boolean	isSpatial(int networkSourceID) Returns whether the network source corresponding to the given network source ID is spatial.
boolean	isValidEID(int elementType, long eID) Returns whether the specified element is part of the network.
void	queryAdjacentEdgesJunctions(long junctionEID, java.lang.Object[] adjacentEdges, java.lang.Object[] adjacentJunctions) Performs a network edge element query by element ID and edge direction and populates the given edge element object.
void	queryAdjacentEdgesJunctionsWithWeights(long junctionEID, boolean traversabilityBased, java.lang.Object[] adjacentEdges, java.lang.Object[] adjacentJunctions, ILongLongArray[] currentJunctionWeightIDs, IVariantArray[] currentJunctionWeightValues, int[] junctionConnectivityStatus, IArray[] edgeWeightIDs, IArray[] edgeWeightValues) Performs a network edge element query by element ID and edge direction and populates the given edge element object.
void	queryFromToJunctions(long edgeEID, long[] fromJunctionEID, long[] toJunctionEID) Queries the two end junction element IDs by edge element ID.
IArray	queryGeometries(int elementType, ILongLongArray eIDs, IDoubleArray overridePositionFroms, IDoubleArray overridePositionTos) Query geometries for the given network elements.
void	queryJunctionConnectivityStatus(long junctionEID, int[] junctionConnectivityStatus) Returns the junction connectivity status.

Field Detail

IID7342c13e_0f9b_44d6_a210_1eec7295b4cd

static final int IID7342c13e_0f9b_44d6_a210_1eec7295b4cd

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

getElements

void getElements(GUID globalID,
                 java.lang.Object[] eIDs,
                 java.lang.Object[] elementTypes)
          throws java.io.IOException,
                 AutomationException

Returns the elements in the utility network corresponding to the given source objects.

Parameters:

globalID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

eIDs - A Variant (out: use single element array)

elementTypes - A Variant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry(int elementType,
                      long eID)
               throws java.io.IOException,
                      AutomationException

Returns the geometry in the utility network corresponding to the given element ID.

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isValidEID

boolean isValidEID(int elementType,
                   long eID)
            throws java.io.IOException,
                   AutomationException

Returns whether the specified element is part of the network.

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

Returns:

The isValid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSourceFeatureGlobalID

void getSourceFeatureGlobalID(int elementType,
                              long eID,
                              int[] sourceID,
                              GUID[] globalID)
                       throws java.io.IOException,
                              AutomationException

Performs a network source feature query for globalID by element ID.

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

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

globalID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSourceFeatureOID

void getSourceFeatureOID(int elementType,
                         long eID,
                         int[] sourceID,
                         int[] objectID)
                  throws java.io.IOException,
                         AutomationException

Performs a network source feature query for OID by element ID.

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryFromToJunctions

void queryFromToJunctions(long edgeEID,
                          long[] fromJunctionEID,
                          long[] toJunctionEID)
                   throws java.io.IOException,
                          AutomationException

Queries the two end junction element IDs by edge element ID.

Parameters:

edgeEID - Signed 64-bit int (in)

fromJunctionEID - Signed 64-bit int (out: use single element array)

toJunctionEID - Signed 64-bit int (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAttributeValueByName

java.lang.Object getAttributeValueByName(int elementType,
                                         long eID,
                                         java.lang.String attributeName)
                                  throws java.io.IOException,
                                         AutomationException

Returns the value of this network element for the given network attribute name.

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

attributeName - The attributeName (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAttributeValueByUsageType

java.lang.Object getAttributeValueByUsageType(int elementType,
                                              long eID,
                                              int usageType)
                                       throws java.io.IOException,
                                              AutomationException

Returns the value of this network element for the given network attribute usage type.

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

usageType - A com.esri.arcgis.geodatabase.esriUtilityNetworkAttributeUsageType constant (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAttributeByName

IUtilityNetworkAttribute getAttributeByName(java.lang.String name)
                                     throws java.io.IOException,
                                            AutomationException

Returns the network attribute with the given name.

Parameters:

name - The name (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IUtilityNetworkAttribute

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAdjacentEdgesJunctions

void queryAdjacentEdgesJunctions(long junctionEID,
                                 java.lang.Object[] adjacentEdges,
                                 java.lang.Object[] adjacentJunctions)
                          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:

junctionEID - Signed 64-bit int (in)

adjacentEdges - A Variant (out: use single element array)

adjacentJunctions - A Variant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getElementsForSet

void getElementsForSet(java.lang.String[] globalIDs,
                       java.lang.Object[] eIDs,
                       java.lang.Object[] elementTypes)
                throws java.io.IOException,
                       AutomationException

Returns the elements in the utility network corresponding to the given source objects.

Parameters:

globalIDs - The globalIDs (in)

eIDs - A Variant (out: use single element array)

elementTypes - A Variant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSourceElementDirty

boolean isSourceElementDirty(int elementType,
                             long eID)
                      throws java.io.IOException,
                             AutomationException

Returns whether the feature that the source element represents is dirty.

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

Returns:

The isDirty

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAllEIDs

void getAllEIDs(long[][] eIDs,
                int[][] elementTypes)
         throws java.io.IOException,
                AutomationException

Returns all network index EIDs.

Parameters:

eIDs - Signed 64-bit int (out: use single element array)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasDirtyElement

boolean isHasDirtyElement(long[] junctionEIDs,
                          long[] edgeEIDs)
                   throws java.io.IOException,
                          AutomationException

Returns whether any of the given set of junction and edge elements correspond to a feature in the dirty area table.

Parameters:

junctionEIDs - Signed 64-bit int (in)

edgeEIDs - Signed 64-bit int (in)

Returns:

The hasDirtyElement

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDirtyFeaturesOrObjects

void getDirtyFeaturesOrObjects(ILongLongArray junctionEIDs,
                               ILongLongArray edgeEIDs,
                               ILongArray[] dirtyNetworkSourceIDs,
                               IStringArray[] dirtyGlobalIDs)
                        throws java.io.IOException,
                               AutomationException

Return the corresponding network source ID and global ID information for any of the given set of junction and edge elements that are dirty based on matching global IDs in the dirty area table or relevant status bits set in the associations table.

Parameters:

junctionEIDs - A reference to a com.esri.arcgis.system.ILongLongArray (in)

edgeEIDs - A reference to a com.esri.arcgis.system.ILongLongArray (in)

dirtyNetworkSourceIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

dirtyGlobalIDs - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAdjacentEdgesJunctionsWithWeights

void queryAdjacentEdgesJunctionsWithWeights(long junctionEID,
                                            boolean traversabilityBased,
                                            java.lang.Object[] adjacentEdges,
                                            java.lang.Object[] adjacentJunctions,
                                            ILongLongArray[] currentJunctionWeightIDs,
                                            IVariantArray[] currentJunctionWeightValues,
                                            int[] junctionConnectivityStatus,
                                            IArray[] edgeWeightIDs,
                                            IArray[] edgeWeightValues)
                                     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:

junctionEID - Signed 64-bit int (in)

traversabilityBased - The traversabilityBased (in)

adjacentEdges - A Variant (out: use single element array)

adjacentJunctions - A Variant (out: use single element array)

currentJunctionWeightIDs - A reference to a com.esri.arcgis.system.ILongLongArray (out: use single element array)

currentJunctionWeightValues - A reference to a com.esri.arcgis.system.IVariantArray (out: use single element array)

junctionConnectivityStatus - A com.esri.arcgis.geodatabase.esriJunctionConnectivityStatus constant (out: use single element array)

edgeWeightIDs - A reference to a com.esri.arcgis.system.IArray (out: use single element array)

edgeWeightValues - A reference to a com.esri.arcgis.system.IArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryJunctionConnectivityStatus

void queryJunctionConnectivityStatus(long junctionEID,
                                     int[] junctionConnectivityStatus)
                              throws java.io.IOException,
                                     AutomationException

Returns the junction connectivity status.

Parameters:

junctionEID - Signed 64-bit int (in)

junctionConnectivityStatus - A com.esri.arcgis.geodatabase.esriJunctionConnectivityStatus constant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFlowDirections

void getFlowDirections(IEnvelope extent,
                       int maxFlowDirectionCount,
                       IArray[] arrows)
                throws java.io.IOException,
                       AutomationException

Returns the flow directions.

Parameters:

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

maxFlowDirectionCount - The maxFlowDirectionCount (in)

arrows - A reference to a com.esri.arcgis.system.IArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSpatial

boolean isSpatial(int networkSourceID)
           throws java.io.IOException,
                  AutomationException

Returns whether the network source corresponding to the given network source ID is spatial.

Parameters:

networkSourceID - The networkSourceID (in)

Returns:

The isSpatial

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryGeometries

IArray queryGeometries(int elementType,
                       ILongLongArray eIDs,
                       IDoubleArray overridePositionFroms,
                       IDoubleArray overridePositionTos)
                throws java.io.IOException,
                       AutomationException

Query geometries for the given network elements.

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eIDs - A reference to a com.esri.arcgis.system.ILongLongArray (in)

overridePositionFroms - A reference to a com.esri.arcgis.system.IDoubleArray (in)

overridePositionTos - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.