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, java.io.Serializable

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

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

Description 'Basic route locator operations 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.IRouteLocatorOperations2

IID, IIDe3444997_77d0_44cc_8eac_eb1d5d7de199, xxDummy

Fields inherited from interface com.esri.arcgis.location.IRouteLocatorOperations

IIDc531e2d7_a579_11d4_9ff0_00c04f6bdf06

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

RouteLocatorOperations()
Constructs a RouteLocatorOperations using ArcGIS Engine.

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

Method Summary

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.
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 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, 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	release() Release a RouteLocatorOperations.
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(java.lang.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

Constructor Detail

RouteLocatorOperations

public RouteLocatorOperations()
                       throws java.io.IOException,
                              java.net.UnknownHostException

Constructs a RouteLocatorOperations using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RouteLocatorOperations

public RouteLocatorOperations(java.lang.Object obj)
                       throws java.io.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:

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

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 IRouteLocatorOperations

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 IRouteLocatorOperations

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 IRouteLocatorOperations

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 IRouteLocatorOperations

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 IRouteLocatorOperations

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 IRouteLocatorOperations

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

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

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:

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

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

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:

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

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:

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

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

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteFeatureClassByRef

public void setRouteFeatureClassByRef(IFeatureClass routeFeatureClass)
                               throws java.io.IOException,
                                      AutomationException

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

Specified by:

setRouteFeatureClassByRef in interface IRouteLocatorOperations2

Parameters:

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

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 IRouteLocatorOperations2

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 IRouteLocatorOperations2

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 routeIDFieldName)
                         throws java.io.IOException,
                                AutomationException

The route feature identifier.

Specified by:

setRouteIDFieldName in interface IRouteLocatorOperations2

Parameters:

routeIDFieldName - The routeIDFieldName (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 feature identifier.

Specified by:

getRouteIDFieldName in interface IRouteLocatorOperations2

Returns:

The routeIDFieldName

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.