com.esri.arcgis.geodatabase
Class DETable

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

All Implemented Interfaces:

IDataElement, IDEDataset, IDEDataset2, IDEEditorTracking, IDEGdbTable, IDEGdbTable2, IDETable, IGPDescribe, IGPValue, IMetadata, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class DETable
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDETable, IDEGdbTable2, IDEEditorTracking, IDEDataset2, IDataElement, IMetadata, IGPValue, IXMLSerialize, IClone, IPersistStream, IGPDescribe, java.io.Externalizable

COM Class 'DETable'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'Table Data Element object.' 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

static long

serialVersionUID

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

IID, IID94bcae52_2f1c_416d_835b_b206da11f69b, xxDummy

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

IIDf35fe0cf_d9fc_4172_81f8_20ce5a553ab1

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

IIDd7fcbb04_8e59_4ffb_9ee5_ec670aa892e0

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

IID, IIDe80995a9_ff03_43e6_a4a7_dc263e681565, xxDummy

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

IID, IID90532b92_762b_4d10_b2a7_c42c852991ad, xxDummy

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

IID29fbed10_a332_11d5_931b_0080c71a3226

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

IID, IIDe2c87df0_33d9_4a47_9b67_fa54b2fd7966, xxDummy

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

IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, xxDummy

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

IID, IID92ee08b6_c757_4178_803c_67cd665ac801, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

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

Constructor Summary

DETable()
Constructs a DETable using ArcGIS Engine.

