com.esri.arcgis.location
Interface IRouteLayerExtension

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IRouteLayerExtensionProxy, RouteLayerExtension

public interface IRouteLayerExtension

extends java.io.Serializable

Provides access to the route layer extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

The IRouteLayerExtension interface is used for route layers in ArcMap to get and set the route layers route identifier, RouteIDFieldName.

Method Summary

java.lang.String	getRouteIDFieldName() The route id field name.
IRouteLocatorName	getRouteLocatorName(ILayer layer) The route locator name.
void	setRouteIDFieldName(ILayer layer, java.lang.String fieldName) Set the route id field name.

Method Detail

getRouteLocatorName

public IRouteLocatorName getRouteLocatorName(ILayer layer)
                                      throws java.io.IOException,
                                             AutomationException

The route locator name.

Supported Platforms

Windows, Solaris, Linux

Remarks

This property allows you to get the IRouteLocatorName interface and set its properties. Everytime a route layer is added to ArcMap, the RouteMeasureLocatorName object is created.

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IRouteLayerExtension

getRouteIDFieldName

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

The route id field name.

Supported Platforms

Windows, Solaris, Linux

Remarks

This is used to get the route identifer (RouteIDFieldName) from the IRouteLocatorName interface.

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

See Also:

IRouteLayerExtension

setRouteIDFieldName

public void setRouteIDFieldName(ILayer layer,
                                java.lang.String fieldName)
                         throws java.io.IOException,
                                AutomationException

Set the route id field name.

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.