com.esri.arcgis.location
Class RouteMeasureCalibrator

java.lang.Object
  extended by com.esri.arcgis.location.RouteMeasureCalibrator
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IRouteMeasureCalibrator, IRouteMeasureCalibrator2, ISupportErrorInfo, java.io.Serializable

public class RouteMeasureCalibrator
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRouteMeasureCalibrator, IRouteMeasureCalibrator2, ISupportErrorInfo

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

Description 'Route Measure Calibration 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.location.IRouteMeasureCalibrator2
IID, IID5b5f88f5_1865_407b_a7d8_da5d9daa0e8b, xxDummy
 
Fields inherited from interface com.esri.arcgis.location.IRouteMeasureCalibrator
IID960a398f_7e73_4d7e_955f_04f3916812ee
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
RouteMeasureCalibrator()
          Constructs a RouteMeasureCalibrator using ArcGIS Engine.
RouteMeasureCalibrator(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteMeasureCalibrator theRouteMeasureCalibrator = (RouteMeasureCalibrator) obj;
 
Method Summary
 IEnumBSTR calibrateRoutesByDistance(int updateHow, boolean ignoreGaps, double tolerance, boolean allRoutes, IFeatureClassName outputFClassName, IGeometryDef outputGeometryDef, java.lang.String configKeyword, ITrackCancel trackCancel)
          Calibrate route features.
 IEnumBSTR calibrateRoutesByMs(int updateHow, double tolerance, boolean allRoutes, IFeatureClassName outputFClassName, IGeometryDef outputGeometryDef, java.lang.String configKeyword, ITrackCancel trackCancel)
          Calibrate route features by using existing M values for the interpolation.
 boolean equals(java.lang.Object o)
          Compare this object with another
static java.lang.String getClsid()
          getClsid.
 IFeatureClass getInputFeatureClass()
          The input features to locate along the routes.
 ISelectionSet getInputFeatureSelection()
          A selection set of features to locate.
 java.lang.String getInputMeasureFieldName()
          The input measure field name.
 java.lang.String getInputRouteIDFieldName()
          The input route identifier field name.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IFeatureClass getRouteFeatureClass()
          The route feature class (Polyline with M feature class).
 ISelectionSet getRouteFeatureSelection()
          A selection set of route features.
 java.lang.String getRouteIDFieldName()
          The route identifier field name.
 IRouteLocator getRouteLocator()
          The route locator.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isBuildOutputIndex()
          Indicates whether an index is going to be built on the route id field on the output result.
 void release()
          Release a RouteMeasureCalibrator.
 void setBuildOutputIndex(boolean status)
          Indicates whether an index is going to be built on the route id field on the output result.
 void setInputFeatureClassByRef(IFeatureClass inputFeatureClass)
          The input features to locate along the routes.
 void setInputFeatureSelectionByRef(ISelectionSet selection)
          A selection set of features to locate.
 void setInputMeasureFieldName(java.lang.String fieldName)
          The input measure field name.
 void setInputRouteIDFieldName(java.lang.String fieldName)
          The input route identifier field name.
 void setRouteFeatureClassByRef(IFeatureClass featureClass)
          The route feature class (Polyline with M feature class).
 void setRouteFeatureSelectionByRef(ISelectionSet selection)
          A selection set of route features.
 void setRouteIDFieldName(java.lang.String fieldName)
          The route identifier field name.
 void setRouteLocatorByRef(IRouteLocator routeLocator)
          The route locator.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RouteMeasureCalibrator

public RouteMeasureCalibrator()
                       throws java.io.IOException,
                              java.net.UnknownHostException
Constructs a RouteMeasureCalibrator using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

RouteMeasureCalibrator

public RouteMeasureCalibrator(java.lang.Object obj)
                       throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteMeasureCalibrator theRouteMeasureCalibrator = (RouteMeasureCalibrator) obj;

Construct a RouteMeasureCalibrator using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RouteMeasureCalibrator.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setRouteLocatorByRef

public void setRouteLocatorByRef(IRouteLocator routeLocator)
                          throws java.io.IOException,
                                 AutomationException
The route locator.

Specified by:
setRouteLocatorByRef in interface IRouteMeasureCalibrator
Parameters:
routeLocator - A reference to a com.esri.arcgis.location.IRouteLocator (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRouteLocator

public IRouteLocator getRouteLocator()
                              throws java.io.IOException,
                                     AutomationException
The route locator.

Specified by:
getRouteLocator in interface IRouteMeasureCalibrator
Returns:
A reference to a com.esri.arcgis.location.IRouteLocator
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInputFeatureClassByRef

public void setInputFeatureClassByRef(IFeatureClass inputFeatureClass)
                               throws java.io.IOException,
                                      AutomationException
The input features to locate along the routes.

Specified by:
setInputFeatureClassByRef in interface IRouteMeasureCalibrator
Parameters:
inputFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInputFeatureClass

public IFeatureClass getInputFeatureClass()
                                   throws java.io.IOException,
                                          AutomationException
The input features to locate along the routes.

Specified by:
getInputFeatureClass in interface IRouteMeasureCalibrator
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.

setInputFeatureSelectionByRef

public void setInputFeatureSelectionByRef(ISelectionSet selection)
                                   throws java.io.IOException,
                                          AutomationException
A selection set of features to locate.

Specified by:
setInputFeatureSelectionByRef in interface IRouteMeasureCalibrator
Parameters:
selection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInputFeatureSelection

public ISelectionSet getInputFeatureSelection()
                                       throws java.io.IOException,
                                              AutomationException
A selection set of features to locate.

Specified by:
getInputFeatureSelection in interface IRouteMeasureCalibrator
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInputRouteIDFieldName

public void setInputRouteIDFieldName(java.lang.String fieldName)
                              throws java.io.IOException,
                                     AutomationException
The input route identifier field name.

Specified by:
setInputRouteIDFieldName in interface IRouteMeasureCalibrator
Parameters:
fieldName - The fieldName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInputRouteIDFieldName

public java.lang.String getInputRouteIDFieldName()
                                          throws java.io.IOException,
                                                 AutomationException
The input route identifier field name.

Specified by:
getInputRouteIDFieldName in interface IRouteMeasureCalibrator
Returns:
The fieldName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInputMeasureFieldName

public void setInputMeasureFieldName(java.lang.String fieldName)
                              throws java.io.IOException,
                                     AutomationException
The input measure field name.

Specified by:
setInputMeasureFieldName in interface IRouteMeasureCalibrator
Parameters:
fieldName - The fieldName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInputMeasureFieldName

public java.lang.String getInputMeasureFieldName()
                                          throws java.io.IOException,
                                                 AutomationException
The input measure field name.

Specified by:
getInputMeasureFieldName in interface IRouteMeasureCalibrator
Returns:
The fieldName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBuildOutputIndex

public void setBuildOutputIndex(boolean status)
                         throws java.io.IOException,
                                AutomationException
Indicates whether an index is going to be built on the route id field on the output result.

Specified by:
setBuildOutputIndex in interface IRouteMeasureCalibrator
Parameters:
status - The status (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBuildOutputIndex

public boolean isBuildOutputIndex()
                           throws java.io.IOException,
                                  AutomationException
Indicates whether an index is going to be built on the route id field on the output result.

Specified by:
isBuildOutputIndex in interface IRouteMeasureCalibrator
Returns:
The status
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

calibrateRoutesByDistance

public IEnumBSTR calibrateRoutesByDistance(int updateHow,
                                           boolean ignoreGaps,
                                           double tolerance,
                                           boolean allRoutes,
                                           IFeatureClassName outputFClassName,
                                           IGeometryDef outputGeometryDef,
                                           java.lang.String configKeyword,
                                           ITrackCancel trackCancel)
                                    throws java.io.IOException,
                                           AutomationException
Calibrate route features.

Specified by:
calibrateRoutesByDistance in interface IRouteMeasureCalibrator
Parameters:
updateHow - The updateHow (in)
ignoreGaps - The ignoreGaps (in)
tolerance - The tolerance (in)
allRoutes - The allRoutes (in)
outputFClassName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)
outputGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)
configKeyword - The configKeyword (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.system.IEnumBSTR
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

calibrateRoutesByMs

public IEnumBSTR calibrateRoutesByMs(int updateHow,
                                     double tolerance,
                                     boolean allRoutes,
                                     IFeatureClassName outputFClassName,
                                     IGeometryDef outputGeometryDef,
                                     java.lang.String configKeyword,
                                     ITrackCancel trackCancel)
                              throws java.io.IOException,
                                     AutomationException
Calibrate route features by using existing M values for the interpolation.

Specified by:
calibrateRoutesByMs in interface IRouteMeasureCalibrator
Parameters:
updateHow - The updateHow (in)
tolerance - The tolerance (in)
allRoutes - The allRoutes (in)
outputFClassName - A reference to a com.esri.arcgis.geodatabase.IFeatureClassName (in)
outputGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)
configKeyword - The configKeyword (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.system.IEnumBSTR
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRouteFeatureClassByRef

public void setRouteFeatureClassByRef(IFeatureClass featureClass)
                               throws java.io.IOException,
                                      AutomationException
The route feature class (Polyline with M feature class).

Specified by:
setRouteFeatureClassByRef in interface IRouteMeasureCalibrator2
Parameters:
featureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)
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 IRouteMeasureCalibrator2
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.

setRouteFeatureSelectionByRef

public void setRouteFeatureSelectionByRef(ISelectionSet selection)
                                   throws java.io.IOException,
                                          AutomationException
A selection set of route features.

Specified by:
setRouteFeatureSelectionByRef in interface IRouteMeasureCalibrator2
Parameters:
selection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRouteFeatureSelection

public ISelectionSet getRouteFeatureSelection()
                                       throws java.io.IOException,
                                              AutomationException
A selection set of route features.

Specified by:
getRouteFeatureSelection in interface IRouteMeasureCalibrator2
Returns:
A reference to a com.esri.arcgis.geodatabase.ISelectionSet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRouteIDFieldName

public void setRouteIDFieldName(java.lang.String fieldName)
                         throws java.io.IOException,
                                AutomationException
The route identifier field name.

Specified by:
setRouteIDFieldName in interface IRouteMeasureCalibrator2
Parameters:
fieldName - The fieldName (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 name.

Specified by:
getRouteIDFieldName in interface IRouteMeasureCalibrator2
Returns:
The fieldName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.