com.esri.arcgis.geodatabase

Class UtilityNetworkName

java.lang.Object

com.esri.arcgis.geodatabase.UtilityNetworkName

All Implemented Interfaces:

IDatasetName, IDatasetName2, IMetadata, IMetadataEdit, INativeTypeInfo, IUtilityNetworkName, com.esri.arcgis.interop.RemoteObjRef, IName, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class UtilityNetworkName
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IUtilityNetworkName, IName, IDatasetName, IDatasetName2, IPersist, IPersistStream, IMetadata, IMetadataEdit, INativeTypeInfo, java.io.Externalizable

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

Description 'A container for describing this utility network's name properties.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.geodatabase.IUtilityNetworkName

IID, IIDc2b01acf_df6d_4f61_8437_5fb07a0a02a9, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetName2

IID, IID033d515e_0f94_4c23_8eb8_daff16b1f17b, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IDatasetName

IID89e75917_c287_11d1_aa77_00c04fa33a15

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

Fields inherited from interface com.esri.arcgis.geodatabase.IMetadata

IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IMetadataEdit

IID, IID97fdb978_62a4_49c5_8252_b07837b33ee9, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.INativeTypeInfo

IID, IID906db24a_f0ad_4ca5_871b_5466e54fab80, xxDummy

Constructor Summary

Constructors

Constructor and Description
UtilityNetworkName() Constructs a UtilityNetworkName using ArcGIS Engine.
UtilityNetworkName(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. UtilityNetworkName theUtilityNetworkName = (UtilityNetworkName) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getCategory() The category of the dataset.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IEnumDatasetName	getControllerNames(int datasetType) The names of the dataset of the specified type.
IDatasetName	getFeatureDatasetName() Returns the name of feature dataset containing the utility network.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
IPropertySet	getMetadata() The PropertySet containing metadata.
java.lang.String	getName() The name of the dataset.
java.lang.String	getNameString() The name string of the object.
INativeType	getNativeType() The native type.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IEnumDatasetName	getSubsetNames() Subset names contained within this dataset name.
int	getType() The type of the dataset.
IWorkspaceName	getWorkspaceName() The WorkspaceName of the DatasetName.
int	hashCode() the hashcode for this object
boolean	isCanEditMetadata() Indicates if metadata can be edited.
void	isDirty() isDirty
void	load(IStream pstm) load
java.lang.Object	open() Opens the object referred to by this name.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	setCategory(java.lang.String category) The category of the dataset.
void	setControllerNameByRef(IDatasetName rhs1) Add a DatasetName.
void	setFeatureDatasetNameByRef(IDatasetName name) Returns the name of feature dataset containing the utility network.
void	setMetadata(IPropertySet propertySet) The PropertySet containing metadata.
void	setName(java.lang.String name) The name of the dataset.
void	setNameString(java.lang.String nameString) The name string of the object.
void	setWorkspaceNameByRef(IWorkspaceName workspaceName) The WorkspaceName of the DatasetName.
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

UtilityNetworkName

public UtilityNetworkName()
                   throws java.io.IOException,
                          java.net.UnknownHostException

Constructs a UtilityNetworkName using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

UtilityNetworkName

public UtilityNetworkName(java.lang.Object obj)
                   throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

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

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

getFeatureDatasetName

public IDatasetName getFeatureDatasetName()
                                   throws java.io.IOException,
                                          AutomationException

Returns the name of feature dataset containing the utility network.

Specified by:

getFeatureDatasetName in interface IUtilityNetworkName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureDatasetNameByRef

public void setFeatureDatasetNameByRef(IDatasetName name)
                                throws java.io.IOException,
                                       AutomationException

Returns the name of feature dataset containing the utility network.

Specified by:

setFeatureDatasetNameByRef in interface IUtilityNetworkName

Parameters:

name - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNameString

public void setNameString(java.lang.String nameString)
                   throws java.io.IOException,
                          AutomationException

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNameString in interface IName

Parameters:

nameString - The nameString (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNameString

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

The name string of the object.

Remarks

The NameString property is reserved for future use. When implemented, it will return a string representation of the locational component of the name object that may be persisted by applications.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNameString in interface IName

Returns:

The nameString

Throws:

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

AutomationException - If the ArcObject component throws an exception.

open

public java.lang.Object open()
                      throws java.io.IOException,
                             AutomationException

Opens the object referred to by this name.

Remarks

The Open method lets you instantiate the actual object given the name object.

Note: Opening a feature class that participates in a topology or geometric network will also open all other feature classes participating in the topology or geometric network in memory.

Example:

IName   pName = pFeatureClassName; 
pFeatureClass = new IFeatureClassProxy(pName.open());

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IName

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the dataset.

Specified by:

getName in interface IDatasetName

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 name of the dataset.

Specified by:

setName in interface IDatasetName

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

The type of the dataset.

Specified by:

getType in interface IDatasetName

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.

getCategory

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

The category of the dataset.

Specified by:

getCategory in interface IDatasetName

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(java.lang.String category)
                 throws java.io.IOException,
                        AutomationException

The category of the dataset.

Specified by:

setCategory in interface IDatasetName

Parameters:

category - The category (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName()
                                throws java.io.IOException,
                                       AutomationException

The WorkspaceName of the DatasetName.

Specified by:

getWorkspaceName in interface IDatasetName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWorkspaceNameByRef

public void setWorkspaceNameByRef(IWorkspaceName workspaceName)
                           throws java.io.IOException,
                                  AutomationException

The WorkspaceName of the DatasetName.

Specified by:

setWorkspaceNameByRef in interface IDatasetName

Parameters:

workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubsetNames

public IEnumDatasetName getSubsetNames()
                                throws java.io.IOException,
                                       AutomationException

Subset names contained within this dataset name.

Specified by:

getSubsetNames in interface IDatasetName

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getControllerNames

public IEnumDatasetName getControllerNames(int datasetType)
                                    throws java.io.IOException,
                                           AutomationException

The names of the dataset of the specified type.

Specified by:

getControllerNames in interface IDatasetName2

Parameters:

datasetType - A com.esri.arcgis.geodatabase.esriDatasetType constant (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setControllerNameByRef

public void setControllerNameByRef(IDatasetName rhs1)
                            throws java.io.IOException,
                                   AutomationException

Add a DatasetName.

Specified by:

setControllerNameByRef in interface IDatasetName2

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)

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.

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.

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.

isCanEditMetadata

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

Indicates if metadata can be edited.

Specified by:

isCanEditMetadata in interface IMetadataEdit

Returns:

The canEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNativeType

public INativeType getNativeType()
                          throws java.io.IOException,
                                 AutomationException

The native type.

Specified by:

getNativeType in interface INativeTypeInfo

Returns:

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

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