com.esri.arcgis.geodatabase
Class DEGeometricNetwork

java.lang.Object
  extended by com.esri.arcgis.geodatabase.DEGeometricNetwork
All Implemented Interfaces:
IDataElement, IDEDataset, IDEDataset2, IDEGeoDataset, IDEGeometricNetwork, IDEGeometricNetwork2, IGPDescribe, IGPValue, IMetadata, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class DEGeometricNetwork
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDEGeometricNetwork2, IDEGeoDataset, IDEDataset2, IDataElement, IMetadata, IGPValue, IXMLSerialize, IClone, IPersistStream, IGPDescribe, java.io.Externalizable

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

Description 'GeometricNetwork 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.IDEGeometricNetwork2
IID, IID4169ef6e_9e94_45c2_af70_509a62a0d1ec, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDEGeometricNetwork
IIDacdbe3c0_e303_43e1_8038_8b391692f267
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDEGeoDataset
IID, IID5ed64e50_a2f2_11d5_931b_0080c71a3226, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDEDataset2
IID, IID90532b92_762b_4d10_b2a7_c42c852991ad, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IDEDataset
IID29fbed10_a332_11d5_931b_0080c71a3226
 
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.IXMLSerialize
IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, 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.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Constructor Summary
DEGeometricNetwork()
          Constructs a DEGeometricNetwork using ArcGIS Engine.
DEGeometricNetwork(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DEGeometricNetwork theDEGeometricNetwork = (DEGeometricNetwork) 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.
 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()
          Configuration keyword.
 int getDatasetType()
          Dataset type.
 int getDSID()
          The id of the dataset.
 java.lang.String getExtension()
          File extension.
 IEnvelope getExtent()
          The extent of the coverage.
 IStringArray getFeatureClassNames()
          The feature classes involved in the geometric network.
 java.lang.String getFile()
          File name.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 int getNetworkType()
          The type of associated logical network.
 IArray getNetworkWeights()
          The weights of the geometric network.
 java.lang.String getOrphanJunctionFeatureClassName()
          The FeatureClass containing the OrphanJunctionFeatures.
 java.lang.String getPath()
          File path.
 IArray getRules()
          The connectivity rules associated with the network.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ISpatialReference getSpatialReference()
          The spatial reference of the geodataset.
 IArray getWeightAssociations()
          The weight associations of the geometric network.
 double getXYSnapTolerance()
          XY snap tolerance.
 double getZSnapTolerance()
          Z snap tolerance.
 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 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 isReduceNetworkConflicts()
          Indicates if network conflicts should be reduced during reconcile.
 boolean isUseZsForConnectivity()
          Indicates if Z coordinates are used for connectivity.
 boolean isVersioned()
          Indicates if this dataset is versioned.
 void load(IStream pstm)
          load
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a DEGeometricNetwork.
 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 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 keyword)
          Configuration keyword.
 void setDatasetType(int type)
          Dataset type.
 void setDSID(int dSID)
          The id of the dataset.
 void setExtentByRef(IEnvelope extent)
          The extent of the coverage.
 void setFeatureClassNamesByRef(IStringArray featureClassNames)
          The feature classes involved in the geometric network.
 void setFullPropsRetrieved(boolean fullPropsRetrieved)
          Indicates if full properties have been retrieved.
 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 associated logical network.
 void setNetworkWeightsByRef(IArray netWeights)
          The weights of the geometric network.
 void setOrphanJunctionFeatureClassName(java.lang.String featureClass)
          The FeatureClass containing the OrphanJunctionFeatures.
 void setReduceNetworkConflicts(boolean reduceNetworkConflicts)
          Indicates if network conflicts should be reduced during reconcile.
 void setRulesByRef(IArray rules)
          The connectivity rules associated with the network.
 void setSpatialReferenceByRef(ISpatialReference spatialReference)
          The spatial reference of the geodataset.
 void setType(java.lang.String type)
          The type of the element.
 void setUseZsForConnectivity(boolean useZsForConnectivity)
          Indicates if Z coordinates are used for connectivity.
 void setVersioned(boolean versioned)
          Indicates if this dataset is versioned.
 void setWeightAssociationsByRef(IArray weightAssociations)
          The weight associations of the geometric network.
 void setXYSnapTolerance(double xYSnapTolerance)
          XY snap tolerance.
 void setZSnapTolerance(double zSnapTolerance)
          Z snap tolerance.
 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

DEGeometricNetwork

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

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

DEGeometricNetwork

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

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

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

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

setUseZsForConnectivity

