com.esri.arcgis.geodatabase
Interface IRouteLocatorName

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IRouteLocatorNameProxy, RouteMeasureLocatorName

public interface IRouteLocatorName

extends java.io.Serializable

Provides access to route locator name properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Method Summary

IName	getRouteFeatureClassName() The route feature class name (Polyline with M feature class name).
java.lang.String	getRouteIDFieldName() The route identifier field of the route feature class.
int	getRouteMeasureUnit() The route measure units.
java.lang.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(java.lang.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(java.lang.String whereClause) The where clause that limits the routes that events can be located on.

Method Detail

setRouteFeatureClassNameByRef

public void setRouteFeatureClassNameByRef(IName name)
                                   throws java.io.IOException,
                                          AutomationException

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

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRouteFeatureClassName

public IName getRouteFeatureClassName()
                               throws java.io.IOException,
                                      AutomationException

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRouteIDFieldName

public void setRouteIDFieldName(java.lang.String routeIDFieldName)
                         throws java.io.IOException,
                                AutomationException

The route identifier field of the route feature class.

Supported Platforms

Windows, Solaris, Linux

Parameters:

routeIDFieldName - The routeIDFieldName (in)

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The routeIDFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRouteIDIsUnique

public void setRouteIDIsUnique(boolean routeIDIsUnique)
                        throws java.io.IOException,
                               AutomationException

Indicates if the Route ID is unique (Obsolete).

Supported Platforms

Windows, Solaris, Linux

Parameters:

routeIDIsUnique - The routeIDIsUnique (in)

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

setRouteMeasureUnit

public void setRouteMeasureUnit(int units)
                         throws java.io.IOException,
                                AutomationException

The route measure units.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRouteMeasureUnit

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

The route measure units.

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.

setRouteWhereClause

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

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