com.esri.arcgis.geodatabase
Class DENetworkDataset

java.lang.Object
  extended by com.esri.arcgis.geodatabase.DENetworkDataset
All Implemented Interfaces:
IDataElement, IDEDataset, IDEGeoDataset, IDENetworkDataset, IDENetworkDataset2, IDENetworkDataset3, IGPDescribe, IGPValue, IMetadata, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class DENetworkDataset
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDEDataset, IDEGeoDataset, IDENetworkDataset, IDENetworkDataset2, IDENetworkDataset3, IDataElement, IMetadata, IGPValue, IClone, IXMLSerialize, IPersistStream, IGPDescribe, java.io.Externalizable

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

Description 'Network Dataset Data Element object.' 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
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDEDataset
IID, IID29fbed10_a332_11d5_931b_0080c71a3226, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDEGeoDataset
IID, IID5ed64e50_a2f2_11d5_931b_0080c71a3226, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDENetworkDataset3
IID, IIDaa928482_be1c_4d96_ba75_05233e614424, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDENetworkDataset2
IID9ec0957a_9127_4084_8d0d_d4341101a15e
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDENetworkDataset
IID71e4aa21_1957_4224_b505_984c189aa520
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDataElement
IID, IIDe2c87df0_33d9_4a47_9b67_fa54b2fd7966, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IMetadata
IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IGPValue
IID, IID92ee08b6_c757_4178_803c_67cd665ac801, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IClone
IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Constructor Summary
DENetworkDataset()
          Constructs a DENetworkDataset using ArcGIS Engine.
