com.esri.arcgis.location
Interface IRouteLocatorOperations

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IRouteLocatorOperations2
All Known Implementing Classes:
IRouteLocatorOperations2Proxy, IRouteLocatorOperationsProxy, RouteLocatorOperations

public interface IRouteLocatorOperations
extends java.io.Serializable

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

Description: 'Provides access to operations on the 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 IIDc531e2d7_a579_11d4_9ff0_00c04f6bdf06
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 IFeatureClass getInputFeatureClass()
          The input features to locate along the routes.
 ISelectionSet getInputFeatureSelection()
          A selection set of features to locate.
 IRouteLocator getRouteLocator()
          The route locator.
 ITable locateLineFeatures(double clusterTolerance, IRouteEventProperties outputProperties, boolean keepAllFields, IDatasetName outputName, java.lang.String configKeyword, ITrackCancel trackCancel)
          Locate line features along routes and write the result in an object class.
 ITable locatePointEvents(double clusterTolerance, IRouteEventProperties outputProperties, boolean keepAllFields, IDatasetName outputName, java.lang.String configKeyword, ITrackCancel trackCancel)
          Locate point events along target routes and write the result in an object class.
 ITable locatePointFeatures(double searchRadius, boolean searchMultipleLocation, IRouteEventProperties outputProperties, boolean keepAllFields, IDatasetName outputName, java.lang.String configKeyword, ITrackCancel trackCancel)
          Locate point features along a routes and write the result in an object class.
 ITable locatePolygonFeatures(IRouteEventProperties outputProperties, boolean keepAllFields, boolean keepZeroLengthEvents, IDatasetName outputName, java.lang.String configKeyword, ITrackCancel trackCancel)
          Locate polygon features along routes and write the result in an object class.
 void setInputFeatureClassByRef(IFeatureClass inputFeatureClass)
          The input features to locate along the routes.
 void setInputFeatureSelectionByRef(ISelectionSet selection)
          A selection set of features to locate.
 void setRouteLocatorByRef(IRouteLocator routeLocator)
          The route locator.
 

Field Detail

IIDc531e2d7_a579_11d4_9ff0_00c04f6bdf06

static final int IIDc531e2d7_a579_11d4_9ff0_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

setRouteLocatorByRef

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

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

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

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

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

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

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

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

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

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

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

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.

locatePointFeatures

ITable locatePointFeatures(double searchRadius,
                           boolean searchMultipleLocation,
                           IRouteEventProperties outputProperties,
                           boolean keepAllFields,
                           IDatasetName outputName,
                           java.lang.String configKeyword,
                           ITrackCancel trackCancel)
                           throws java.io.IOException,
                                  AutomationException
Locate point features along a routes and write the result in an object class.

Parameters:
searchRadius - The searchRadius (in)
searchMultipleLocation - The searchMultipleLocation (in)
outputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)
keepAllFields - The keepAllFields (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
configKeyword - The configKeyword (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locateLineFeatures

ITable locateLineFeatures(double clusterTolerance,
                          IRouteEventProperties outputProperties,
                          boolean keepAllFields,
                          IDatasetName outputName,
                          java.lang.String configKeyword,
                          ITrackCancel trackCancel)
                          throws java.io.IOException,
                                 AutomationException
Locate line features along routes and write the result in an object class.

Parameters:
clusterTolerance - The clusterTolerance (in)
outputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)
keepAllFields - The keepAllFields (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
configKeyword - The configKeyword (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locatePointEvents

ITable locatePointEvents(double clusterTolerance,
                         IRouteEventProperties outputProperties,
                         boolean keepAllFields,
                         IDatasetName outputName,
                         java.lang.String configKeyword,
                         ITrackCancel trackCancel)
                         throws java.io.IOException,
                                AutomationException
Locate point events along target routes and write the result in an object class.

Parameters:
clusterTolerance - The clusterTolerance (in)
outputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)
keepAllFields - The keepAllFields (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
configKeyword - The configKeyword (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

locatePolygonFeatures

ITable locatePolygonFeatures(IRouteEventProperties outputProperties,
                             boolean keepAllFields,
                             boolean keepZeroLengthEvents,
                             IDatasetName outputName,
                             java.lang.String configKeyword,
                             ITrackCancel trackCancel)
                             throws java.io.IOException,
                                    AutomationException
Locate polygon features along routes and write the result in an object class.

Parameters:
outputProperties - A reference to a com.esri.arcgis.geodatabase.IRouteEventProperties (in)
keepAllFields - The keepAllFields (in)
keepZeroLengthEvents - The keepZeroLengthEvents (in)
outputName - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)
configKeyword - The configKeyword (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.