DETable(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DETable theDETable = (DETable) obj;

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
java.lang.Object	describe(java.lang.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(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
java.lang.String	getAliasName() The alias name for the table.
java.lang.String	getAsText() Provides the value of the value object.
java.lang.String	getBaseName() File base name.
java.lang.String	getCatalogPath() The string used to retrieve the element.
IArray	getChildren() The list of sub-elements.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getCLSID() The GUID for the COM Class (CoClass) corresponding to instances of the object class represented by the table data element.
java.lang.String	getConfigurationKeyword() Configuration keyword.
IArray	getControllerMemberships() The set of controller memberships for the table.
java.lang.String	getCreatedAtFieldName() The name of the creation time field.
java.lang.String	getCreatorFieldName() The name of the creator field.
int	getDatasetType() Dataset type.
int	getDefaultSubtypeCode() The default subtype code.
int	getDSID() The id of the dataset.
java.lang.String	getEditedAtFieldName() The name of the edit time field.
java.lang.String	getEditorFieldName() The name of the editor field.
java.lang.String	getEXTCLSID() The GUID for the COM Class (CoClass) corresponding to the class extension of the object class represented by the table data element.
java.lang.String	getExtension() File extension.
IPropertySet	getExtensionProperties() The properties for the class extension.
IFields	getFields() The list of Fields.
java.lang.String	getFile() File name.
java.lang.String	getGlobalIDFieldName() The name of the GlobalID Field.
IIndexes	getIndexes() The list of Indexes.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IPropertySet	getMetadata() The PropertySet containing metadata.
java.lang.String	getModelName() The model name for the table.
java.lang.String	getOIDFieldName() The name of the OID Field.
java.lang.String	getPath() File path.
java.lang.String	getRasterFieldName() The name of the raster field.
IStringArray	getRelationshipClassNames() The names of the Relationship Classes this object class participates in.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.String	getSubtypeFieldName() The name of the Subtype Field.
IArray	getSubtypes() The set of Subtypes.
java.lang.String	getVersionedViewName() The name of the associate versioned view, if any.
int	hashCode() the hashcode for this object
java.lang.String	IDataElement_getName() The user assigned name for the element.
java.lang.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	isEditorTrackingEnabled() The property to determine if Editor Tracking is enabled on this data element.
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	isHasGlobalID() Indicates if the table has a GlobalID field.
boolean	isHasOID() Indicates if the table has an object id field.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
boolean	isMetadataRetrieved() Indicates if the metadata has been retrieved.
boolean	isTimeInUTC() The property to determine Editor Tracking times are recorded in UTC.
boolean	isVersioned() Indicates if this dataset is versioned.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a DETable.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAliasName(java.lang.String aliasName) The alias name for the table.
IGPMessage	setAsText(java.lang.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(java.lang.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	setCLSID(java.lang.String classID) The GUID for the COM Class (CoClass) corresponding to instances of the object class represented by the table data element.
void	setConfigurationKeyword(java.lang.String keyword) Configuration keyword.
void	setControllerMembershipsByRef(IArray controllerMemberships) The set of controller memberships for the table.
void	setCreatedAtFieldName(java.lang.String createdAtFieldName) The name of the creation time field.
void	setCreatorFieldName(java.lang.String creatorFieldName) The name of the creator field.
void	setDatasetType(int type) Dataset type.
void	setDefaultSubtypeCode(int subtypeCode) The default subtype code.
void	setDSID(int dSID) The id of the dataset.
void	setEditedAtFieldName(java.lang.String editedAtFieldName) The name of the edit time field.
void	setEditorFieldName(java.lang.String editorFieldName) The name of the editor field.
void	setEditorTrackingEnabled(boolean isEditorTrackingEnabled) The property to determine if Editor Tracking is enabled on this data element.
void	setEXTCLSID(java.lang.String classID) The GUID for the COM Class (CoClass) corresponding to the class extension of the object class represented by the table data element.
void	setExtensionPropertiesByRef(IPropertySet propertySet) The properties for the class extension.
void	setFieldsByRef(IFields fields) The list of Fields.
void	setFullPropsRetrieved(boolean fullPropsRetrieved) Indicates if full properties have been retrieved.
void	setGlobalIDFieldName(java.lang.String globalIDFieldName) The name of the GlobalID Field.
void	setHasGlobalID(boolean hasGlobalID) Indicates if the table has a GlobalID field.
void	setHasOID(boolean hasOID) Indicates if the table has an object id field.
void	setIndexesByRef(IIndexes indexes) The list of Indexes.
void	setIsTimeInUTC(boolean isTimeInUTC) The property to determine Editor Tracking times are recorded in UTC.
void	setMetadata(IPropertySet propertySet) The PropertySet containing metadata.
void	setMetadataRetrieved(boolean metadataRetrieved) Indicates if the metadata has been retrieved.
void	setModelName(java.lang.String modelName) The model name for the table.
void	setName(java.lang.String name) The user assigned name for the element.
void	setOIDFieldName(java.lang.String oIDFieldName) The name of the OID Field.
void	setRasterFieldName(java.lang.String fieldName) The name of the raster field.
void	setRelationshipClassNamesByRef(IStringArray relationshipClassNames) The names of the Relationship Classes this object class participates in.
void	setSubtypeFieldName(java.lang.String fieldName) The name of the Subtype Field.
void	setSubtypesByRef(IArray subtypes) The set of Subtypes.
void	setType(java.lang.String type) The type of the element.
void	setVersioned(boolean versioned) Indicates if this dataset is versioned.
void	setVersionedViewName(java.lang.String versionedViewName) The name of the associate versioned view, if any.
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

DETable

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

Constructs a DETable using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DETable

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

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

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

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

Deprecated. Internal use only.

Specified by:

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

release

public void release()

Release a DETable.

Specified by:

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

isHasOID

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

Indicates if the table has an object id field.

Specified by:

isHasOID in interface IDETable

Returns:

The hasOID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHasOID

public void setHasOID(boolean hasOID)
               throws java.io.IOException,
                      AutomationException

Indicates if the table has an object id field.

Specified by:

setHasOID in interface IDETable

Parameters:

hasOID - The hasOID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

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

The name of the OID Field.

Specified by:

getOIDFieldName in interface IDETable

Returns:

The oIDFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOIDFieldName

public void setOIDFieldName(java.lang.String oIDFieldName)
                     throws java.io.IOException,
                            AutomationException

The name of the OID Field.

Specified by:

setOIDFieldName in interface IDETable

Parameters:

oIDFieldName - The oIDFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIndexes

public IIndexes getIndexes()
                    throws java.io.IOException,
                           AutomationException

The list of Indexes.

Specified by:

getIndexes in interface IDETable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIndexesByRef

public void setIndexesByRef(IIndexes indexes)
                     throws java.io.IOException,
                            AutomationException

The list of Indexes.

Specified by:

setIndexesByRef in interface IDETable

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields()
                  throws java.io.IOException,
                         AutomationException

The list of Fields.

Specified by:

getFields in interface IDETable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFieldsByRef

public void setFieldsByRef(IFields fields)
                    throws java.io.IOException,
                           AutomationException

The list of Fields.

Specified by:

setFieldsByRef in interface IDETable

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVersionedViewName

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

The name of the associate versioned view, if any.

Specified by:

getVersionedViewName in interface IDEGdbTable2

Returns:

The versionedViewName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVersionedViewName

public void setVersionedViewName(java.lang.String versionedViewName)
                          throws java.io.IOException,
                                 AutomationException

The name of the associate versioned view, if any.

Specified by:

setVersionedViewName in interface IDEGdbTable2

Parameters:

versionedViewName - The versionedViewName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCLSID

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

The GUID for the COM Class (CoClass) corresponding to instances of the object class represented by the table data element.

Specified by:

getCLSID in interface IDEGdbTable

Returns:

The classID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCLSID

public void setCLSID(java.lang.String classID)
              throws java.io.IOException,
                     AutomationException

The GUID for the COM Class (CoClass) corresponding to instances of the object class represented by the table data element.

Specified by:

setCLSID in interface IDEGdbTable

Parameters:

classID - The classID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEXTCLSID

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

The GUID for the COM Class (CoClass) corresponding to the class extension of the object class represented by the table data element.

Specified by:

getEXTCLSID in interface IDEGdbTable

Returns:

The classID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEXTCLSID

public void setEXTCLSID(java.lang.String classID)
                 throws java.io.IOException,
                        AutomationException

The GUID for the COM Class (CoClass) corresponding to the class extension of the object class represented by the table data element.

Specified by:

setEXTCLSID in interface IDEGdbTable

Parameters:

classID - The classID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtensionProperties

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

The properties for the class extension.

Specified by:

getExtensionProperties in interface IDEGdbTable

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.

setExtensionPropertiesByRef

public void setExtensionPropertiesByRef(IPropertySet propertySet)
                                 throws java.io.IOException,
                                        AutomationException

The properties for the class extension.

Specified by:

setExtensionPropertiesByRef in interface IDEGdbTable

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.

getSubtypeFieldName

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

The name of the Subtype Field.

Specified by:

getSubtypeFieldName in interface IDEGdbTable

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubtypeFieldName

public void setSubtypeFieldName(java.lang.String fieldName)
                         throws java.io.IOException,
                                AutomationException

The name of the Subtype Field.

Specified by:

setSubtypeFieldName in interface IDEGdbTable

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultSubtypeCode

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

The default subtype code.

Specified by:

getDefaultSubtypeCode in interface IDEGdbTable

Returns:

The subtypeCode

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultSubtypeCode

public void setDefaultSubtypeCode(int subtypeCode)
                           throws java.io.IOException,
                                  AutomationException

The default subtype code.

Specified by:

setDefaultSubtypeCode in interface IDEGdbTable

Parameters:

subtypeCode - The subtypeCode (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubtypes

public IArray getSubtypes()
                   throws java.io.IOException,
                          AutomationException

The set of Subtypes.

Specified by:

getSubtypes in interface IDEGdbTable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubtypesByRef

public void setSubtypesByRef(IArray subtypes)
                      throws java.io.IOException,
                             AutomationException

The set of Subtypes.

Specified by:

setSubtypesByRef in interface IDEGdbTable

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAliasName

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

The alias name for the table.

Specified by:

getAliasName in interface IDEGdbTable

Returns:

The aliasName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAliasName

public void setAliasName(java.lang.String aliasName)
                  throws java.io.IOException,
                         AutomationException

The alias name for the table.

Specified by:

setAliasName in interface IDEGdbTable

Parameters:

aliasName - The aliasName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getModelName

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

The model name for the table.

Specified by:

getModelName in interface IDEGdbTable

Returns:

The modelName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setModelName

public void setModelName(java.lang.String modelName)
                  throws java.io.IOException,
                         AutomationException

The model name for the table.

Specified by:

setModelName in interface IDEGdbTable

Parameters:

modelName - The modelName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRelationshipClassNames

public IStringArray getRelationshipClassNames()
                                       throws java.io.IOException,
                                              AutomationException

The names of the Relationship Classes this object class participates in.

Specified by:

getRelationshipClassNames in interface IDEGdbTable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelationshipClassNamesByRef

public void setRelationshipClassNamesByRef(IStringArray relationshipClassNames)
                                    throws java.io.IOException,
                                           AutomationException

The names of the Relationship Classes this object class participates in.

Specified by:

setRelationshipClassNamesByRef in interface IDEGdbTable

Parameters:

relationshipClassNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getControllerMemberships

public IArray getControllerMemberships()
                                throws java.io.IOException,
                                       AutomationException

The set of controller memberships for the table.

Specified by:

getControllerMemberships in interface IDEGdbTable

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setControllerMembershipsByRef

public void setControllerMembershipsByRef(IArray controllerMemberships)
                                   throws java.io.IOException,
                                          AutomationException

The set of controller memberships for the table.

Specified by:

setControllerMembershipsByRef in interface IDEGdbTable

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasGlobalID

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

Indicates if the table has a GlobalID field.

Specified by:

isHasGlobalID in interface IDEGdbTable

Returns:

The hasGlobalID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHasGlobalID

public void setHasGlobalID(boolean hasGlobalID)
                    throws java.io.IOException,
                           AutomationException

Indicates if the table has a GlobalID field.

Specified by:

setHasGlobalID in interface IDEGdbTable

Parameters:

hasGlobalID - The hasGlobalID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGlobalIDFieldName

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

The name of the GlobalID Field.

Specified by:

getGlobalIDFieldName in interface IDEGdbTable

Returns:

The globalIDFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGlobalIDFieldName

public void setGlobalIDFieldName(java.lang.String globalIDFieldName)
                          throws java.io.IOException,
                                 AutomationException

The name of the GlobalID Field.

Specified by:

setGlobalIDFieldName in interface IDEGdbTable

Parameters:

globalIDFieldName - The globalIDFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRasterFieldName

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

The name of the raster field.

Specified by:

getRasterFieldName in interface IDEGdbTable

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterFieldName

public void setRasterFieldName(java.lang.String fieldName)
                        throws java.io.IOException,
                               AutomationException

The name of the raster field.

Specified by:

setRasterFieldName in interface IDEGdbTable

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEditorTrackingEnabled

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

The property to determine if Editor Tracking is enabled on this data element.

Specified by:

isEditorTrackingEnabled in interface IDEEditorTracking

Returns:

The isEditorTrackingEnabled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEditorTrackingEnabled

public void setEditorTrackingEnabled(boolean isEditorTrackingEnabled)
                              throws java.io.IOException,
                                     AutomationException

The property to determine if Editor Tracking is enabled on this data element.

Specified by:

setEditorTrackingEnabled in interface IDEEditorTracking

Parameters:

isEditorTrackingEnabled - The isEditorTrackingEnabled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCreatorFieldName

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

The name of the creator field.

Specified by:

getCreatorFieldName in interface IDEEditorTracking

Returns:

The creatorFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCreatorFieldName

public void setCreatorFieldName(java.lang.String creatorFieldName)
                         throws java.io.IOException,
                                AutomationException

The name of the creator field.

Specified by:

setCreatorFieldName in interface IDEEditorTracking

Parameters:

creatorFieldName - The creatorFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCreatedAtFieldName

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

The name of the creation time field.

Specified by:

getCreatedAtFieldName in interface IDEEditorTracking

Returns:

The createdAtFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCreatedAtFieldName

public void setCreatedAtFieldName(java.lang.String createdAtFieldName)
                           throws java.io.IOException,
                                  AutomationException

The name of the creation time field.

Specified by:

setCreatedAtFieldName in interface IDEEditorTracking

Parameters:

createdAtFieldName - The createdAtFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEditorFieldName

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

The name of the editor field.

Specified by:

getEditorFieldName in interface IDEEditorTracking

Returns:

The editorFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEditorFieldName

public void setEditorFieldName(java.lang.String editorFieldName)
                        throws java.io.IOException,
                               AutomationException

The name of the editor field.

Specified by:

setEditorFieldName in interface IDEEditorTracking

Parameters:

editorFieldName - The editorFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getEditedAtFieldName

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

The name of the edit time field.

Specified by:

getEditedAtFieldName in interface IDEEditorTracking

Returns:

The editedAtFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setEditedAtFieldName

public void setEditedAtFieldName(java.lang.String editedAtFieldName)
                          throws java.io.IOException,
                                 AutomationException

The name of the edit time field.

Specified by:

setEditedAtFieldName in interface IDEEditorTracking

Parameters:

editedAtFieldName - The editedAtFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTimeInUTC

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

The property to determine Editor Tracking times are recorded in UTC.

Specified by:

isTimeInUTC in interface IDEEditorTracking

Returns:

The isTimeInUTC

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsTimeInUTC

public void setIsTimeInUTC(boolean isTimeInUTC)
                    throws java.io.IOException,
                           AutomationException

The property to determine Editor Tracking times are recorded in UTC.

Specified by:

setIsTimeInUTC in interface IDEEditorTracking

Parameters:

isTimeInUTC - The isTimeInUTC (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getConfigurationKeyword

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

Configuration keyword.

Specified by:

getConfigurationKeyword in interface IDEDataset2

Returns:

The keyword

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setConfigurationKeyword

public void setConfigurationKeyword(java.lang.String keyword)
                             throws java.io.IOException,
                                    AutomationException

Configuration keyword.

Specified by:

setConfigurationKeyword in interface IDEDataset2

Parameters:

keyword - The keyword (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatasetType

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

Dataset type.

Specified by:

getDatasetType in interface IDEDataset

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.

setDatasetType

public void setDatasetType(int type)
                    throws java.io.IOException,
                           AutomationException

Dataset type.

Specified by:

setDatasetType in interface IDEDataset

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVersioned

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

Indicates if this dataset is versioned.

Specified by:

isVersioned in interface IDEDataset

Returns:

The versioned

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVersioned

public void setVersioned(boolean versioned)
                  throws java.io.IOException,
                         AutomationException

Indicates if this dataset is versioned.

Specified by:

setVersioned in interface IDEDataset

Parameters:

versioned - The versioned (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDSID

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

The id of the dataset.

Specified by:

getDSID in interface IDEDataset

Returns:

The dSID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDSID

public void setDSID(int dSID)
             throws java.io.IOException,
                    AutomationException

The id of the dataset.

Specified by:

setDSID in interface IDEDataset

Parameters:

dSID - The dSID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanVersion

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

Indicates if this dataset can be versioned.

Specified by:

isCanVersion in interface IDEDataset

Returns:

The canVersion

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCanVersion

public void setCanVersion(boolean canVersion)
                   throws java.io.IOException,
                          AutomationException

Indicates if this dataset can be versioned.

Specified by:

setCanVersion in interface IDEDataset

Parameters:

canVersion - The canVersion (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IDataElement_getType

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

The type of the element.

Specified by:

IDataElement_getType in interface IDataElement

Returns:

The type

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setType

public void setType(java.lang.String type)
             throws java.io.IOException,
                    AutomationException

The type of the element.

Specified by:

setType in interface IDataElement

Parameters:

type - The type (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IDataElement_getName

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

The user assigned name for the element.

Specified by:

IDataElement_getName in interface IDataElement

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 user assigned name for the element.

Specified by:

setName in interface IDataElement

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCatalogPath

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

The string used to retrieve the element.

Specified by:

getCatalogPath in interface IDataElement

Returns:

The path

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCatalogPath

public void setCatalogPath(java.lang.String path)
                    throws java.io.IOException,
                           AutomationException

The string used to retrieve the element.

Specified by:

setCatalogPath in interface IDataElement

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getChildren

public IArray getChildren()
                   throws java.io.IOException,
                          AutomationException

The list of sub-elements.

Specified by:

getChildren in interface IDataElement

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setChildrenByRef

public void setChildrenByRef(IArray dataElements)
                      throws java.io.IOException,
                             AutomationException

The list of sub-elements.

Specified by:

setChildrenByRef in interface IDataElement

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isChildrenExpanded

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

Indicates if the children have been expanded.

Specified by:

isChildrenExpanded in interface IDataElement

Returns:

The childrenExpanded

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setChildrenExpanded

public void setChildrenExpanded(boolean childrenExpanded)
                         throws java.io.IOException,
                                AutomationException

Indicates if the children have been expanded.

Specified by:

setChildrenExpanded in interface IDataElement

Parameters:

childrenExpanded - The childrenExpanded (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isMetadataRetrieved

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

Indicates if the metadata has been retrieved.

Specified by:

isMetadataRetrieved in interface IDataElement

Returns:

The metadataRetrieved

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMetadataRetrieved

public void setMetadataRetrieved(boolean metadataRetrieved)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the metadata has been retrieved.

Specified by:

setMetadataRetrieved in interface IDataElement

Parameters:

metadataRetrieved - The metadataRetrieved (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFullPropsRetrieved

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

Indicates if full properties have been retrieved.

Specified by:

isFullPropsRetrieved in interface IDataElement

Returns:

The fullPropsRetrieved

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFullPropsRetrieved

public void setFullPropsRetrieved(boolean fullPropsRetrieved)
                           throws java.io.IOException,
                                  AutomationException

Indicates if full properties have been retrieved.

Specified by:

setFullPropsRetrieved in interface IDataElement

Parameters:

fullPropsRetrieved - The fullPropsRetrieved (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPath

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

File path.

Specified by:

getPath in interface IDataElement

Returns:

The path

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFile

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

File name.

Specified by:

getFile in interface IDataElement

Returns:

The file

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBaseName

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

File base name.

Specified by:

getBaseName in interface IDataElement

Returns:

The baseName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtension

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

File extension.

Specified by:

getExtension in interface IDataElement

Returns:

The extension

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.

IGPValue_getDataType

public IGPDataType IGPValue_getDataType()
                                 throws java.io.IOException,
                                        AutomationException

The data type of the value object.

Specified by:

IGPValue_getDataType in interface IGPValue

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEmpty

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

Indicates if the value object is empty.

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

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

AutomationException - If the ArcObject component throws an exception.

empty

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

Clears the value object.

Specified by:

empty in interface IGPValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAsText

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

Provides the value of the value object.

Specified by:

getAsText in interface IGPValue

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(java.lang.String text)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

setAsText in interface IGPValue

Parameters:

text - The text (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

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

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

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

Returns:

The identical

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.

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.

describe

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

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