com.esri.arcgis.geodatabase
Interface IRouteLocatorName

All Superinterfaces:

Serializable

All Known Implementing Classes:

RouteMeasureLocatorName

public interface IRouteLocatorName
extends Serializable

Provides access to route locator name properties.

Product Availability

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

Method Summary

IName	getRouteFeatureClassName() The route feature class name (Polyline with M feature class name).
String	getRouteIDFieldName() The route identifier field of the route feature class.
int	getRouteMeasureUnit() The route measure units.
String	getRouteWhereClause() The where clause that limits the routes that events can be located on.
boolean	isRouteIDIsUnique() Indicates if the Route ID is unique (Obsolete).
void	setRouteFeatureClassNameByRef(IName name) The route feature class name (Polyline with M feature class name).
void	setRouteIDFieldName(String routeIDFieldName) The route identifier field of the route feature class.
void	setRouteIDIsUnique(boolean routeIDIsUnique) Indicates if the Route ID is unique (Obsolete).
void	setRouteMeasureUnit(int units) The route measure units.
void	setRouteWhereClause(String whereClause) The where clause that limits the routes that events can be located on.

Method Detail

setRouteFeatureClassNameByRef

void setRouteFeatureClassNameByRef(IName name)
                                   throws IOException,
                                          AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - A reference to a com.esri.arcgis.system.IName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteFeatureClassName

IName getRouteFeatureClassName()
                               throws IOException,
                                      AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteIDFieldName

void setRouteIDFieldName(String routeIDFieldName)
                         throws IOException,
                                AutomationException

The route identifier field of the route feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

routeIDFieldName - The routeIDFieldName (in)

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 of the route feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The routeIDFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteIDIsUnique

void setRouteIDIsUnique(boolean routeIDIsUnique)
                        throws IOException,
                               AutomationException

Indicates if the Route ID is unique (Obsolete).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

routeIDIsUnique - The routeIDIsUnique (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRouteIDIsUnique

boolean isRouteIDIsUnique()
                          throws IOException,
                                 AutomationException

Indicates if 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.

setRouteMeasureUnit

void setRouteMeasureUnit(int units)
                         throws IOException,
                                AutomationException

The route measure units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteMeasureUnit

int getRouteMeasureUnit()
                        throws IOException,
                               AutomationException

The route measure units.

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.

setRouteWhereClause

void setRouteWhereClause(String whereClause)
                         throws IOException,
                                AutomationException

The where clause that limits the routes that 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 that 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.