DENetworkDataset(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DENetworkDataset theDENetworkDataset = (DENetworkDataset) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 java.lang.Object describe(java.lang.String name)
          The description of the named object.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void empty()
          Clears the value object.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 java.lang.String getAsText()
          Provides the value of the value object.
 IArray getAttributes()
          Array of network attributes in this network dataset.
 java.lang.String getBaseName()
          File base name.
 java.lang.String getCatalogPath()
          The string used to retrieve the element.
 IArray getChildren()
          The list of sub-elements.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 java.lang.String getConfigurationKeyword()
          The database configuration keyword for the network dataset.
 int getDatasetType()
          Dataset type.
 INetworkDirections getDirections()
          The driving directions settings for the network dataset.
 int getDSID()
          The id of the dataset.
 int getElevationModel()
          The type of the network elevation model.
 java.lang.String getExtension()
          File extension.
 IEnvelope getExtent()
          The extent of the coverage.
 java.lang.String getFile()
          File name.
 INetworkAttribute getHierarchyClusterAttribute()
          The network attribute that is used to optimize network building for hierarchical traversal.
 int getHierarchyLevelCount()
          The number of hierarchy levels in the network dataset.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getMaxValueForHierarchy(int level)
          The maximum value for the specified hierarchy level in the network dataset.
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 int getNetworkType()
          The type of the network dataset.
 java.lang.String getPath()
          File path.
 IPropertySet getProperties()
          Property set of this network dataset.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 IArray getSources()
          Array of network sources in this network dataset.
 ISpatialReference getSpatialReference()
          The spatial reference of the geodataset.
 java.lang.String getTimeZoneAttributeName()
          Name of the time zone attribute.
 java.lang.String getTimeZoneTableName()
          Name of the time zone table.
 ITrafficData getTrafficData()
          Traffic data.
 IArray getTravelModes()
          Array of network travel modes in this network dataset.
 IPropertySet getUserData()
          User specified property set of this network dataset.
 int hashCode()
          the hashcode for this object
 java.lang.String IDataElement_getName()
          The user assigned name for the element.
 java.lang.String IDataElement_getType()
          The type of the element.
 IGPDataType IGPValue_getDataType()
          The data type of the value object.
 boolean isBuildable()
          Indicates if this network dataset is buildable.
 boolean isCanVersion()
          Indicates if this dataset can be versioned.
 boolean isChildrenExpanded()
          Indicates if the children have been expanded.
 void isDirty()
          isDirty
 boolean isEmpty()
          Indicates if the value object is empty.
 boolean isEqual(IClone other)
          Indicates if the receiver and other have the same properties.
 boolean isFullPropsRetrieved()
          Indicates if full properties have been retrieved.
 boolean isIdentical(IClone other)
          Indicates if the receiver and other are the same object.
 boolean isMetadataRetrieved()
          Indicates if the metadata has been retrieved.
 boolean isSupportsTurns()
          Indicates if this network dataset supports network turn elements.
 boolean isVersioned()
          Indicates if this dataset is versioned.
 void load(IStream pstm)
          load
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a DENetworkDataset.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 IGPMessage setAsText(java.lang.String text)
          Provides the value of the value object with the given string value.
 void setAttributesByRef(IArray attributes)
          Array of network attributes in this network dataset.
 void setBuildable(boolean supportsTurns)
          Indicates if this network dataset is buildable.
 void setCanVersion(boolean canVersion)
          Indicates if this dataset can be versioned.
 void setCatalogPath(java.lang.String path)
          The string used to retrieve the element.
 void setChildrenByRef(IArray dataElements)
          The list of sub-elements.
 void setChildrenExpanded(boolean childrenExpanded)
          Indicates if the children have been expanded.
 void setConfigurationKeyword(java.lang.String configKeyword)
          The database configuration keyword for the network dataset.
 void setDatasetType(int type)
          Dataset type.
 void setDirectionsByRef(INetworkDirections directions)
          The driving directions settings for the network dataset.
 void setDSID(int dSID)
          The id of the dataset.
 void setElevationModel(int networkElevationModel)
          The type of the network elevation model.
 void setExtentByRef(IEnvelope extent)
          The extent of the coverage.
 void setFullPropsRetrieved(boolean fullPropsRetrieved)
          Indicates if full properties have been retrieved.
 void setHierarchyClusterAttribute(INetworkAttribute attribute)
          The network attribute that is used to optimize network building for hierarchical traversal.
 void setHierarchyLevelCount(int count)
          The number of hierarchy levels in the network dataset.
 void setMaxValueForHierarchy(int level, int value)
          The maximum value for the specified hierarchy level in the network dataset.
 void setMetadata(IPropertySet propertySet)
          The PropertySet containing metadata.
 void setMetadataRetrieved(boolean metadataRetrieved)
          Indicates if the metadata has been retrieved.
 void setName(java.lang.String name)
          The user assigned name for the element.
 void setNetworkType(int type)
          The type of the network dataset.
 void setProperties(IPropertySet datasetProperties)
          Property set of this network dataset.
 void setSourcesByRef(IArray sources)
          Array of network sources in this network dataset.
 void setSpatialReferenceByRef(ISpatialReference spatialReference)
          The spatial reference of the geodataset.
 void setSupportsTurns(boolean supportsTurns)
          Indicates if this network dataset supports network turn elements.
 void setTimeZoneAttributeName(java.lang.String attributeName)
          Name of the time zone attribute.
 void setTimeZoneTableName(java.lang.String tableName)
          Name of the time zone table.
 void setTrafficDataByRef(ITrafficData trafficData)
          Traffic data.
 void setTravelModes(IArray travelModes)
          Array of network travel modes in this network dataset.
 void setType(java.lang.String type)
          The type of the element.
 void setUserData(IPropertySet userProperties)
          User specified property set of this network dataset.
 void setVersioned(boolean versioned)
          Indicates if this dataset is versioned.
 void synchronize(int action, int interval)
          Updates metadata with the current properties; may create metadata if it doesn't already exist.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

DENetworkDataset

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

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

DENetworkDataset

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

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

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

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

getDatasetType

public int getDatasetType()
                   throws java.io.IOException,
                          AutomationException
Dataset type.

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

setDatasetType

public void setDatasetType(int type)
                    throws java.io.IOException,
                           AutomationException
Dataset type.

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

isVersioned

public boolean isVersioned()
                    throws java.io.IOException,
                           AutomationException
Indicates if this dataset is versioned.

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

setVersioned

public void setVersioned(boolean versioned)
                  throws java.io.IOException,
                         AutomationException
Indicates if this dataset is versioned.

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

getDSID

public int getDSID()
            throws java.io.IOException,
                   AutomationException
The id of the dataset.

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

setDSID

public void setDSID(int dSID)
             throws java.io.IOException,
                    AutomationException
The id of the dataset.

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

isCanVersion

public boolean isCanVersion()
                     throws java.io.IOException,
                            AutomationException
Indicates if this dataset can be versioned.

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

setCanVersion

public void setCanVersion(boolean canVersion)
                   throws java.io.IOException,
                          AutomationException
Indicates if this dataset can be versioned.

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

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException
The extent of the coverage.

Specified by:
getExtent in interface IDEGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtentByRef

public void setExtentByRef(IEnvelope extent)
                    throws java.io.IOException,
                           AutomationException
The extent of the coverage.

Specified by:
setExtentByRef in interface IDEGeoDataset
Parameters:
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException
The spatial reference of the geodataset.

Specified by:
getSpatialReference in interface IDEGeoDataset
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialReference)
                              throws java.io.IOException,
                                     AutomationException
