com.esri.arcgis.geodatabase
Class GeometricNetworkName

java.lang.Object
  com.esri.arcgis.geodatabase.GeometricNetworkName

All Implemented Interfaces:

IDatasetName, IGeometricNetworkName, IMetadata, IMetadataEdit, IName, INativeTypeInfo, IPersist, IPersistStream, java.io.Serializable

public class GeometricNetworkName

extends java.lang.Object

implements IName, IDatasetName, IGeometricNetworkName, IPersist, IPersistStream, IMetadata, IMetadataEdit, INativeTypeInfo

ESRI Geometric Network Name object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Remarks

A GeometricNetworkName object identifies and locates a geometric network in a workspace.

See Also:

Serialized Form

Constructor Summary

GeometricNetworkName()
Constructs a GeometricNetworkName using ArcGIS Engine.

GeometricNetworkName(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IDatasetName	getAsIDatasetName() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGeometricNetworkName	getAsIGeometricNetworkName() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IMetadata	getAsIMetadata() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IMetadataEdit	getAsIMetadataEdit() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IName	getAsIName() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
INativeTypeInfo	getAsINativeTypeInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersist	getAsIPersist() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
java.lang.String	getCategory() The category of the dataset.
void	getClassID(GUID[] pClassID) Supported Platforms
static java.lang.String	getClsid()
IDatasetName	getFeatureDatasetName() The Feature Dataset Name that the network belongs to.
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) Supported Platforms
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() Supported Platforms
void	load(IStream pstm) Supported Platforms
java.lang.Object	open() Opens the object referred to by this name.
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	setCategory(java.lang.String category) The category of the dataset.
void	setFeatureDatasetNameByRef(IDatasetName featureDatasetName) The Feature Dataset Name that the network belongs to.
void	setMetadata(IPropertySet ppPropertySet) 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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GeometricNetworkName

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

Constructs a GeometricNetworkName using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GeometricNetworkName

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Construct a GeometricNetworkName using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GeometricNetworkName.
GeometricNetworkName theGeometricNetworkName = (GeometricNetworkName) obj;

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()

getAsIName

public IName getAsIName()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIDatasetName

public IDatasetName getAsIDatasetName()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGeometricNetworkName

public IGeometricNetworkName getAsIGeometricNetworkName()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIMetadata

public IMetadata getAsIMetadata()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIMetadataEdit

public IMetadataEdit getAsIMetadataEdit()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsINativeTypeInfo

public INativeTypeInfo getAsINativeTypeInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

setNameString

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

Description copied from interface: IName

The name string of the object.

Supported Platforms

Windows, Solaris, Linux

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.

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

Description copied from interface: IName

The name string of the object.

Supported Platforms

Windows, Solaris, Linux

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.

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

Description copied from interface: IName

Opens the object referred to by this name.

Supported Platforms

Windows, Solaris, Linux

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.

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

Description copied from interface: IDatasetName

The name of the dataset.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IDatasetName

The name of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IDatasetName

Parameters:

name - The name (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getType

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

Description copied from interface: IDatasetName

The type of the dataset.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IDatasetName

The category of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getCategory in interface IDatasetName

Returns:

The category

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setCategory

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

Description copied from interface: IDatasetName

The category of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCategory in interface IDatasetName

Parameters:

category - The category (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getWorkspaceName

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

Description copied from interface: IDatasetName

The WorkspaceName of the DatasetName.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IDatasetName

The WorkspaceName of the DatasetName.

Specified by:

setWorkspaceNameByRef in interface IDatasetName

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getSubsetNames

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

Description copied from interface: IDatasetName

Subset names contained within this dataset name.

Supported Platforms

Windows, Solaris, Linux

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.

getFeatureDatasetName

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

Description copied from interface: IGeometricNetworkName

The Feature Dataset Name that the network belongs to.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureDatasetName in interface IGeometricNetworkName

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setFeatureDatasetNameByRef

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

Description copied from interface: IGeometricNetworkName

The Feature Dataset Name that the network belongs to.

Specified by:

setFeatureDatasetNameByRef in interface IGeometricNetworkName

Parameters:

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IMetadata

The PropertySet containing metadata.

Supported Platforms

Windows, Solaris, Linux

Remarks

The variable to hold the data must be of IPropertySet data type.

The metadata property is frequently used to save, or update, changes to metadata documents that have taken place through methods available on the IPropertySet, IXmlPropertySet, and/or IXmlPropertySet2 interfaces.

Specified by:

getMetadata in interface IMetadata

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMetadata

public void setMetadata(IPropertySet ppPropertySet)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IMetadata

The PropertySet containing metadata.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMetadata in interface IMetadata

Parameters:

ppPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

synchronize

public void synchronize(int action,
                        int interval)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IMetadata

Updates metadata with the current properties; may create metadata if it doesn't already exist.

Supported Platforms

Windows, Solaris, Linux

Description

The Synchronize method is used to extract metadata properties from an object and write those properties to the metadata .xml. Depending on the value of the esriMetaSyncAction, the Synchronize method may generate a new set of 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

Description copied from interface: IMetadataEdit

Indicates if metadata can be edited.

Supported Platforms

Windows, Solaris, Linux

Remarks

This property is available to those objects that support metadata.

Specified by:

isCanEditMetadata in interface IMetadataEdit

Returns:

The pCanEdit

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getNativeType

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

Description copied from interface: INativeTypeInfo

The native type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNativeType in interface INativeTypeInfo

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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