com.esri.arcgis.location
Interface IRouteLocatorOperations

All Superinterfaces:

Serializable

All Known Subinterfaces:

IRouteLocatorOperations2

All Known Implementing Classes:

RouteLocatorOperations

public interface IRouteLocatorOperations
extends Serializable

Provides access to operations on the route locator.

Superseded By

IRouteLocatorOperations2

Description

The IRouteLocatorOperations interface provides methods and properties to create an event table, ITable, in several ways:

• A new event table can be created by transforming events from one route reference (route feature class) to another by using the methods LocateLineFeatures and LocatePointEvents.
• A new point event table can be created by locating points along routes by using the method LocatePointFeatures.
• A new line event table can be created by locating lines along routes by using the method LocateLineFeatures.
• A new line event table can be created by locating polygons along routes by using the method LocatePolygonFeatures.

See IRouteLocatorOperations2.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

Method Detail

setRouteLocatorByRef

void setRouteLocatorByRef(IRouteLocator routeLocator)
                          throws IOException,
                                 AutomationException

The route locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

routeLocator - A reference to a com.esri.arcgis.location.IRouteLocator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteLocator

IRouteLocator getRouteLocator()
                              throws IOException,
                                     AutomationException

The route locator.

Description

Use the IRouteLocatorOperations2::RouteFeatureClass (or RouteFeatureSelection) and IRouteLocatorOperations2::RouteIDFieldName properties instead.

Remarks

The RouteLocator property sets the IRouteLocator, which is the route locator the point, line or polygon features are to be located against.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInputFeatureClassByRef

void setInputFeatureClassByRef(IFeatureClass inputFeatureClass)
                               throws IOException,
                                      AutomationException

The input features to locate along the routes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

inputFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputFeatureClass

IFeatureClass getInputFeatureClass()
                                   throws IOException,
                                          AutomationException

The input features to locate along the routes.

Remarks

The InputFeatureClass property can be an IFeatureClass or an IRouteEventSource depending on which methods is used. For LocatePointEvents, this property must be an IRouteEventSource.

For LocatePolygonFeatures, the geometry type of the IFeatureClass must be Polygon. For LocateLineFeatures, the geometry type must be Polyline, and for LocatePointFeatures and LocatePointEvents, the geometry type must be Point.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInputFeatureSelectionByRef

void setInputFeatureSelectionByRef(ISelectionSet selection)
                                   throws IOException,
                                          AutomationException

A selection set of features to locate.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

selection - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInputFeatureSelection

ISelectionSet getInputFeatureSelection()
                                       throws IOException,
                                              AutomationException

A selection set of features to locate.

Description

If you use this property, you do not need to specify the InputFeatureClass property as it is implied by the selection.

Remarks

If not all of the features are to be transformed or located, the InputFeatureSelection property can be used to set an ISelectionSet. If both the InputFeatureSelection and InputFeatureClass are set, the InputFeatureSelection will be used.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

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,
                           String configKeyword,
                           ITrackCancel trackCancel)
                           throws IOException,
                                  AutomationException

Locate point features along a routes and write the result in an object class.

Description

Creates a table that can be used to display point events on a map.

Remarks

For the searchMultipleLocation parameter, if the point falls on more than one route for the given searchRadius, you can have the option to create multiple event records that correspond to each route in the searchRadius vicinity.

The keepAllFields Boolean allows you to include or disinclude the attributes of the point feature class. If this is set to False, the otuput event table will only contain the route event properties (IRouteEventProperties).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

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,
                          String configKeyword,
                          ITrackCancel trackCancel)
                          throws IOException,
                                 AutomationException

Locate line features along routes and write the result in an object class.

Description

Creates a table that can be used to display line events on a map.

Remarks

The keepAllFields Boolean allows you to include or disinclude the attributes of the line event source. If this is set to False, the otuput event table will only contain the route event properties (IRouteEventProperties).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

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,
                         String configKeyword,
                         ITrackCancel trackCancel)
                         throws IOException,
                                AutomationException

Locate point events along target routes and write the result in an object class.

Description

Creates a table that can be used to display point events on a map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

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,
                             String configKeyword,
                             ITrackCancel trackCancel)
                             throws IOException,
                                    AutomationException

Locate polygon features along routes and write the result in an object class.

Description

Creates a table that can be used to display line events on a map.

Remarks

The keepAllFields Boolean allows you to include or disinclude the attributes of the polygon feature class. If this is set to False, the otuput event table will only contain the route event properties (IRouteEventProperties).

The keepZeroLengthEvents Boolean parameter allows you to keep or not keep the zero length line events in the output event table. The zero length line events result from a case where the geometric intersection of the route (line) and the polygon is a point. An example is where only a corner of the polygon touches the route.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.