com.esri.arcgis.location
Class IRouteLocatorProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.location.IRouteLocatorProxy

All Implemented Interfaces:

IRouteLocator, Externalizable, Serializable

Direct Known Subclasses:

IRouteLocator2Proxy

public class IRouteLocatorProxy
extends com.esri.arcgis.interop.Dispatch
implements IRouteLocator, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IRouteLocatorProxy()
	IRouteLocatorProxy(Object obj)
protected	IRouteLocatorProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
void	setRouteWhereClause(String whereClause) The where clause that limits the routes events can be located on.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IRouteLocatorProxy

public IRouteLocatorProxy()

IRouteLocatorProxy

public IRouteLocatorProxy(Object obj)
                   throws IOException

Throws:

IOException

IRouteLocatorProxy

protected IRouteLocatorProxy(Object obj,
                             String iid)
                      throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getRouteFeatureClass

public 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

Specified by:

getRouteFeatureClass in interface IRouteLocator

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

public 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

Specified by:

getRouteIDFieldName in interface IRouteLocator

Returns:

The rid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldIndex

public 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

Specified by:

getRouteIDFieldIndex in interface IRouteLocator

Returns:

The routeIDIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldNameDelimited

public 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

Specified by:

getRouteIDFieldNameDelimited in interface IRouteLocator

Returns:

The rid

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRouteIDIsUnique

public 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

Specified by:

isRouteIDIsUnique in interface IRouteLocator

Returns:

The routeIDIsUnique

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRouteIDIsString

public 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

Specified by:

isRouteIDIsString in interface IRouteLocator

Returns:

The routeIDIsString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteWhereClause

public 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

Specified by:

setRouteWhereClause in interface IRouteLocator

Parameters:

whereClause - The whereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteWhereClause

public 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

Specified by:

getRouteWhereClause in interface IRouteLocator

Returns:

The whereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMeasureUnit

public 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

Specified by:

getMeasureUnit in interface IRouteLocator

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

public 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

Specified by:

getExtent in interface IRouteLocator

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

public 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

Specified by:

getSpatialReference in interface IRouteLocator

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

public 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

Specified by:

isHasSpatialIndex in interface IRouteLocator

Returns:

The hasSpatialIndex

Throws:

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

Specified by:

locate in interface IRouteLocator

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

public 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

Specified by:

locateRow in interface IRouteLocator

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

public 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

Specified by:

getRouteGeometry in interface IRouteLocator

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.