The spatial reference of the geodataset.

Specified by:
setSpatialReferenceByRef in interface IDEGeoDataset
Parameters:
spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNetworkType

public int getNetworkType()
                   throws java.io.IOException,
                          AutomationException
The type of the network dataset.

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

setNetworkType

public void setNetworkType(int type)
                    throws java.io.IOException,
                           AutomationException
The type of the network dataset.

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

getAttributes

public IArray getAttributes()
                     throws java.io.IOException,
                            AutomationException
Array of network attributes in this network dataset.

Specified by:
getAttributes in interface IDENetworkDataset
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.

setAttributesByRef

public void setAttributesByRef(IArray attributes)
                        throws java.io.IOException,
                               AutomationException
Array of network attributes in this network dataset.

Specified by:
setAttributesByRef in interface IDENetworkDataset
Parameters:
attributes - 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.

getConfigurationKeyword

public java.lang.String getConfigurationKeyword()
                                         throws java.io.IOException,
                                                AutomationException
The database configuration keyword for the network dataset.

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

setConfigurationKeyword

public void setConfigurationKeyword(java.lang.String configKeyword)
                             throws java.io.IOException,
                                    AutomationException
The database configuration keyword for the network dataset.

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

getSources

public IArray getSources()
                  throws java.io.IOException,
                         AutomationException
Array of network sources in this network dataset.

Specified by:
getSources in interface IDENetworkDataset
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.

setSourcesByRef

public void setSourcesByRef(IArray sources)
                     throws java.io.IOException,
                            AutomationException
Array of network sources in this network dataset.

Specified by:
setSourcesByRef in interface IDENetworkDataset
Parameters:
sources - 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.

getDirections

public INetworkDirections getDirections()
                                 throws java.io.IOException,
                                        AutomationException
The driving directions settings for the network dataset.

Specified by:
getDirections in interface IDENetworkDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.INetworkDirections
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDirectionsByRef

public void setDirectionsByRef(INetworkDirections directions)
                        throws java.io.IOException,
                               AutomationException
The driving directions settings for the network dataset.

