com.esri.arcgis.networkanalyst
Interface INATraversalResultQuery

All Superinterfaces:

Serializable

All Known Implementing Classes:

NATraversalResult

public interface INATraversalResultQuery
extends Serializable

Provides access to the results of an analysis.

Remarks

The INATraversalResultQuery interface is used to navigate through the traversal result and to provide the field names for various fields on the traversal classes.

You can use the properties ending with "FieldName" to get the fields holding the information about what the NATraversalResultElement is referencing. Here is a description about what each field holds:

• ElementIDFieldName - The ObjectID of the NATraversalResultElement.
• SourceIDFieldName - The SourceID of the feature class the NATraversalResultElement is referencing. This references the SourceID of a NATraversalResultSource accessed through INATraversalResult.
• SourceOIDFieldName - The ObjectID of the Feature in the NetworkDataset's or NAContext's FeatureClass.
• FromPositionFieldName - The starting position of an NATraversalResultElement on the underlying feature in the network dataset.
• ToPositionFieldName - The ending position of an NATraversalResultElement on the underlying feature in the network dataset.

Use the FeatureClass property to return a feature class holding all the NATraversalResultElements of a specific type (esriNETJunction, esriNETEdge, esriNETTurn). This feature class can be accessed like any other feature class in ArcGIS.

Use the SearchConnected method to return the NATraversalResultElements that are connected to the input NATraversalResultElement.

Product Availability

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

Method Summary

String	getElementIDFieldName() The element ID field name.
IFeatureClass	getFeatureClass(int networkElementType) The feature class by element type.
String	getFromEdgeIDFieldName() The from edge ID field name.
String	getFromJunctionIDFieldName() The from junction ID field name.
String	getFromPositionFieldName() The from position field name.
String	getSourceIDFieldName() The source ID field name.
String	getSourceOIDFieldName() The source OID field name.
String	getToEdgeIDFieldName() The to edge ID field name.
String	getToJunctionIDFieldName() The to junction ID field name.
String	getToPositionFieldName() The to position field name.
IFeatureCursor	searchConnected(INATraversalResultElement element, int searchedElementType, int searchedDirection, boolean recycle) Returns a connected set of elements in the result.

Method Detail

getFeatureClass

IFeatureClass getFeatureClass(int networkElementType)
                              throws IOException,
                                     AutomationException

The feature class by element type.

Product Availability

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

Parameters:

networkElementType - A com.esri.arcgis.geodatabase.esriNetworkElementType constant (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchConnected

IFeatureCursor searchConnected(INATraversalResultElement element,
                               int searchedElementType,
                               int searchedDirection,
                               boolean recycle)
                               throws IOException,
                                      AutomationException

Returns a connected set of elements in the result.

Remarks

The SearchConnected method returns the NATraversalResultElements that are connected to the input NATraversalResultElement.

The searchedElementType parameter allows you to specify if you want to find the connected junctions, edges, or turns. The searchedDirection parameter specifies the direction. For example, esriRelDirectionForward will constrain the returned elements to just be those that were reached in the traversal after the current element.

The recycle parameter specifies that the same feature object should be used over and over with the underlying data just switched out. Use this option if you don't need to keep references to multiple traversal elements at the same time.

Product Availability

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

Parameters:

element - A reference to a com.esri.arcgis.networkanalyst.INATraversalResultElement (in)

searchedElementType - A com.esri.arcgis.geodatabase.esriNetworkElementType constant (in)

searchedDirection - A com.esri.arcgis.geodatabase.esriRelDirection constant (in)

recycle - The recycle (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElementIDFieldName

String getElementIDFieldName()
                             throws IOException,
                                    AutomationException

The element ID field name.

Remarks

Specifies the ElementID field name.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceIDFieldName

String getSourceIDFieldName()
                            throws IOException,
                                   AutomationException

The source ID field name.

Remarks

Specifies the SourceID field name.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceOIDFieldName

String getSourceOIDFieldName()
                             throws IOException,
                                    AutomationException

The source OID field name.

Remarks

Specifies the SourceOID field name.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromPositionFieldName

String getFromPositionFieldName()
                                throws IOException,
                                       AutomationException

The from position field name.

Remarks

Specifies the FromPosition field name.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToPositionFieldName

String getToPositionFieldName()
                              throws IOException,
                                     AutomationException

The to position field name.

Remarks

Specifies the ToPosition field name.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromJunctionIDFieldName

String getFromJunctionIDFieldName()
                                  throws IOException,
                                         AutomationException

The from junction ID field name.

Remarks

Specifies the FromJunctionID field name.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToJunctionIDFieldName

String getToJunctionIDFieldName()
                                throws IOException,
                                       AutomationException

The to junction ID field name.

Remarks

Specifies the ToJunctionID field name.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromEdgeIDFieldName

String getFromEdgeIDFieldName()
                              throws IOException,
                                     AutomationException

The from edge ID field name.

Remarks

Specifies the FromEdgeID field name.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToEdgeIDFieldName

String getToEdgeIDFieldName()
                            throws IOException,
                                   AutomationException

The to edge ID field name.

Remarks

Specifies the ToEdgeID field name.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.