com.esri.arcgis.geodatabase
Interface IDataElement

All Superinterfaces:

Serializable

All Known Implementing Classes:

DEAddressLocator, DEArcInfoTable, DECadastralFabric, DECadDrawingDataset, DECatalogRoot, DECoverage, DECoverageFeatureClass, DEDbaseTable, DEDiskConnection, DEFeatureClass, DEFeatureDataset, DEFile, DEFolder, DEGeoDataServer, DEGeometricNetwork, DEGlobeServer, DEGPServer, DEImageServer, DELayer, DEMapDocument, DEMapServer, DEMosaicDataset, DENetworkDataset, DEPrjFile, DERasterBand, DERasterCatalog, DERasterDataset, DERelationshipClass, DERemoteDatabaseFolder, DERepresentationClass, DESchematicDataset, DESchematicDiagram, DESchematicFolder, DEShapeFile, DESpatialReferencesFolder, DETable, DETerrain, DETextFile, DETin, DETool, DEToolbox, DETopology, DEVPFCoverage, DEVPFTable, DEWCSCoverage, DEWorkspace

public interface IDataElement
extends Serializable

Provides access to the Basic Data Element.

Product Availability

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

Method Summary

String	getBaseName() File base name.
String	getCatalogPath() The string used to retrieve the element.
IArray	getChildren() The list of sub-elements.
String	getExtension() File extension.
String	getFile() File name.
String	getName() The user assigned name for the element.
String	getPath() File path.
String	IDataElement_getType() The type of the element.
boolean	isChildrenExpanded() Indicates if the children have been expanded.
boolean	isFullPropsRetrieved() Indicates if full properties have been retrieved.
boolean	isMetadataRetrieved() Indicates if the metadata has been retrieved.
void	setCatalogPath(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	setFullPropsRetrieved(boolean fullPropsRetrieved) Indicates if full properties have been retrieved.
void	setMetadataRetrieved(boolean metadataRetrieved) Indicates if the metadata has been retrieved.
void	setName(String name) The user assigned name for the element.
void	setType(String type) The type of the element.

Method Detail

IDataElement_getType

String IDataElement_getType()
                            throws IOException,
                                   AutomationException

The type of the element.

Product Availability

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

Returns:

The type

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

void setType(String type)
             throws IOException,
                    AutomationException

The type of the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

type - The type (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

The user assigned name for the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

The user assigned name for the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCatalogPath

String getCatalogPath()
                      throws IOException,
                             AutomationException

The string used to retrieve the element.

Remarks

The CatalogPath of a data element contains the path to the dataset. If retrieved from GxObject, the data element's catalog path will correspond to the path displayed by ArcCatalog when the dataset is selected in the view pane. If retrieved from the workspace, the catalog path will be built by following this pattern:

/V=[version]/DatasetKeyword=datasetName/ChildDatasetKeyword=datasetName

The version can be empty if the source is a local geodatabase. The following table shows the dataset types and their respective keywords:

Dataset Type	Keyword
Feature dataset	FD
Feature class	FC
Object class	OC
Relationship class	RC
Geometric network	GN
Topology	TOPO
Raster band	RB
Raster dataset	RD
Raster catalog	RCAT
Toolbox	TB

The following are sample catalog paths:

/FD=USA/FC=Capitals

/V=SDE.DEFAULT/FD=Landbase/FC=Parcels

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCatalogPath

void setCatalogPath(String path)
                    throws IOException,
                           AutomationException

The string used to retrieve the element.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

IArray getChildren()
                   throws IOException,
                          AutomationException

The list of sub-elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChildrenByRef

void setChildrenByRef(IArray dataElements)
                      throws IOException,
                             AutomationException

The list of sub-elements.

Product Availability

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

Parameters:

dataElements - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isChildrenExpanded

boolean isChildrenExpanded()
                           throws IOException,
                                  AutomationException

Indicates if the children have been expanded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The childrenExpanded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChildrenExpanded

void setChildrenExpanded(boolean childrenExpanded)
                         throws IOException,
                                AutomationException

Indicates if the children have been expanded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

childrenExpanded - The childrenExpanded (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMetadataRetrieved

boolean isMetadataRetrieved()
                            throws IOException,
                                   AutomationException

Indicates if the metadata has been retrieved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The metadataRetrieved

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMetadataRetrieved

void setMetadataRetrieved(boolean metadataRetrieved)
                          throws IOException,
                                 AutomationException

Indicates if the metadata has been retrieved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

metadataRetrieved - The metadataRetrieved (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFullPropsRetrieved

boolean isFullPropsRetrieved()
                             throws IOException,
                                    AutomationException

Indicates if full properties have been retrieved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The fullPropsRetrieved

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFullPropsRetrieved

void setFullPropsRetrieved(boolean fullPropsRetrieved)
                           throws IOException,
                                  AutomationException

Indicates if full properties have been retrieved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fullPropsRetrieved - The fullPropsRetrieved (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPath

String getPath()
               throws IOException,
                      AutomationException

File path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFile

String getFile()
               throws IOException,
                      AutomationException

File name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The file

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseName

String getBaseName()
                   throws IOException,
                          AutomationException

File base name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The baseName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtension

String getExtension()
                    throws IOException,
                           AutomationException

File extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The extension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.