com.esri.arcgis.geodatabase

Class NetworkDirections

java.lang.Object

com.esri.arcgis.geodatabase.NetworkDirections

All Implemented Interfaces:

INetworkDirections, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

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

COM Class 'NetworkDirections'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

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

IID, IIDacda7b59_b41f_48b8_a1ce_582fe481053f, xxDummy

Constructor Summary

Constructors

Constructor and Description
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

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getAbbreviationsTableName() The abbreviatiations table name.
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 directions.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getLengthAttributeName() The name of the network attribute to be used for reporting travel distances.
IStringArray	getReferenceLandmarkSources() The array of reference landmark source names.
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
boolean	isSupportsLocalizedStreetNames() The flag that indicates if network has street names translated in multiple languages.
void	release() Release this COM object reference
void	setAbbreviationsTableName(java.lang.String tableName) The abbreviatiations table name.
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 directions.
void	setLengthAttributeName(java.lang.String name) The name of the network attribute to be used for reporting travel distances.
void	setReferenceLandmarkSourcesByRef(IStringArray sourceNames) The array of reference landmark source names.
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	setSupportsLocalizedStreetNames(boolean localizedStreetNames) The flag that indicates if network has street names translated in multiple languages.
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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

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 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 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 INetworkDirections

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 INetworkDirections

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.

isSupportsLocalizedStreetNames

public boolean isSupportsLocalizedStreetNames()
                                       throws java.io.IOException,
                                              AutomationException

The flag that indicates if network has street names translated in multiple languages.

Specified by:

isSupportsLocalizedStreetNames in interface INetworkDirections

Returns:

The localizedStreetNames

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSupportsLocalizedStreetNames

public void setSupportsLocalizedStreetNames(boolean localizedStreetNames)
                                     throws java.io.IOException,
                                            AutomationException

The flag that indicates if network has street names translated in multiple languages.

Specified by:

setSupportsLocalizedStreetNames in interface INetworkDirections

Parameters:

localizedStreetNames - The localizedStreetNames (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReferenceLandmarkSources

public IStringArray getReferenceLandmarkSources()
                                         throws java.io.IOException,
                                                AutomationException

The array of reference landmark source names.

Specified by:

getReferenceLandmarkSources in interface INetworkDirections

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReferenceLandmarkSourcesByRef

public void setReferenceLandmarkSourcesByRef(IStringArray sourceNames)
                                      throws java.io.IOException,
                                             AutomationException

The array of reference landmark source names.

Specified by:

setReferenceLandmarkSourcesByRef in interface INetworkDirections

Parameters:

sourceNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAbbreviationsTableName

public java.lang.String getAbbreviationsTableName()
                                           throws java.io.IOException,
                                                  AutomationException

The abbreviatiations table name.

Specified by:

getAbbreviationsTableName in interface INetworkDirections

Returns:

The tableName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAbbreviationsTableName

public void setAbbreviationsTableName(java.lang.String tableName)
                               throws java.io.IOException,
                                      AutomationException

The abbreviatiations table name.

Specified by:

setAbbreviationsTableName in interface INetworkDirections

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 INetworkDirections

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 INetworkDirections

Parameters:

className - The className (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 INetworkDirections

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 INetworkDirections

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 INetworkDirections

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 INetworkDirections

Parameters:

tableName - The tableName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.