com.esri.arcgis.location
Interface IRouteLocator2

All Superinterfaces:

IRouteLocator, Serializable

All Known Implementing Classes:

IRouteLocator2Proxy, RouteMeasureLocator

public interface IRouteLocator2
extends IRouteLocator, Serializable

Provides access to properties and methods of a route locator.

Remarks

The IRouteLocator2 Interface allows you to return a route location, IRouteLocation, by specifying an envelope, IEnvelope.

Product Availability

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

Method Summary

IEnumRouteIdentifyResult	identify(IEnvelope searchEnvelope, String whereClause) Identify route locations in an envelope.
boolean	isHasZs() Indicates whether the route locator is Z-Aware.
boolean	isRouteIDIsIndexed() Indicates if the route ID has an index.

Methods inherited from interface com.esri.arcgis.location.IRouteLocator

getExtent, getMeasureUnit, getRouteFeatureClass, getRouteGeometry, getRouteIDFieldIndex, getRouteIDFieldName, getRouteIDFieldNameDelimited, getRouteWhereClause, getSpatialReference, isHasSpatialIndex, isRouteIDIsString, isRouteIDIsUnique, locate, locateRow, setRouteWhereClause

Method Detail

identify

IEnumRouteIdentifyResult identify(IEnvelope searchEnvelope,
                                  String whereClause)
                                  throws IOException,
                                         AutomationException

Identify route locations in an envelope.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

whereClause - The whereClause (in)

Returns:

A reference to a com.esri.arcgis.location.IEnumRouteIdentifyResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasZs

boolean isHasZs()
                throws IOException,
                       AutomationException

Indicates whether the route locator is Z-Aware.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The hasZs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRouteIDIsIndexed

boolean isRouteIDIsIndexed()
                           throws IOException,
                                  AutomationException

Indicates if the route ID has an index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The routeIDIsIndexed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.