com.esri.arcgis.system
Interface IName

All Superinterfaces:

Serializable

All Known Implementing Classes:

AGSServerConnectionName, AGSServerObjectName, AMSDatasetName, CacheRasterDatasetName, CadastralFabricName, CadDrawingName, CoverageFeatureClassName, CoverageName, FeatureClassName, FeatureDatasetName, FeatureQueryName, FgdbFeatureClassName, FgdbTableName, FileName, FunctionRasterDatasetName, GeometricNetworkName, GPDataTypeName, GPFunctionName, GPMultiValueTypeName, GPSATopoFeaturesTypeName, GPToolboxName, GPToolName, IMSGlobeServiceDescription, IMSGlobeSubServiceDescription, IMSMetadataServiceName, IMSServiceName, INameProxy, LocatorName, LocatorWorkspaceName, MemoryRelationshipClassName, MosaicDatasetName, NetCDFFeatureClassName, NetCDFRasterDatasetName, NetCDFTableName, NetworkDatasetName, ObjectClassName, QueryTableName, RasterBandName, RasterCatalogName, RasterDatasetName, RasterTypeName, RelationshipClassName, RelQueryTableName, RepresentationClassName, RouteEventSourceName, RouteMeasureLocatorName, SchematicDatasetName, SchematicDiagramClassName, SchematicDiagramName, SchematicFolderName, SchematicWorkspaceName, SdeRasterTableName, ShortcutName, TableName, TableQueryName, TerrainName, TinName, TopologyName, WCSConnectionName, WMSConnectionName, WorkspaceName, XYEventSourceName

public interface IName
extends Serializable

Provides access to members that work with Name objects.

Remarks

A Name object is a persistable software object that identifies and locates a geodatabase object such as a dataset or a workspace or a map object such as a layer.

A Name object supports an Open method that allows the client to get an instance of the actual object (for example, the dataset or workspace) given the name object. A name object thus acts as a moniker that supports binding to the named object.

The geodatabase supports methods on workspaces that hand out name objects that can be used by browsing clients to display the names of datasets in the workspace and to instantiate any specific dataset.

Name objects may also carry properties that describe the object being named. A browsing client to display additional information about the object being named can use these properties. A Name object may also support methods to access metadata for or methods to change permissions on the actual object. In these cases, a name object can be used as a lightweight surrogate of the actual object until such time as further properties of the object are needed or additional methods on the object need to be called.

Name objects are cocreatable and can also be used to specify datasets that are yet to be created, for example the output dataset to be created by a geoprocessing operation. There are several kinds of name objects, for example workspace, table, feature class, feature dataset, raster and relationship class name objects.

Name objects may be persisted (serialized) using the IPersistStream interface. Name objects are the mechanism used to save references to the datasets corresponding to the layers in a map, when the map is saved as a map document.

When To Use

Use IName to open a workspace object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Method Summary

String	getNameString() The name string of the object.
Object	open() Opens the object referred to by this name.
void	setNameString(String nameString) The name string of the object.

Method Detail

setNameString

void setNameString(String nameString)
                   throws 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

Parameters:

nameString - The nameString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNameString

String getNameString()
                     throws 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

Returns:

The nameString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

Object open()
            throws 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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.