com.esri.arcgis.location
Class RouteLocatorOperations

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IRouteLocatorOperations, IRouteLocatorOperations2, ISupportErrorInfo, Serializable

public class RouteLocatorOperations
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRouteLocatorOperations, IRouteLocatorOperations2, ISupportErrorInfo

Basic route locator operations object.

Remarks

The RouteLocatorOperations CoClass provides operations for you to create point or line event tables. Event tables can be created by locating points along routes, or locating polygons along routes. Event tables can also be created by performing event transformation from one route reference to another.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RouteLocatorOperations()
Constructs a RouteLocatorOperations using ArcGIS Engine.

RouteLocatorOperations(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteLocatorOperations theRouteLocatorOperations = (RouteLocatorOperations) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IFeatureClass	getInputFeatureClass() The input features to locate along the routes.
ISelectionSet	getInputFeatureSelection() A selection set of features to locate.
IFeatureClass	getRouteFeatureClass() The route feature class (Polyline with M feature class).
ISelectionSet	getRouteFeatureSelection() A selection set of route features.
String	getRouteIDFieldName() The route feature identifier.
IRouteLocator	getRouteLocator() The route locator.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
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	setRouteFeatureClassByRef(IFeatureClass routeFeatureClass) The route feature class (Polyline with M feature class).
void	setRouteFeatureSelectionByRef(ISelectionSet selection) A selection set of route features.
void	setRouteIDFieldName(String routeIDFieldName) The route feature identifier.
void	setRouteLocatorByRef(IRouteLocator routeLocator) The route locator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

RouteLocatorOperations

public RouteLocatorOperations()
                       throws IOException,
                              UnknownHostException

Constructs a RouteLocatorOperations using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RouteLocatorOperations

public RouteLocatorOperations(Object obj)
                       throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RouteLocatorOperations theRouteLocatorOperations = (RouteLocatorOperations) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setRouteLocatorByRef

public 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

Specified by:

setRouteLocatorByRef in interface IRouteLocatorOperations

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

public 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

Specified by:

getRouteLocator in interface IRouteLocatorOperations

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

public 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

Specified by:

setInputFeatureClassByRef in interface IRouteLocatorOperations

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

public 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

Specified by:

getInputFeatureClass in interface IRouteLocatorOperations

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

public 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

Specified by:

setInputFeatureSelectionByRef in interface IRouteLocatorOperations

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

public 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

Specified by:

getInputFeatureSelection in interface IRouteLocatorOperations

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

public 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

Specified by:

locatePointFeatures in interface IRouteLocatorOperations

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

public 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

Specified by:

locateLineFeatures in interface IRouteLocatorOperations

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

public 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

Specified by:

locatePointEvents in interface IRouteLocatorOperations

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

public 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

Specified by:

locatePolygonFeatures in interface IRouteLocatorOperations

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.

setRouteFeatureClassByRef

public void setRouteFeatureClassByRef(IFeatureClass routeFeatureClass)
                               throws IOException,
                                      AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRouteFeatureClassByRef in interface IRouteLocatorOperations2

Parameters:

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

getRouteFeatureClass

public IFeatureClass getRouteFeatureClass()
                                   throws IOException,
                                          AutomationException

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

Remarks

Use this property instead of IRouteLocatorOperations::RouteLocator. When using this property, you must also specify the RouteIDFieldName.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRouteFeatureClass in interface IRouteLocatorOperations2

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.

setRouteFeatureSelectionByRef

public void setRouteFeatureSelectionByRef(ISelectionSet selection)
                                   throws IOException,
                                          AutomationException

A selection set of route features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRouteFeatureSelectionByRef in interface IRouteLocatorOperations2

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.

getRouteFeatureSelection

public ISelectionSet getRouteFeatureSelection()
                                       throws IOException,
                                              AutomationException

A selection set of route features.

Remarks

If you use this method, there is no need to specify the RouteFeatureClass (as it is implied). You still must set the RouteIDFieldName, however.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRouteFeatureSelection in interface IRouteLocatorOperations2

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.

setRouteIDFieldName

public void setRouteIDFieldName(String routeIDFieldName)
                         throws IOException,
                                AutomationException

The route feature identifier.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRouteIDFieldName in interface IRouteLocatorOperations2

Parameters:

routeIDFieldName - The routeIDFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldName

public String getRouteIDFieldName()
                           throws IOException,
                                  AutomationException

The route feature identifier.

Remarks

Use this property with the RouteFeatureClass (or RouteFeatureSelection) properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRouteIDFieldName in interface IRouteLocatorOperations2

Returns:

The routeIDFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.