com.esri.arcgis.geodatabase
Class NetworkDirections

java.lang.Object
  extended by com.esri.arcgis.geodatabase.NetworkDirections
All Implemented Interfaces:
INetworkDirections, INetworkDirections2, IRoadSplits, ISignposts, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class NetworkDirections
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INetworkDirections, INetworkDirections2, ISignposts, IRoadSplits

COM Class 'NetworkDirections'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'A container for describing and using network directions.' 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.geodatabase.INetworkDirections2
IID, IID85301471_abad_49ee_aa65_fc498d75f362, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.INetworkDirections
IIDacda7b59_b41f_48b8_a1ce_582fe481053f
 
Fields inherited from interface com.esri.arcgis.geodatabase.ISignposts
IID, IIDe44759d6_d13b_4e36_93ce_1e755f3177d5, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IRoadSplits
IID, IIDb1ec12cd_8925_45b9_8be6_ff9de87b7b98, xxDummy
 
Constructor Summary
NetworkDirections()
          Constructs a NetworkDirections using ArcGIS Engine.
NetworkDirections(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetworkDirections theNetworkDirections = (NetworkDirections) obj;
 
Method Summary
 boolean equals(java.lang.Object o)
          Compare this object with another
 IArray getAttributeMappings()
          The collection of directions attribute mapping.
static java.lang.String getClsid()
          getClsid.
 int getDefaultOutputLengthUnits()
          The default length units that will be used for reporting distances in driving directions.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getLengthAttributeName()
          The name of the network attribute to be used for reporting travel distances.
 java.lang.String getRoadClassAttributeName()
          The name of the network attribute to be used for road classification.
 java.lang.String getRoadSplitsTableName()
          The name of the table containing the road splits.
 java.lang.String getSignpostFeatureClassName()
          The name of the feature class containing the signposts.
 java.lang.String getSignpostStreetsTableName()
          The name of the indexed table of signpost street references.
 java.lang.String getTimeAttributeName()
          The name of the network attribute to be used for reporting travel time.
 int hashCode()
          the hashcode for this object
 void release()
          Release a NetworkDirections.
 void setAttributeMappingsByRef(IArray attributeMappings)
          The collection of directions attribute mapping.
 void setDefaultOutputLengthUnits(int units)
          The default length units that will be used for reporting distances in driving directions.
 void setLengthAttributeName(java.lang.String name)
          The name of the network attribute to be used for reporting travel distances.
 void setRoadClassAttributeName(java.lang.String name)
          The name of the network attribute to be used for road classification.
 void setRoadSplitsTableName(java.lang.String className)
          The name of the table containing the road splits.
 void setSignpostFeatureClassName(java.lang.String className)
          The name of the feature class containing the signposts.
 void setSignpostStreetsTableName(java.lang.String tableName)
          The name of the indexed table of signpost street references.
 void setTimeAttributeName(java.lang.String name)
          The name of the network attribute to be used for reporting travel time.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NetworkDirections

public NetworkDirections()
                  throws java.io.IOException,
                         java.net.UnknownHostException
Constructs a NetworkDirections using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

NetworkDirections

public NetworkDirections(java.lang.Object obj)
                  throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetworkDirections theNetworkDirections = (NetworkDirections) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getDefaultOutputLengthUnits

public int getDefaultOutputLengthUnits()
                                throws java.io.IOException,
                                       AutomationException
The default length units that will be used for reporting distances in driving directions.

Specified by:
getDefaultOutputLengthUnits in interface INetworkDirections
Returns:
A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultOutputLengthUnits

public void setDefaultOutputLengthUnits(int units)
                                 throws java.io.IOException,
                                        AutomationException
The default length units that will be used for reporting distances in driving directions.

Specified by:
setDefaultOutputLengthUnits in interface INetworkDirections
Parameters:
units - A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLengthAttributeName

public java.lang.String getLengthAttributeName()
                                        throws java.io.IOException,
                                               AutomationException
The name of the network attribute to be used for reporting travel distances.

Specified by:
getLengthAttributeName in interface INetworkDirections
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLengthAttributeName

public void setLengthAttributeName(java.lang.String name)
                            throws java.io.IOException,
                                   AutomationException
The name of the network attribute to be used for reporting travel distances.

Specified by:
setLengthAttributeName in interface INetworkDirections
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeAttributeName

public java.lang.String getTimeAttributeName()
                                      throws java.io.IOException,
                                             AutomationException
The name of the network attribute to be used for reporting travel time.

Specified by:
getTimeAttributeName in interface INetworkDirections
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTimeAttributeName

public void setTimeAttributeName(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException
The name of the network attribute to be used for reporting travel time.

Specified by:
setTimeAttributeName in interface INetworkDirections
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRoadClassAttributeName

public java.lang.String getRoadClassAttributeName()
                                           throws java.io.IOException,
                                                  AutomationException
The name of the network attribute to be used for road classification.

Specified by:
getRoadClassAttributeName in interface INetworkDirections
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRoadClassAttributeName

public void setRoadClassAttributeName(java.lang.String name)
                               throws java.io.IOException,
                                      AutomationException
The name of the network attribute to be used for road classification.

Specified by:
setRoadClassAttributeName in interface INetworkDirections
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttributeMappings

public IArray getAttributeMappings()
                            throws java.io.IOException,
                                   AutomationException
The collection of directions attribute mapping.

Specified by:
getAttributeMappings in interface INetworkDirections2
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAttributeMappingsByRef

public void setAttributeMappingsByRef(IArray attributeMappings)
                               throws java.io.IOException,
                                      AutomationException
The collection of directions attribute mapping.

Specified by:
setAttributeMappingsByRef in interface INetworkDirections2
Parameters:
attributeMappings - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSignpostFeatureClassName

public java.lang.String getSignpostFeatureClassName()
                                             throws java.io.IOException,
                                                    AutomationException
The name of the feature class containing the signposts.

Specified by:
getSignpostFeatureClassName in interface ISignposts
Returns:
The className
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSignpostFeatureClassName

public void setSignpostFeatureClassName(java.lang.String className)
                                 throws java.io.IOException,
                                        AutomationException
The name of the feature class containing the signposts.

Specified by:
setSignpostFeatureClassName in interface ISignposts
Parameters:
className - The className (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSignpostStreetsTableName

public java.lang.String getSignpostStreetsTableName()
                                             throws java.io.IOException,
                                                    AutomationException
The name of the indexed table of signpost street references.

Specified by:
getSignpostStreetsTableName in interface ISignposts
Returns:
The tableName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSignpostStreetsTableName

public void setSignpostStreetsTableName(java.lang.String tableName)
                                 throws java.io.IOException,
                                        AutomationException
The name of the indexed table of signpost street references.

Specified by:
setSignpostStreetsTableName in interface ISignposts
Parameters:
tableName - The tableName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRoadSplitsTableName

public java.lang.String getRoadSplitsTableName()
                                        throws java.io.IOException,
                                               AutomationException
The name of the table containing the road splits.

Specified by:
getRoadSplitsTableName in interface IRoadSplits
Returns:
The className
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRoadSplitsTableName

public void setRoadSplitsTableName(java.lang.String className)
                            throws java.io.IOException,
                                   AutomationException
The name of the table containing the road splits.

Specified by:
setRoadSplitsTableName in interface IRoadSplits
Parameters:
className - The className (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.