com.esri.arcgis.datasourcesfile
Class SMRouterFactory

java.lang.Object
  com.esri.arcgis.datasourcesfile.SMRouterFactory

All Implemented Interfaces:

ISMRouterFactory, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class SMRouterFactory
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISMRouterFactory

The object for creating router objects.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SMRouterFactory()
Constructs a SMRouterFactory using ArcGIS Engine.

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

Method Summary

ISMRouter	createRouter(String routingFilePath) Creates a SMRouter object based on information in the input routing initialization file.
ISMRouter	createRouterCfg(String routingFilePath, String configPath) Creates a SMRouter object based on additional information in the alternate routing configuration file.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object

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

SMRouterFactory

public SMRouterFactory()
                throws IOException,
                       UnknownHostException

Constructs a SMRouterFactory using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SMRouterFactory

public SMRouterFactory(Object obj)
                throws IOException

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

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

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

createRouter

public ISMRouter createRouter(String routingFilePath)
                       throws IOException,
                              AutomationException

Creates a SMRouter object based on information in the input routing initialization file.

Description

The method creates a SMRouter object reading necessary information from the routing initialization file that is passed in.

Remarks

The method returns an instance of the SMRouter object if successful. Otherwise it returns Nothing.

A routing initialization file, for example routing.ini or routing.rs, contains the definition of the routing service based on the specific information about routing data source.

Product Availability

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

Specified by:

createRouter in interface ISMRouterFactory

Parameters:

routingFilePath - The routingFilePath (in)

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMRouter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRouterCfg

public ISMRouter createRouterCfg(String routingFilePath,
                                 String configPath)
                          throws IOException,
                                 AutomationException

Creates a SMRouter object based on additional information in the alternate routing configuration file.

Description

The method creates SMRouter object using the alternate configuration file along with the main routing initialization file.

Remarks

The method returns an instance of the SMRouter object if successful. Otherwise it returns Nothing.

A routing initialization file, for example routing.ini or routing.rs, contains the definition of the routing service based on the specific information about routing data source.

A routing configuration file, for example routing.cfg, contains application specific information such as driving directions patterns, texts of directions parts, distance, time formats, and so on.

Product Availability

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

Specified by:

createRouterCfg in interface ISMRouterFactory

Parameters:

routingFilePath - The routingFilePath (in)

configPath - The configPath (in)

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMRouter

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.