com.esri.arcgis.location
Interface IRouteLocator

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IRouteLocator2

All Known Implementing Classes:

IRouteLocator2Proxy, IRouteLocatorProxy, RouteMeasureLocator

public interface IRouteLocator

extends java.io.Serializable

Provides access to properties and methods of a route locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.
java.lang.String	getRouteIDFieldName() The route identifier field from the route feature class.
java.lang.String	getRouteIDFieldNameDelimited() The delimited route identifier field of the route feature class.
java.lang.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(java.lang.String whereClause) The where clause that limits the routes events can be located on.

Method Detail

getRouteFeatureClass

public IFeatureClass getRouteFeatureClass()
                                   throws java.io.IOException,
                                          AutomationException

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldName

public java.lang.String getRouteIDFieldName()
                                     throws java.io.IOException,
                                            AutomationException

The route identifier field from the route feature class.

Supported Platforms

Windows, Solaris, Linux

Returns:

The rid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldIndex

public int getRouteIDFieldIndex()
                         throws java.io.IOException,
                                AutomationException

The field index of the route identifier.

Supported Platforms

Windows, Solaris, Linux

Returns:

The routeIDIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldNameDelimited

public java.lang.String getRouteIDFieldNameDelimited()
                                              throws java.io.IOException,
                                                     AutomationException

The delimited route identifier field of the route feature class.

Supported Platforms

Windows, Solaris, Linux

Returns:

The rid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRouteIDIsUnique

public boolean isRouteIDIsUnique()
                          throws java.io.IOException,
                                 AutomationException

Indicates whether the route ID is unique (Obsolete).

Supported Platforms

Windows, Solaris, Linux

Returns:

The routeIDIsUnique

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRouteIDIsString

public boolean isRouteIDIsString()
                          throws java.io.IOException,
                                 AutomationException

Indicates if the route identifier field type is string.

Supported Platforms

Windows, Solaris, Linux

Returns:

The routeIDIsString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRouteWhereClause

public void setRouteWhereClause(java.lang.String whereClause)
                         throws java.io.IOException,
                                AutomationException

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

whereClause - The whereClause (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRouteWhereClause

public java.lang.String getRouteWhereClause()
                                     throws java.io.IOException,
                                            AutomationException

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The whereClause

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMeasureUnit

public int getMeasureUnit()
                   throws java.io.IOException,
                          AutomationException

The units of the route measures.

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasSpatialIndex

public boolean isHasSpatialIndex()
                          throws java.io.IOException,
                                 AutomationException

Indicates if the route feature class has a spatial index.

Supported Platforms

Windows, Solaris, Linux

Returns:

The hasSpatialIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

locate

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

Locates a point or line route location.

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:

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

AutomationException - If the ArcObject component throws an exception.

locateRow

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

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

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:

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

AutomationException - If the ArcObject component throws an exception.

getRouteGeometry

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

The route(s) corresponding to the route location.

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:

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

AutomationException - If the ArcObject component throws an exception.