com.esri.arcgis.geodatabase
Class NetworkSourceDirections

java.lang.Object
  com.esri.arcgis.geodatabase.NetworkSourceDirections

All Implemented Interfaces:

INetworkSourceDirections, INetworkSourceDirections2, INetworkSourceDirections3, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class NetworkSourceDirections
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INetworkSourceDirections, INetworkSourceDirections2, INetworkSourceDirections3

A container for describing how to generate driving directions for a network dataset source.

Description

The NetworkSourceDirections coclass contains members for setting directions information at the network source level.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NetworkSourceDirections()
Constructs a NetworkSourceDirections using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
String	getAdminAreaFieldName() The name of the field containing the administrative area information for generating driving directions.
static String	getClsid() getClsid.
IArray	getFieldMappings() The collection of directions field mapping.
IArray	getLandmarkEventSources() The collection of DirectionsLandmarkSource items used to generate event bypass instructions.
IArray	getLandmarkManeuverSources() The collection of DirectionsLandmarkSource items used to improve maneuver guidance.
IShields	getShields() The directions shields settings for this source.
IArray	getStreetNameFields() The fields containing the street names used in reporting driving directions.
int	hashCode() the hashcode for this object
void	setAdminAreaFieldName(String name) The name of the field containing the administrative area information for generating driving directions.
void	setFieldMappingsByRef(IArray fieldMappings) The collection of directions field mapping.
void	setLandmarkEventSourcesByRef(IArray eventSources) The collection of DirectionsLandmarkSource items used to generate event bypass instructions.
void	setLandmarkManeuverSourcesByRef(IArray maneuverSources) The collection of DirectionsLandmarkSource items used to improve maneuver guidance.
void	setShieldsByRef(IShields shields) The directions shields settings for this source.
void	setStreetNameFieldsByRef(IArray fields) The fields containing the street names used in reporting driving directions.

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

NetworkSourceDirections

public NetworkSourceDirections()
                        throws IOException,
                               UnknownHostException

Constructs a NetworkSourceDirections using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NetworkSourceDirections

public NetworkSourceDirections(Object obj)
                        throws IOException

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

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

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

getShields

public IShields getShields()
                    throws IOException,
                           AutomationException

The directions shields settings for this source.

Remarks

The Shields property takes in an IShields object that contains the Shields information for each network source.

Product Availability

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

Specified by:

getShields in interface INetworkSourceDirections

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShieldsByRef

public void setShieldsByRef(IShields shields)
                     throws IOException,
                            AutomationException

The directions shields settings for this source.

Product Availability

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

Specified by:

setShieldsByRef in interface INetworkSourceDirections

Parameters:

shields - A reference to a com.esri.arcgis.geodatabase.IShields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAdminAreaFieldName

public String getAdminAreaFieldName()
                             throws IOException,
                                    AutomationException

The name of the field containing the administrative area information for generating driving directions.

Remarks

The AdminAreaFieldName property takes in a field name pointing to a field that contains information on moving from one region to another. For example, a network source may have a field called "States" that lists which state each feature is in. When directions are generated, this field can be used for indicating when the network analysis result crosses from one region into another.

Only one AdminAreaFieldName can be specified for each network source.

Product Availability

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

Specified by:

getAdminAreaFieldName in interface INetworkSourceDirections

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAdminAreaFieldName

public void setAdminAreaFieldName(String name)
                           throws IOException,
                                  AutomationException

The name of the field containing the administrative area information for generating driving directions.

Product Availability

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

Specified by:

setAdminAreaFieldName in interface INetworkSourceDirections

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStreetNameFields

public IArray getStreetNameFields()
                           throws IOException,
                                  AutomationException

The fields containing the street names used in reporting driving directions.

Remarks

The StreetNameFields property takes in an IArray object that contains one to many IStreetNameFields objects. This property allows the specification of a primary name and many alternate names for edge sources.

Product Availability

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

Specified by:

getStreetNameFields in interface INetworkSourceDirections

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStreetNameFieldsByRef

public void setStreetNameFieldsByRef(IArray fields)
                              throws IOException,
                                     AutomationException

The fields containing the street names used in reporting driving directions.

Product Availability

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

Specified by:

setStreetNameFieldsByRef in interface INetworkSourceDirections

Parameters:

fields - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldMappings

public IArray getFieldMappings()
                        throws IOException,
                               AutomationException

The collection of directions field mapping.

Product Availability

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

Specified by:

getFieldMappings in interface INetworkSourceDirections2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldMappingsByRef

public void setFieldMappingsByRef(IArray fieldMappings)
                           throws IOException,
                                  AutomationException

The collection of directions field mapping.

Product Availability

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

Specified by:

setFieldMappingsByRef in interface INetworkSourceDirections2

Parameters:

fieldMappings - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLandmarkEventSources

public IArray getLandmarkEventSources()
                               throws IOException,
                                      AutomationException

The collection of DirectionsLandmarkSource items used to generate event bypass instructions.

Product Availability

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

Specified by:

getLandmarkEventSources in interface INetworkSourceDirections3

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLandmarkEventSourcesByRef

public void setLandmarkEventSourcesByRef(IArray eventSources)
                                  throws IOException,
                                         AutomationException

The collection of DirectionsLandmarkSource items used to generate event bypass instructions.

Product Availability

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

Specified by:

setLandmarkEventSourcesByRef in interface INetworkSourceDirections3

Parameters:

eventSources - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLandmarkManeuverSources

public IArray getLandmarkManeuverSources()
                                  throws IOException,
                                         AutomationException

The collection of DirectionsLandmarkSource items used to improve maneuver guidance.

Product Availability

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

Specified by:

getLandmarkManeuverSources in interface INetworkSourceDirections3

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLandmarkManeuverSourcesByRef

public void setLandmarkManeuverSourcesByRef(IArray maneuverSources)
                                     throws IOException,
                                            AutomationException

The collection of DirectionsLandmarkSource items used to improve maneuver guidance.

Product Availability

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

Specified by:

setLandmarkManeuverSourcesByRef in interface INetworkSourceDirections3

Parameters:

maneuverSources - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.