Specified by:
setDirectionsByRef in interface IDENetworkDataset
Parameters:
directions - A reference to a com.esri.arcgis.geodatabase.INetworkDirections (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportsTurns

public boolean isSupportsTurns()
                        throws java.io.IOException,
                               AutomationException
Indicates if this network dataset supports network turn elements.

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

setSupportsTurns

public void setSupportsTurns(boolean supportsTurns)
                      throws java.io.IOException,
                             AutomationException
Indicates if this network dataset supports network turn elements.

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

isBuildable

public boolean isBuildable()
                    throws java.io.IOException,
                           AutomationException
Indicates if this network dataset is buildable.

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

setBuildable

public void setBuildable(boolean supportsTurns)
                  throws java.io.IOException,
                         AutomationException
Indicates if this network dataset is buildable.

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

getUserData

public IPropertySet getUserData()
                         throws java.io.IOException,
                                AutomationException
User specified property set of this network dataset.

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

setUserData

public void setUserData(IPropertySet userProperties)
                 throws java.io.IOException,
                        AutomationException
User specified property set of this network dataset.

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

getProperties

public IPropertySet getProperties()
                           throws java.io.IOException,
                                  AutomationException
Property set of this network dataset.

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

setProperties

public void setProperties(IPropertySet datasetProperties)
                   throws java.io.IOException,
                          AutomationException
Property set of this network dataset.

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

getHierarchyClusterAttribute

public INetworkAttribute getHierarchyClusterAttribute()
                                               throws java.io.IOException,
                                                      AutomationException
The network attribute that is used to optimize network building for hierarchical traversal.

Specified by:
getHierarchyClusterAttribute in interface IDENetworkDataset
Returns:
A reference to a com.esri.arcgis.geodatabase.INetworkAttribute
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHierarchyClusterAttribute

public void setHierarchyClusterAttribute(INetworkAttribute attribute)
                                  throws java.io.IOException,
                                         AutomationException
The network attribute that is used to optimize network building for hierarchical traversal.

Specified by:
setHierarchyClusterAttribute in interface IDENetworkDataset
Parameters:
attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHierarchyLevelCount

public void setHierarchyLevelCount(int count)
                            throws java.io.IOException,
                                   AutomationException
The number of hierarchy levels in the network dataset.

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

getHierarchyLevelCount

public int getHierarchyLevelCount()
                           throws java.io.IOException,
                                  AutomationException
The number of hierarchy levels in the network dataset.

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

setMaxValueForHierarchy

public void setMaxValueForHierarchy(int level,
                                    int value)
                             throws java.io.IOException,
                                    AutomationException
The maximum value for the specified hierarchy level in the network dataset.

Specified by:
setMaxValueForHierarchy in interface IDENetworkDataset
Parameters:
level - The level (in)
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxValueForHierarchy

public int getMaxValueForHierarchy(int level)
                            throws java.io.IOException,
                                   AutomationException
The maximum value for the specified hierarchy level in the network dataset.

Specified by:
getMaxValueForHierarchy in interface IDENetworkDataset
Parameters:
level - The level (in)
Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElevationModel

public int getElevationModel()
                      throws java.io.IOException,
                             AutomationException
The type of the network elevation model.

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

setElevationModel

public void setElevationModel(int networkElevationModel)
                       throws java.io.IOException,
                              AutomationException
The type of the network elevation model.

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

getTrafficData

public ITrafficData getTrafficData()
                            throws java.io.IOException,
                                   AutomationException
Traffic data.

Specified by:
getTrafficData in interface IDENetworkDataset2
Returns:
A reference to a com.esri.arcgis.geodatabase.ITrafficData
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrafficDataByRef

public void setTrafficDataByRef(ITrafficData trafficData)
                         throws java.io.IOException,
                                AutomationException
Traffic data.

Specified by:
setTrafficDataByRef in interface IDENetworkDataset2
Parameters:
trafficData - A reference to a com.esri.arcgis.geodatabase.ITrafficData (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTimeZoneAttributeName

public java.lang.String getTimeZoneAttributeName()
                                          throws java.io.IOException,
                                                 AutomationException
Name of the time zone attribute.

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

setTimeZoneAttributeName

public void setTimeZoneAttributeName(java.lang.String attributeName)
                              throws java.io.IOException,
                                     AutomationException
Name of the time zone attribute.

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

getTimeZoneTableName

public java.lang.String getTimeZoneTableName()
                                      throws java.io.IOException,
                                             AutomationException
Name of the time zone table.

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

setTimeZoneTableName

public void setTimeZoneTableName(java.lang.String tableName)
                          throws java.io.IOException,
                                 AutomationException
Name of the time zone table.

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

getTravelModes

public IArray getTravelModes()
                      throws java.io.IOException,
                             AutomationException
Array of network travel modes in this network dataset.

Specified by:
getTravelModes in interface IDENetworkDataset3
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.

setTravelModes

public void setTravelModes(IArray travelModes)
                    throws java.io.IOException,
                           AutomationException
Array of network travel modes in this network dataset.

Specified by:
setTravelModes in interface IDENetworkDataset3
Parameters:
travelModes - 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.

IDataElement_getType

public java.lang.String IDataElement_getType()
                                      throws java.io.IOException,
                                             AutomationException
The type of the element.

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

setType

public void setType(java.lang.String type)
             throws java.io.IOException,
                    AutomationException
The type of the element.

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

IDataElement_getName

public java.lang.String IDataElement_getName()
                                      throws java.io.IOException,
                                             AutomationException
The user assigned name for the element.

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

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
The user assigned name for the element.

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

getCatalogPath

public java.lang.String getCatalogPath()
                                throws java.io.IOException,
                                       AutomationException
The string used to retrieve the element.

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

setCatalogPath

public void setCatalogPath(java.lang.String path)
                    throws java.io.IOException,
                           AutomationException
The string used to retrieve the element.

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

getChildren

public IArray getChildren()
                   throws java.io.IOException,
                          AutomationException
The list of sub-elements.

Specified by:
getChildren in interface IDataElement
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.

setChildrenByRef

public void setChildrenByRef(IArray dataElements)
                      throws java.io.IOException,
                             AutomationException
The list of sub-elements.

Specified by:
setChildrenByRef in interface IDataElement
Parameters:
dataElements - 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.

isChildrenExpanded

public boolean isChildrenExpanded()
                           throws java.io.IOException,
                                  AutomationException
Indicates if the children have been expanded.

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

setChildrenExpanded

public void setChildrenExpanded(boolean childrenExpanded)
                         throws java.io.IOException,
                                AutomationException
Indicates if the children have been expanded.

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

isMetadataRetrieved

public boolean isMetadataRetrieved()
                            throws java.io.IOException,
                                   AutomationException
Indicates if the metadata has been retrieved.

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

setMetadataRetrieved

public void setMetadataRetrieved(boolean metadataRetrieved)
                          throws java.io.IOException,
                                 AutomationException
Indicates if the metadata has been retrieved.

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

isFullPropsRetrieved

public boolean isFullPropsRetrieved()
                             throws java.io.IOException,
                                    AutomationException
Indicates if full properties have been retrieved.

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

setFullPropsRetrieved

public void setFullPropsRetrieved(boolean fullPropsRetrieved)
                           throws java.io.IOException,
                                  AutomationException
Indicates if full properties have been retrieved.

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

getPath

public java.lang.String getPath()
                         throws java.io.IOException,
                                AutomationException
File path.

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

getFile

public java.lang.String getFile()
                         throws java.io.IOException,
                                AutomationException
File name.

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

getBaseName

public java.lang.String getBaseName()
                             throws java.io.IOException,
                                    AutomationException
File base name.

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

getExtension

public java.lang.String getExtension()
                              throws java.io.IOException,
                                     AutomationException
File extension.

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

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException
The PropertySet containing metadata.

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

setMetadata

public void setMetadata(IPropertySet propertySet)
                 throws java.io.IOException,
                        AutomationException
The PropertySet containing metadata.

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

synchronize

public void synchronize(int action,
                        int interval)
                 throws java.io.IOException,
                        AutomationException
Updates metadata with the current properties; may create metadata if it doesn't already exist.

Specified by:
synchronize in interface IMetadata
Parameters:
action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)
interval - The interval (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws java.io.IOException,
                                        AutomationException
The data type of the value object.

Specified by:
IGPValue_getDataType in interface IGPValue
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPDataType
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws java.io.IOException,
                       AutomationException
Indicates if the value object is empty.

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

empty

public void empty()
           throws java.io.IOException,
                  AutomationException
Clears the value object.

Specified by:
empty in interface IGPValue
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAsText

public java.lang.String getAsText()
                           throws java.io.IOException,
                                  AutomationException
Provides the value of the value object.

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

setAsText

public IGPMessage setAsText(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException
Provides the value of the value object with the given string value.

Specified by:
setAsText in interface IGPValue
Parameters:
text - The text (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessage
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

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

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException
Assigns the properties of src to the receiver.

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

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException
Indicates if the receiver and other have the same properties.

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException
Indicates if the receiver and other are the same object.

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException
Serializes an object to XML.

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

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException
Deserializes an object from XML.

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

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

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

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

describe

public java.lang.Object describe(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException
The description of the named object.

Product Availability

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

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

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException