|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.location.RouteMeasureLocator
public class RouteMeasureLocator
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 =
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 |
---|
public RouteMeasureLocator(java.lang.Object obj) throws java.io.IOException
obj
to RouteMeasureLocator
. *
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
java.io.IOException
- if there are interop problems
RouteMeasureLocator theRouteMeasureLocator = (RouteMeasureLocator) obj;
Method Detail |
---|
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public java.lang.String getName() throws java.io.IOException, AutomationException
getName
in interface ILocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getDescription() throws java.io.IOException, AutomationException
getDescription
in interface ILocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDescription(java.lang.String description) throws java.io.IOException, AutomationException
setDescription
in interface ILocator
description
- The description (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getCategory() throws java.io.IOException, AutomationException
getCategory
in interface ILocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILocatorUI getUserInterface() throws java.io.IOException, AutomationException
getUserInterface
in interface ILocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IFeatureClass getRouteFeatureClass() throws java.io.IOException, AutomationException
getRouteFeatureClass
in interface IRouteLocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getRouteIDFieldName() throws java.io.IOException, AutomationException
getRouteIDFieldName
in interface IRouteLocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getRouteIDFieldIndex() throws java.io.IOException, AutomationException
getRouteIDFieldIndex
in interface IRouteLocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getRouteIDFieldNameDelimited() throws java.io.IOException, AutomationException
getRouteIDFieldNameDelimited
in interface IRouteLocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isRouteIDIsUnique() throws java.io.IOException, AutomationException
isRouteIDIsUnique
in interface IRouteLocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isRouteIDIsString() throws java.io.IOException, AutomationException
isRouteIDIsString
in interface IRouteLocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRouteWhereClause(java.lang.String whereClause) throws java.io.IOException, AutomationException
setRouteWhereClause
in interface IRouteLocator
whereClause
- The whereClause (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getRouteWhereClause() throws java.io.IOException, AutomationException
getRouteWhereClause
in interface IRouteLocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getMeasureUnit() throws java.io.IOException, AutomationException
getMeasureUnit
in interface IRouteLocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnvelope getExtent() throws java.io.IOException, AutomationException
getExtent
in interface IRouteLocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISpatialReference getSpatialReference() throws java.io.IOException, AutomationException
getSpatialReference
in interface IRouteLocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isHasSpatialIndex() throws java.io.IOException, AutomationException
isHasSpatialIndex
in interface IRouteLocator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void locate(IRouteLocation routeLocation, IGeometry[] result, int[] locatingError) throws java.io.IOException, AutomationException
locate
in interface IRouteLocator
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void locateRow(IRouteEventProperties eventProperties, IRow row, IGeometry[] result, int[] locatingError) throws java.io.IOException, AutomationException
locateRow
in interface IRouteLocator
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getRouteGeometry(IRouteLocation routeLocation, IGeometry[] routeGeometry, int[] locatingError) throws java.io.IOException, AutomationException
getRouteGeometry
in interface IRouteLocator
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumRouteIdentifyResult identify(IEnvelope searchEnvelope, java.lang.String whereClause) throws java.io.IOException, AutomationException
identify
in interface IRouteLocator2
searchEnvelope
- A reference to a com.esri.arcgis.geometry.IEnvelope (in)whereClause
- The whereClause (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isHasZs() throws java.io.IOException, AutomationException
isHasZs
in interface IRouteLocator2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isRouteIDIsIndexed() throws java.io.IOException, AutomationException
isRouteIDIsIndexed
in interface IRouteLocator2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILocatorName getFullName() throws java.io.IOException, AutomationException
getFullName
in interface ILocatorDataset
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ILocatorWorkspace getLocatorWorkspace() throws java.io.IOException, AutomationException
getLocatorWorkspace
in interface ILocatorDataset
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |