com.esri.arcgis.datasourcesfile
Class DECoverageFeatureClass

java.lang.Object
  com.esri.arcgis.datasourcesfile.DECoverageFeatureClass

All Implemented Interfaces:

IDEArcInfoTable, IDECoverageFeatureClass, IDataElement, IDEDataset, IDEFeatureClass, IDEGeoDataset, IDETable, IGPDescribe, IGPValue, IMetadata, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class DECoverageFeatureClass
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDECoverageFeatureClass, IDEFeatureClass, IDETable, IDEArcInfoTable, IDEGeoDataset, IDEDataset, IDataElement, IMetadata, IGPValue, IXMLSerialize, IClone, IPersistStream, IGPDescribe, Externalizable

Coverage Feature Class Data Element object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

DECoverageFeatureClass()
Constructs a DECoverageFeatureClass using ArcGIS Engine.

DECoverageFeatureClass(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DECoverageFeatureClass theDECoverageFeatureClass = (DECoverageFeatureClass) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
Object	describe(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(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
String	getAsText() Provides the value of the value object.
String	getBaseName() File base name.
String	getCatalogPath() The string used to retrieve the element.
IArray	getChildren() The list of sub-elements.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
int	getDatasetType() Dataset type.
int	getDSID() The id of the dataset.
String	getExtension() File extension.
IEnvelope	getExtent() The extent of the coverage.
int	getFeatureClassType() The coverage feature class type.
int	getFeatureType() The feature type of the feature class.
IFields	getFields() The list of Fields.
String	getFile() File name.
IIndexes	getIndexes() The list of Indexes.
IArray	getItemSet() The list of items.
IPropertySet	getMetadata() The PropertySet containing metadata.
String	getName() The user assigned name for the element.
String	getOIDFieldName() The name of the OID Field.
String	getPath() File path.
String	getShapeFieldName() The shape field name of the feature class.
int	getShapeType() The geometry type of the feature class.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISpatialReference	getSpatialReference() The spatial reference of the geodataset.
int	getTopology() Coverage feature class topology status.
int	hashCode() the hashcode for this object
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	isHasFAT() Indicates if the coverage feature class have attributes.
boolean	isHasM() Indicates if the feature class supports Ms.
boolean	isHasOID() Indicates if the table has an object id field.
boolean	isHasSpatialIndex() Indicates if the feature class has a spatial index.
boolean	isHasZ() Indicates if the feature class supports Zs.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isMetadataRetrieved() Indicates if the metadata has been retrieved.
boolean	isVersioned() Indicates if this dataset is versioned.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
IGPMessage	setAsText(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(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	setDatasetType(int type) Dataset type.
void	setDSID(int dSID) The id of the dataset.
void	setExtentByRef(IEnvelope extent) The extent of the coverage.
void	setFeatureClassType(int featureClassType) The coverage feature class type.
void	setFeatureType(int featureType) The feature type of the feature class.
void	setFieldsByRef(IFields fields) The list of Fields.
void	setFullPropsRetrieved(boolean fullPropsRetrieved) Indicates if full properties have been retrieved.
void	setHasFAT(boolean hasFAT) Indicates if the coverage feature class have attributes.
void	setHasM(boolean hasM) Indicates if the feature class supports Ms.
void	setHasOID(boolean hasOID) Indicates if the table has an object id field.
void	setHasSpatialIndex(boolean hasSpatialIndex) Indicates if the feature class has a spatial index.
void	setHasZ(boolean hasZ) Indicates if the feature class supports Zs.
void	setIndexesByRef(IIndexes indexes) The list of Indexes.
void	setItemSetByRef(IArray ppItems) The list of items.
void	setMetadata(IPropertySet ppPropertySet) The PropertySet containing metadata.
void	setMetadataRetrieved(boolean metadataRetrieved) Indicates if the metadata has been retrieved.
void	setName(String name) The user assigned name for the element.
void	setOIDFieldName(String oIDFieldName) The name of the OID Field.
void	setShapeFieldName(String shapeFieldName) The shape field name of the feature class.
void	setShapeType(int geometryType) The geometry type of the feature class.
void	setSpatialReferenceByRef(ISpatialReference spatialReference) The spatial reference of the geodataset.
void	setTopology(int pTopology) Coverage feature class topology status.
void	setType(String type) The type of the element.
void	setVersioned(boolean versioned) Indicates if this dataset is versioned.
void	synchronize(int action, int interval) Updates metadata with the current properties; may create metadata if it doesn't already exist.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

DECoverageFeatureClass

public DECoverageFeatureClass()
                       throws IOException,
                              UnknownHostException

Constructs a DECoverageFeatureClass using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DECoverageFeatureClass

public DECoverageFeatureClass(Object obj)
                       throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getFeatureClassType

public int getFeatureClassType()
                        throws IOException,
                               AutomationException

The coverage feature class type.

Product Availability

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

Specified by:

getFeatureClassType in interface IDECoverageFeatureClass

Returns:

A com.esri.arcgis.datasourcesfile.esriCoverageFeatureClassType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureClassType

public void setFeatureClassType(int featureClassType)
                         throws IOException,
                                AutomationException

The coverage feature class type.

Product Availability

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

Specified by:

setFeatureClassType in interface IDECoverageFeatureClass

Parameters:

featureClassType - A com.esri.arcgis.datasourcesfile.esriCoverageFeatureClassType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasFAT

public boolean isHasFAT()
                 throws IOException,
                        AutomationException

Indicates if the coverage feature class have attributes.

Product Availability

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

Specified by:

isHasFAT in interface IDECoverageFeatureClass

Returns:

The hasFAT

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasFAT

public void setHasFAT(boolean hasFAT)
               throws IOException,
                      AutomationException

Indicates if the coverage feature class have attributes.

Product Availability

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

Specified by:

setHasFAT in interface IDECoverageFeatureClass

Parameters:

hasFAT - The hasFAT (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTopology

public int getTopology()
                throws IOException,
                       AutomationException

Coverage feature class topology status.

Product Availability

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

Specified by:

getTopology in interface IDECoverageFeatureClass

Returns:

A com.esri.arcgis.datasourcesfile.esriFeatureClassTopology constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTopology

public void setTopology(int pTopology)
                 throws IOException,
                        AutomationException

Coverage feature class topology status.

Product Availability

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

Specified by:

setTopology in interface IDECoverageFeatureClass

Parameters:

pTopology - A com.esri.arcgis.datasourcesfile.esriFeatureClassTopology constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShapeType

public int getShapeType()
                 throws IOException,
                        AutomationException

The geometry type of the feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getShapeType in interface IDEFeatureClass

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShapeType

public void setShapeType(int geometryType)
                  throws IOException,
                         AutomationException

The geometry type of the feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShapeType in interface IDEFeatureClass

Parameters:

geometryType - A com.esri.arcgis.geometry.esriGeometryType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureType

public int getFeatureType()
                   throws IOException,
                          AutomationException

The feature type of the feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFeatureType in interface IDEFeatureClass

Returns:

A com.esri.arcgis.geodatabase.esriFeatureType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureType

public void setFeatureType(int featureType)
                    throws IOException,
                           AutomationException

The feature type of the feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFeatureType in interface IDEFeatureClass

Parameters:

featureType - A com.esri.arcgis.geodatabase.esriFeatureType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShapeFieldName

public String getShapeFieldName()
                         throws IOException,
                                AutomationException

The shape field name of the feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getShapeFieldName in interface IDEFeatureClass

Returns:

The shapeFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShapeFieldName

public void setShapeFieldName(String shapeFieldName)
                       throws IOException,
                              AutomationException

The shape field name of the feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShapeFieldName in interface IDEFeatureClass

Parameters:

shapeFieldName - The shapeFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasSpatialIndex

public boolean isHasSpatialIndex()
                          throws IOException,
                                 AutomationException

Indicates if the feature class has a spatial index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isHasSpatialIndex in interface IDEFeatureClass

Returns:

The hasSpatialIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasSpatialIndex

public void setHasSpatialIndex(boolean hasSpatialIndex)
                        throws IOException,
                               AutomationException

Indicates if the feature class has a spatial index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHasSpatialIndex in interface IDEFeatureClass

Parameters:

hasSpatialIndex - The hasSpatialIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasZ

public boolean isHasZ()
               throws IOException,
                      AutomationException

Indicates if the feature class supports Zs.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isHasZ in interface IDEFeatureClass

Returns:

The hasZ

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasZ

public void setHasZ(boolean hasZ)
             throws IOException,
                    AutomationException

Indicates if the feature class supports Zs.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHasZ in interface IDEFeatureClass

Parameters:

hasZ - The hasZ (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasM

public boolean isHasM()
               throws IOException,
                      AutomationException

Indicates if the feature class supports Ms.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isHasM in interface IDEFeatureClass

Returns:

The hasM

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasM

public void setHasM(boolean hasM)
             throws IOException,
                    AutomationException

Indicates if the feature class supports Ms.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHasM in interface IDEFeatureClass

Parameters:

hasM - The hasM (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasOID

public boolean isHasOID()
                 throws IOException,
                        AutomationException

Indicates if the table has an object id field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isHasOID in interface IDETable

Returns:

The hasOID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHasOID

public void setHasOID(boolean hasOID)
               throws IOException,
                      AutomationException

Indicates if the table has an object id field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHasOID in interface IDETable

Parameters:

hasOID - The hasOID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

public String getOIDFieldName()
                       throws IOException,
                              AutomationException

The name of the OID Field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOIDFieldName in interface IDETable

Returns:

The oIDFieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOIDFieldName

public void setOIDFieldName(String oIDFieldName)
                     throws IOException,
                            AutomationException

The name of the OID Field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setOIDFieldName in interface IDETable

Parameters:

oIDFieldName - The oIDFieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIndexes

public IIndexes getIndexes()
                    throws IOException,
                           AutomationException

The list of Indexes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getIndexes in interface IDETable

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIndexesByRef

public void setIndexesByRef(IIndexes indexes)
                     throws IOException,
                            AutomationException

The list of Indexes.

Product Availability

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

Specified by:

setIndexesByRef in interface IDETable

Parameters:

indexes - A reference to a com.esri.arcgis.geodatabase.IIndexes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws IOException,
                         AutomationException

The list of Fields.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFields in interface IDETable

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldsByRef

public void setFieldsByRef(IFields fields)
                    throws IOException,
                           AutomationException

The list of Fields.

Product Availability

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

Specified by:

setFieldsByRef in interface IDETable

Parameters:

fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItemSet

public IArray getItemSet()
                  throws IOException,
                         AutomationException

The list of items.

Product Availability

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

Specified by:

getItemSet in interface IDEArcInfoTable

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.

setItemSetByRef

public void setItemSetByRef(IArray ppItems)
                     throws IOException,
                            AutomationException

The list of items.

Product Availability

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

Specified by:

setItemSetByRef in interface IDEArcInfoTable

Parameters:

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

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException

The extent of the coverage.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtent in interface IDEGeoDataset

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtentByRef

public void setExtentByRef(IEnvelope extent)
                    throws IOException,
                           AutomationException

The extent of the coverage.

Product Availability

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

Specified by:

setExtentByRef in interface IDEGeoDataset

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the geodataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSpatialReference in interface IDEGeoDataset

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialReference)
                              throws IOException,
                                     AutomationException

The spatial reference of the geodataset.

Product Availability

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

Specified by:

setSpatialReferenceByRef in interface IDEGeoDataset

Parameters:

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatasetType

public int getDatasetType()
                   throws IOException,
                          AutomationException

Dataset type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDatasetType in interface IDEDataset

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDatasetType

public void setDatasetType(int type)
                    throws IOException,
                           AutomationException

Dataset type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDatasetType in interface IDEDataset

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVersioned

public boolean isVersioned()
                    throws IOException,
                           AutomationException

Indicates if this dataset is versioned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVersioned in interface IDEDataset

Returns:

The versioned

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVersioned

public void setVersioned(boolean versioned)
                  throws IOException,
                         AutomationException

Indicates if this dataset is versioned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVersioned in interface IDEDataset

Parameters:

versioned - The versioned (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDSID

public int getDSID()
            throws IOException,
                   AutomationException

The id of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDSID in interface IDEDataset

Returns:

The dSID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDSID

public void setDSID(int dSID)
             throws IOException,
                    AutomationException

The id of the dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDSID in interface IDEDataset

Parameters:

dSID - The dSID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanVersion

public boolean isCanVersion()
                     throws IOException,
                            AutomationException

Indicates if this dataset can be versioned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCanVersion in interface IDEDataset

Returns:

The canVersion

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCanVersion

public void setCanVersion(boolean canVersion)
                   throws IOException,
                          AutomationException

Indicates if this dataset can be versioned.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCanVersion in interface IDEDataset

Parameters:

canVersion - The canVersion (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IDataElement_getType

public String IDataElement_getType()
                            throws IOException,
                                   AutomationException

The type of the element.

Product Availability

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

Specified by:

IDataElement_getType in interface IDataElement

Returns:

The type

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setType

public 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

Specified by:

setType in interface IDataElement

Parameters:

type - The type (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public 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

Specified by:

getName in interface IDataElement

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public 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

Specified by:

setName in interface IDataElement

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCatalogPath

public 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

Specified by:

getCatalogPath in interface IDataElement

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCatalogPath

public 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

Specified by:

setCatalogPath in interface IDataElement

Parameters:

path - The path (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

public 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

Specified by:

getChildren in interface IDataElement

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

public void setChildrenByRef(IArray dataElements)
                      throws IOException,
                             AutomationException

The list of sub-elements.

Product Availability

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

Specified by:

setChildrenByRef in interface IDataElement

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

public 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

Specified by:

isChildrenExpanded in interface IDataElement

Returns:

The childrenExpanded

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setChildrenExpanded

public 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

Specified by:

setChildrenExpanded in interface IDataElement

Parameters:

childrenExpanded - The childrenExpanded (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMetadataRetrieved

public 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

Specified by:

isMetadataRetrieved in interface IDataElement

Returns:

The metadataRetrieved

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMetadataRetrieved

public 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

Specified by:

setMetadataRetrieved in interface IDataElement

Parameters:

metadataRetrieved - The metadataRetrieved (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFullPropsRetrieved

public 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

Specified by:

isFullPropsRetrieved in interface IDataElement

Returns:

The fullPropsRetrieved

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFullPropsRetrieved

public 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

Specified by:

setFullPropsRetrieved in interface IDataElement

Parameters:

fullPropsRetrieved - The fullPropsRetrieved (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPath

public String getPath()
               throws IOException,
                      AutomationException

File path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPath in interface IDataElement

Returns:

The path

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFile

public String getFile()
               throws IOException,
                      AutomationException

File name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFile in interface IDataElement

Returns:

The file

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBaseName

public String getBaseName()
                   throws IOException,
                          AutomationException

File base name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBaseName in interface IDataElement

Returns:

The baseName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtension

public String getExtension()
                    throws IOException,
                           AutomationException

File extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtension in interface IDataElement

Returns:

The extension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMetadata

public IPropertySet getMetadata()
                         throws IOException,
                                AutomationException

The PropertySet containing metadata.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMetadata in interface IMetadata

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet ppPropertySet)
                 throws IOException,
                        AutomationException

The PropertySet containing metadata.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMetadata in interface IMetadata

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

synchronize

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

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

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.

Remarks

The following actions will result in synchronization given each of the listed conditions:

Action	Metadata status	Esri/Sync element	Interval parameter
esriMSAAccessed	Doesn't matter	Must not be FALSE	Must be less than actual interval
esriMSAAlways	Doesn't matter	Doesn't matter	Doesn't matter
esriMSACreated	Must not exist	Must not be FALSE	Must be less than actual interval
esriMSANotCreated	Must exist	Must not be FALSE	Must be less than actual interval
esriMSAOverwrite	Doesn't matter	Doesn't matter	Doesn't matter

The difference between esriMSAAlways and esriMSAOverwrite lies in which elements are synchronized. esriMSAAlways will honor the removal or value change of an element's Sync attribute (to disable synchronization), whereas using esriMSAOverwrite is equivalent to setting the IXmlPropertySet2.OverwriteSyncAttribute to true for the metadata's property set, meaning that even elements without a Sync attribute of TRUE will be synchronized.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

synchronize in interface IMetadata

Parameters:

action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws IOException,
                                        AutomationException

The data type of the value object.

Product Availability

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

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException

Indicates if the value object is empty.

Remarks

The IsEmpty method returns if this Value object has been set or not.

Product Availability

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

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException

Clears the value object.

Remarks

The Empty method clears this Value object and releases any associated objects.

Product Availability

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

Specified by:

empty in interface IGPValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAsText

public String getAsText()
                 throws IOException,
                        AutomationException

Provides the value of the value object.

Remarks

The GetAsText method returns this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string for the scalar value.

Product Availability

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

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(String text)
                     throws IOException,
                            AutomationException

Provides the value of the value object with the given string value.

Remarks

The SetAsText method sets the value of this Value object as a text string. For DataElement value objects it is the NameString. For simple value objects it is the text string representing the scalar value.

Product Availability

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

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

describe

public Object describe(String name)
                throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException