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

COM Interface 'IRouteLocator'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriLocation.olb'

Description: 'Provides access to properties and methods of a route locator.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDa1e3811c_2055_11d4_9fc1_00c04f6bdf06
           
static int xxDummy
          Deprecated. Internal use only
 
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.
 

Field Detail

IIDa1e3811c_2055_11d4_9fc1_00c04f6bdf06

static final int IIDa1e3811c_2055_11d4_9fc1_00c04f6bdf06
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

getRouteFeatureClass

IFeatureClass getRouteFeatureClass()
                                   throws java.io.IOException,
                                          AutomationException
The route feature class (Polyline with M feature class).

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

java.lang.String getRouteIDFieldName()
                                     throws java.io.IOException,
                                            AutomationException
The route identifier field from the route feature class.

Returns:
The rid
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldIndex

int getRouteIDFieldIndex()
                         throws java.io.IOException,
                                AutomationException
The field index of the route identifier.

Returns:
The routeIDIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldNameDelimited

java.lang.String getRouteIDFieldNameDelimited()
                                              throws java.io.IOException,
                                                     AutomationException
The delimited route identifier field of the route feature class.

Returns:
The rid
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRouteIDIsUnique

boolean isRouteIDIsUnique()
                          throws java.io.IOException,
                                 AutomationException
Indicates whether the route ID is unique (Obsolete).

Returns:
The routeIDIsUnique
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRouteIDIsString

boolean isRouteIDIsString()
                          throws java.io.IOException,
                                 AutomationException
Indicates if the route identifier field type is string.

Returns:
The routeIDIsString
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRouteWhereClause

void setRouteWhereClause(java.lang.String whereClause)
                         throws java.io.IOException,
                                AutomationException
The where clause that limits the routes events can be located on.

Parameters:
whereClause - The whereClause (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRouteWhereClause

java.lang.String getRouteWhereClause()
                                     throws java.io.IOException,
                                            AutomationException
The where clause that limits the routes events can be located on.

Returns:
The whereClause
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMeasureUnit

int getMeasureUnit()
                   throws java.io.IOException,
                          AutomationException
The units of the route measures.

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

IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
The route locator's extent (same a route feature class' extent).

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

ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
The route locator's spatial reference (same as route feature class' spatial reference).

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

boolean isHasSpatialIndex()
                          throws java.io.IOException,
                                 AutomationException
Indicates if the route feature class has a spatial index.

Returns:
The hasSpatialIndex
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locate

void locate(IRouteLocation routeLocation,
            IGeometry[] result,
            int[] locatingError)
            throws java.io.IOException,
                   AutomationException
Locates a point or line route location.

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

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.

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

void getRouteGeometry(IRouteLocation routeLocation,
                      IGeometry[] routeGeometry,
                      int[] locatingError)
                      throws java.io.IOException,
                             AutomationException
The route(s) corresponding to the route location.

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.