com.esri.arcgis.location
Interface IRouteLocator

All Superinterfaces:

Serializable

All Known Subinterfaces:

IRouteLocator2

All Known Implementing Classes:

IRouteLocator2Proxy, IRouteLocatorProxy, RouteMeasureLocator

public interface IRouteLocator
extends Serializable

Provides access to properties and methods of a route locator.

Superseded By

IRouteLocator2

Product Availability

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

Method Summary

IEnvelope	getExtent() The route locator's extent (same a route feature class' extent).
int	getMeasureUnit() The units of the route measures.
IFeatureClass	getRouteFeatureClass() The route feature class (Polyline with M feature class).
void	getRouteGeometry(IRouteLocation routeLocation, IGeometry[] routeGeometry, int[] locatingError) The route(s) corresponding to the route location.
int	getRouteIDFieldIndex() The field index of the route identifier.
String	getRouteIDFieldName() The route identifier field from the route feature class.
String	getRouteIDFieldNameDelimited() The delimited route identifier field of the route feature class.
String	getRouteWhereClause() The where clause that limits the routes events can be located on.
ISpatialReference	getSpatialReference() The route locator's spatial reference (same as route feature class' spatial reference).
boolean	isHasSpatialIndex() Indicates if the route feature class has a spatial index.
boolean	isRouteIDIsString() Indicates if the route identifier field type is string.
boolean	isRouteIDIsUnique() Indicates whether the route ID is unique (Obsolete).
void	locate(IRouteLocation routeLocation, IGeometry[] result, int[] locatingError) Locates a point or line route location.
void	locateRow(IRouteEventProperties eventProperties, IRow row, IGeometry[] result, int[] locatingError) Locates an event table row containing a point or line route location.
void	setRouteWhereClause(String whereClause) The where clause that limits the routes events can be located on.

Method Detail

getRouteFeatureClass

IFeatureClass getRouteFeatureClass()
                                   throws IOException,
                                          AutomationException

The route feature class (Polyline with M feature class).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getRouteIDFieldName

String getRouteIDFieldName()
                           throws IOException,
                                  AutomationException

The route identifier field from the route feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The rid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldIndex

int getRouteIDFieldIndex()
                         throws IOException,
                                AutomationException

The field index of the route identifier.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The routeIDIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldNameDelimited

String getRouteIDFieldNameDelimited()
                                    throws IOException,
                                           AutomationException

The delimited route identifier field of the route feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The rid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRouteIDIsUnique

boolean isRouteIDIsUnique()
                          throws IOException,
                                 AutomationException

Indicates whether the route ID is unique (Obsolete).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The routeIDIsUnique

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRouteIDIsString

boolean isRouteIDIsString()
                          throws IOException,
                                 AutomationException

Indicates if the route identifier field type is string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The routeIDIsString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteWhereClause

void setRouteWhereClause(String whereClause)
                         throws IOException,
                                AutomationException

The where clause that limits the routes events can be located on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

whereClause - The whereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteWhereClause

String getRouteWhereClause()
                           throws IOException,
                                  AutomationException

The where clause that limits the routes events can be located on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The whereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMeasureUnit

int getMeasureUnit()
                   throws IOException,
                          AutomationException

The units of the route measures.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The route locator's extent (same a route feature class' extent).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The route locator's spatial reference (same as route feature class' spatial reference).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasSpatialIndex

boolean isHasSpatialIndex()
                          throws IOException,
                                 AutomationException

Indicates if the route feature class has a spatial index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The hasSpatialIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

locate

void locate(IRouteLocation routeLocation,
            IGeometry[] result,
            int[] locatingError)
            throws IOException,
                   AutomationException

Locates a point or line route location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

routeLocation - A reference to a com.esri.arcgis.location.IRouteLocation (in)

result - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

locateRow

void locateRow(IRouteEventProperties eventProperties,
               IRow row,
               IGeometry[] result,
               int[] locatingError)
               throws IOException,
                      AutomationException

Locates an event table row containing a point or line route location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

eventProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)

row - A reference to a com.esri.arcgis.geodatabase.IRow (in)

result - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteGeometry

void getRouteGeometry(IRouteLocation routeLocation,
                      IGeometry[] routeGeometry,
                      int[] locatingError)
                      throws IOException,
                             AutomationException

The route(s) corresponding to the route location.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

routeLocation - A reference to a com.esri.arcgis.location.IRouteLocation (in)

routeGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.