public void setUseZsForConnectivity(boolean useZsForConnectivity)
                             throws java.io.IOException,
                                    AutomationException
Indicates if Z coordinates are used for connectivity.

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

isUseZsForConnectivity

public boolean isUseZsForConnectivity()
                               throws java.io.IOException,
                                      AutomationException
Indicates if Z coordinates are used for connectivity.

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

setXYSnapTolerance

public void setXYSnapTolerance(double xYSnapTolerance)
                        throws java.io.IOException,
                               AutomationException
XY snap tolerance.

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

getXYSnapTolerance

public double getXYSnapTolerance()
                          throws java.io.IOException,
                                 AutomationException
XY snap tolerance.

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

setZSnapTolerance

public void setZSnapTolerance(double zSnapTolerance)
                       throws java.io.IOException,
                              AutomationException
Z snap tolerance.

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

getZSnapTolerance

public double getZSnapTolerance()
                         throws java.io.IOException,
                                AutomationException
Z snap tolerance.

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

setReduceNetworkConflicts

public void setReduceNetworkConflicts(boolean reduceNetworkConflicts)
                               throws java.io.IOException,
                                      AutomationException
Indicates if network conflicts should be reduced during reconcile.

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

isReduceNetworkConflicts

public boolean isReduceNetworkConflicts()
                                 throws java.io.IOException,
                                        AutomationException
Indicates if network conflicts should be reduced during reconcile.

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

getRules

public IArray getRules()
                throws java.io.IOException,
                       AutomationException
The connectivity rules associated with the network.

Specified by:
getRules in interface IDEGeometricNetwork
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.

setRulesByRef

public void setRulesByRef(IArray rules)
                   throws java.io.IOException,
                          AutomationException
The connectivity rules associated with the network.

Specified by:
setRulesByRef in interface IDEGeometricNetwork
Parameters:
rules - 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.

getNetworkType

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

Specified by:
getNetworkType in interface IDEGeometricNetwork
Returns:
A com.esri.arcgis.geodatabase.esriNetworkType 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 associated logical network.

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

getOrphanJunctionFeatureClassName

public java.lang.String getOrphanJunctionFeatureClassName()
                                                   throws java.io.IOException,
                                                          AutomationException
The FeatureClass containing the OrphanJunctionFeatures.

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

setOrphanJunctionFeatureClassName

public void setOrphanJunctionFeatureClassName(java.lang.String featureClass)
                                       throws java.io.IOException,
                                              AutomationException
The FeatureClass containing the OrphanJunctionFeatures.

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

getFeatureClassNames

public IStringArray getFeatureClassNames()
                                  throws java.io.IOException,
                                         AutomationException
The feature classes involved in the geometric network.

Specified by:
getFeatureClassNames in interface IDEGeometricNetwork
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.

setFeatureClassNamesByRef

public void setFeatureClassNamesByRef(IStringArray featureClassNames)
                               throws java.io.IOException,
                                      AutomationException
The feature classes involved in the geometric network.

Specified by:
setFeatureClassNamesByRef in interface IDEGeometricNetwork
Parameters:
featureClassNames - 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.

getNetworkWeights

public IArray getNetworkWeights()
                         throws java.io.IOException,
                                AutomationException
The weights of the geometric network.

Specified by:
getNetworkWeights in interface IDEGeometricNetwork
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.

setNetworkWeightsByRef

public void setNetworkWeightsByRef(IArray netWeights)
                            throws java.io.IOException,
                                   AutomationException
The weights of the geometric network.

Specified by:
setNetworkWeightsByRef in interface IDEGeometricNetwork
Parameters:
netWeights - 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.

getWeightAssociations

public IArray getWeightAssociations()
                             throws java.io.IOException,
                                    AutomationException
The weight associations of the geometric network.

Specified by:
getWeightAssociations in interface IDEGeometricNetwork
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.

setWeightAssociationsByRef

public void setWeightAssociationsByRef(IArray weightAssociations)
                                throws java.io.IOException,
                                       AutomationException
The weight associations of the geometric network.

Specified by:
setWeightAssociationsByRef in interface IDEGeometricNetwork
Parameters:
weightAssociations - 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.

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.

getConfigurationKeyword

public java.lang.String getConfigurationKeyword()
                                         throws java.io.IOException,
                                                AutomationException
Configuration keyword.

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

setConfigurationKeyword

public void setConfigurationKeyword(java.lang.String keyword)
                             throws java.io.IOException,
                                    AutomationException
Configuration keyword.

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

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.

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.

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.

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.

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