com.esri.arcgis.location
Class RouteMeasureLocator

java.lang.Object
  com.esri.arcgis.location.RouteMeasureLocator

All Implemented Interfaces:

ILocator, ILocatorDataset, com.esri.arcgis.interop.RemoteObjRef, IRouteLocator, IRouteLocator2, java.io.Serializable

public class RouteMeasureLocator
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ILocator, IRouteLocator, IRouteLocator2, ILocatorDataset

COM Class 'RouteMeasureLocator'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriLocation.olb'

Description 'Route measure locator object.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geodatabase.ILocator

IID, IID655c5c62_6478_11d3_9f57_00c04f6bdf06, xxDummy

Fields inherited from interface com.esri.arcgis.location.IRouteLocator2

IID, IID234a6edf_4ad1_4bae_adcc_a4f60a6d9d50, xxDummy

Fields inherited from interface com.esri.arcgis.location.IRouteLocator

IIDa1e3811c_2055_11d4_9fc1_00c04f6bdf06

Fields inherited from interface com.esri.arcgis.geodatabase.ILocatorDataset

IID, IIDfdadfae4_939d_11d3_9f6b_00c04f6bdf06, xxDummy

Constructor Summary

RouteMeasureLocator(java.lang.Object obj)
Construct a RouteMeasureLocator using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getCategory() Category of the locator.
java.lang.String	getDescription() Description of the locator.
IEnvelope	getExtent() The route locator's extent (same a route feature class' extent).
ILocatorName	getFullName() The Name object for the locator.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILocatorWorkspace	getLocatorWorkspace() The locator workspace that contains the locator.
int	getMeasureUnit() The units of the route measures.
java.lang.String	getName() Name of the locator.
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).
ILocatorUI	getUserInterface() User interface for the locator.
int	hashCode() the hashcode for this object
IEnumRouteIdentifyResult	identify(IEnvelope searchEnvelope, java.lang.String whereClause) Identify route locations in an envelope.
boolean	isHasSpatialIndex() Indicates if the route feature class has a spatial index.
boolean	isHasZs() Indicates whether the route locator is Z-Aware.
boolean	isRouteIDIsIndexed() Indicates if the route ID has an 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	release() Release a RouteMeasureLocator.
void	setDescription(java.lang.String description) Description of the locator.
void	setRouteWhereClause(java.lang.String whereClause) The where clause that limits the routes events can be located on.

Methods inherited from class java.lang.Object

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

Constructor Detail

RouteMeasureLocator

public RouteMeasureLocator(java.lang.Object obj)
                    throws java.io.IOException

Construct a RouteMeasureLocator using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RouteMeasureLocator.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
RouteMeasureLocator o = (RouteMeasureLocator)obj; // will not work

RouteMeasureLocator o = new RouteMeasureLocator(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems RouteMeasureLocator theRouteMeasureLocator = (RouteMeasureLocator) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a RouteMeasureLocator.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getName

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

Name of the locator.

Specified by:

getName in interface ILocator

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

Description of the locator.

Specified by:

getDescription in interface ILocator

Returns:

The description

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String description)
                    throws java.io.IOException,
                           AutomationException

Description of the locator.

Specified by:

setDescription in interface ILocator

Parameters:

description - The description (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

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

Category of the locator.

Specified by:

getCategory in interface ILocator

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUserInterface

public ILocatorUI getUserInterface()
                            throws java.io.IOException,
                                   AutomationException

User interface for the locator.

Specified by:

getUserInterface in interface ILocator

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRouteFeatureClass

public IFeatureClass getRouteFeatureClass()
                                   throws java.io.IOException,
                                          AutomationException

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

Specified by:

getRouteFeatureClass in interface IRouteLocator

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

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

The route identifier field from the route feature class.

Specified by:

getRouteIDFieldName in interface IRouteLocator

Returns:

The rid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldIndex

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

The field index of the route identifier.

Specified by:

getRouteIDFieldIndex in interface IRouteLocator

Returns:

The routeIDIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldNameDelimited

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

The delimited route identifier field of the route feature class.

Specified by:

getRouteIDFieldNameDelimited in interface IRouteLocator

Returns:

The rid

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 whether the route ID is unique (Obsolete).

Specified by:

isRouteIDIsUnique in interface IRouteLocator

Returns:

The routeIDIsUnique

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRouteIDIsString

public boolean isRouteIDIsString()
                          throws java.io.IOException,
                                 AutomationException

Indicates if the route identifier field type is string.

Specified by:

isRouteIDIsString in interface IRouteLocator

Returns:

The routeIDIsString

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 events can be located on.

Specified by:

setRouteWhereClause in interface IRouteLocator

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 events can be located on.

Specified by:

getRouteWhereClause in interface IRouteLocator

Returns:

The whereClause

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMeasureUnit

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

The units of the route measures.

Specified by:

getMeasureUnit in interface IRouteLocator

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

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The route locator's extent (same a route feature class' extent).

Specified by:

getExtent in interface IRouteLocator

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

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

The route locator's spatial reference (same as route feature class' spatial reference).

Specified by:

getSpatialReference in interface IRouteLocator

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

public boolean isHasSpatialIndex()
                          throws java.io.IOException,
                                 AutomationException

Indicates if the route feature class has a spatial index.

Specified by:

isHasSpatialIndex in interface IRouteLocator

Returns:

The hasSpatialIndex

Throws:

java.io.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 java.io.IOException,
                   AutomationException

Locates a point or line route location.

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:

java.io.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 java.io.IOException,
                      AutomationException

Locates an event table row containing a point or line route location.

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:

java.io.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 java.io.IOException,
                             AutomationException

The route(s) corresponding to the route location.

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:

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

AutomationException - If the ArcObject component throws an exception.

identify

public IEnumRouteIdentifyResult identify(IEnvelope searchEnvelope,
                                         java.lang.String whereClause)
                                  throws java.io.IOException,
                                         AutomationException

Identify route locations in an envelope.

Specified by:

identify in interface IRouteLocator2

Parameters:

searchEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

whereClause - The whereClause (in)

Returns:

A reference to a com.esri.arcgis.location.IEnumRouteIdentifyResult

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasZs

public boolean isHasZs()
                throws java.io.IOException,
                       AutomationException

Indicates whether the route locator is Z-Aware.

Specified by:

isHasZs in interface IRouteLocator2

Returns:

The hasZs

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRouteIDIsIndexed

public boolean isRouteIDIsIndexed()
                           throws java.io.IOException,
                                  AutomationException

Indicates if the route ID has an index.

Specified by:

isRouteIDIsIndexed in interface IRouteLocator2

Returns:

The routeIDIsIndexed

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullName

public ILocatorName getFullName()
                         throws java.io.IOException,
                                AutomationException

The Name object for the locator.

Specified by:

getFullName in interface ILocatorDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLocatorWorkspace

public ILocatorWorkspace getLocatorWorkspace()
                                      throws java.io.IOException,
                                             AutomationException

The locator workspace that contains the locator.

Specified by:

getLocatorWorkspace in interface ILocatorDataset

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.