com.esri.arcgis.arcweb
Class ArcWebRouteFinder

java.lang.Object
  com.esri.arcgis.arcweb.ArcWebRouteFinder

All Implemented Interfaces:

IArcWebRouteFinder, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class ArcWebRouteFinder
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebRouteFinder, ISupportErrorInfo

An ArcWeb service used to find routes and generate driving directions between multiple locations.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ArcWebRouteFinder()
Constructs a ArcWebRouteFinder using ArcGIS Engine.

ArcWebRouteFinder(Object obj)
Construct a ArcWebRouteFinder using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
IArcWebRouteInfo	findRoute(IEnumArcWebRouteStops routeStops, IArcWebRouteFinderOptions routeFinderOptions, ITrackCancel cancelTracker) Returns route information for a given set of route stops and routing parameters.
static String	getClsid() getClsid.
IEnumBSTR	getLanguages(ITrackCancel cancelTracker) Gets the supported languages for the driving directions.
IEnumArcWebDataSourceInfo	getSupportedDataSources(ITrackCancel pCancelTracker) Gets the supported data sources for the route finding service.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo

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

ArcWebRouteFinder

public ArcWebRouteFinder()
                  throws IOException,
                         UnknownHostException

Constructs a ArcWebRouteFinder using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArcWebRouteFinder

public ArcWebRouteFinder(Object obj)
                  throws IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems ArcWebRouteFinder theArcWebRouteFinder = (ArcWebRouteFinder) obj;

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

getLanguages

public IEnumBSTR getLanguages(ITrackCancel cancelTracker)
                       throws IOException,
                              AutomationException

Gets the supported languages for the driving directions.

Product Availability

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

Specified by:

getLanguages in interface IArcWebRouteFinder

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findRoute

public IArcWebRouteInfo findRoute(IEnumArcWebRouteStops routeStops,
                                  IArcWebRouteFinderOptions routeFinderOptions,
                                  ITrackCancel cancelTracker)
                           throws IOException,
                                  AutomationException

Returns route information for a given set of route stops and routing parameters.

Product Availability

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

Specified by:

findRoute in interface IArcWebRouteFinder

Parameters:

routeStops - A reference to a com.esri.arcgis.arcweb.IEnumArcWebRouteStops (in)

routeFinderOptions - A reference to a com.esri.arcgis.arcweb.IArcWebRouteFinderOptions (in)

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IArcWebRouteInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedDataSources

public IEnumArcWebDataSourceInfo getSupportedDataSources(ITrackCancel pCancelTracker)
                                                  throws IOException,
                                                         AutomationException

Gets the supported data sources for the route finding service.

Product Availability

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

Specified by:

getSupportedDataSources in interface IArcWebRouteFinder

Parameters:

pCancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IEnumArcWebDataSourceInfo

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.