com.esri.arcgis.datasourcesfile
Class DEDbaseTable

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

All Implemented Interfaces:

IClone, IDataElement, IDEDataset, IDEDbaseTable, IDETable, IGPDescribe, IGPValue, IMetadata, IPersist, IPersistStream, IXMLSerialize, java.io.Serializable

public class DEDbaseTable

extends java.lang.Object

implements IDEDbaseTable, IDETable, IDEDataset, IDataElement, IMetadata, IGPValue, IXMLSerialize, IClone, IPersistStream, IGPDescribe

Dbase Table Data Element object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

DEDbaseTable()
Constructs a DEDbaseTable using ArcGIS Engine.

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

Method Summary

void	assign(IClone src) Assigns the properties of src to the receiver.
java.lang.Object	describe(java.lang.String name)
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.
IClone	getAsIClone() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDataElement	getAsIDataElement() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDEDataset	getAsIDEDataset() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDEDbaseTable	getAsIDEDbaseTable() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IDETable	getAsIDETable() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGPDescribe	getAsIGPDescribe() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IGPValue	getAsIGPValue() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IMetadata	getAsIMetadata() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IPersistStream	getAsIPersistStream() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IXMLSerialize	getAsIXMLSerialize() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
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) Supported Platforms
static java.lang.String	getClsid()
int	getDatasetType() Dataset type.
IGPDataType	getDataType() Provides the data type of the value object.
int	getDSID() The id of the dataset.
java.lang.String	getExtension() File extension.
IFields	getFields() The list of Fields.
java.lang.String	getFile() File name.
IIndexes	getIndexes() The list of Indexes.
IPropertySet	getMetadata() The PropertySet containing metadata.
java.lang.String	getName() The user assigned name for the element.
java.lang.String	getOIDFieldName() The name of the OID Field.
java.lang.String	getPath() File path.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) Supported Platforms
java.lang.String	getType() The type of the element.
int	hashCode() the hashcode for this object
boolean	isCanVersion() Indicates if this dataset can be versioned.
boolean	isChildrenExpanded() Indicates if the children have been expanded.
void	isDirty() Supported Platforms
boolean	isEmpty() Indicates if the value object empty.
boolean	isEqual(IClone other) Returns TRUE when the receiver and other have the same properties.
boolean	isFullPropsRetrieved() Indicates if full properties have been retrieved.
boolean	isHasOID() Indicates if the table has an object id field.
boolean	isIdentical(IClone other) Returns TRUE when 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) Supported Platforms
void	save(IStream pstm, int fClearDirty) Supported Platforms
void	serialize(IXMLSerializeData data) Serializes an object to XML.
IGPMessage	setAsText(java.lang.String text) Provides the value of the value object with the given string value.
void	setCanVersion(boolean canersion) Indicates if this dataset can be versioned.
void	setCatalogPath(java.lang.String path) The string used to retrieve the element.
void	setChildrenByRef(IArray ppDataElements) The list of sub-elements.
void	setChildrenExpanded(boolean pChildrenExpanded) Indicates if the children have been expanded.
void	setDatasetType(int pType) Dataset type.
void	setDSID(int dSID) The id of the dataset.
void	setFieldsByRef(IFields ppFields) The list of Fields.
void	setFullPropsRetrieved(boolean pFullPropsRetrieved) Indicates if full properties have been retrieved.
void	setHasOID(boolean hasOID) Indicates if the table has an object id field.
void	setIndexesByRef(IIndexes ppIndexes) The list of Indexes.
void	setMetadata(IPropertySet ppPropertySet) The PropertySet containing metadata.
void	setMetadataRetrieved(boolean pMetadataRetrieved) Indicates if the metadata has been retrieved.
void	setName(java.lang.String pName) The user assigned name for the element.
void	setOIDFieldName(java.lang.String oIDFieldName) The name of the OID Field.
void	setType(java.lang.String pType) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DEDbaseTable

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

Constructs a DEDbaseTable using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

DEDbaseTable

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

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIDEDbaseTable

public IDEDbaseTable getAsIDEDbaseTable()

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

getAsIDETable

public IDETable getAsIDETable()

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

getAsIDEDataset

public IDEDataset getAsIDEDataset()

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

getAsIDataElement

public IDataElement getAsIDataElement()

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

getAsIMetadata

public IMetadata getAsIMetadata()

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

getAsIGPValue

public IGPValue getAsIGPValue()

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

getAsIXMLSerialize

public IXMLSerialize getAsIXMLSerialize()

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

getAsIClone

public IClone getAsIClone()

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

getAsIPersistStream

public IPersistStream getAsIPersistStream()

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

getAsIGPDescribe

public IGPDescribe getAsIGPDescribe()

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

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

isHasOID

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

Description copied from interface: IDETable

Indicates if the table has an object id field.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isHasOID in interface IDETable

Returns:

The hasOID

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setHasOID

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

Description copied from interface: IDETable

Indicates if the table has an object id field.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHasOID in interface IDETable

Parameters:

hasOID - The hasOID (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getOIDFieldName

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

Description copied from interface: IDETable

The name of the OID Field.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getOIDFieldName in interface IDETable

Returns:

The oIDFieldName

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setOIDFieldName

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

Description copied from interface: IDETable

The name of the OID Field.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IDETable

The list of Indexes.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getIndexes in interface IDETable

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setIndexesByRef

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

Description copied from interface: IDETable

The list of Indexes.

Specified by:

setIndexesByRef in interface IDETable

Parameters:

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

Description copied from interface: IDETable

The list of Fields.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFields in interface IDETable

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setFieldsByRef

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

Description copied from interface: IDETable

The list of Fields.

Specified by:

setFieldsByRef in interface IDETable

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDatasetType

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

Description copied from interface: IDEDataset

Dataset type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDatasetType in interface IDEDataset

Returns:

A com.esri.arcgis.geodatabase.esriDatasetType constant

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setDatasetType

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

Description copied from interface: IDEDataset

Dataset type.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDatasetType in interface IDEDataset

Parameters:

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

Description copied from interface: IDEDataset

Indicates if this dataset is versioned.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVersioned in interface IDEDataset

Returns:

The versioned

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setVersioned

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

Description copied from interface: IDEDataset

Indicates if this dataset is versioned.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVersioned in interface IDEDataset

Parameters:

versioned - The versioned (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getDSID

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

Description copied from interface: IDEDataset

The id of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDSID in interface IDEDataset

Returns:

The dSID

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setDSID

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

Description copied from interface: IDEDataset

The id of the dataset.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDSID in interface IDEDataset

Parameters:

dSID - The dSID (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isCanVersion

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

Description copied from interface: IDEDataset

Indicates if this dataset can be versioned.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCanVersion in interface IDEDataset

Returns:

The canersion

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setCanVersion

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

Description copied from interface: IDEDataset

Indicates if this dataset can be versioned.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCanVersion in interface IDEDataset

Parameters:

canersion - The canersion (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getType

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

Description copied from interface: IDataElement

The type of the element.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getType in interface IDataElement

Returns:

The pType

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setType

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

Description copied from interface: IDataElement

The type of the element.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setType in interface IDataElement

Parameters:

pType - The pType (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

Description copied from interface: IDataElement

The user assigned name for the element.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface IDataElement

Returns:

The pName

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setName

public void setName(java.lang.String pName)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IDataElement

The user assigned name for the element.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface IDataElement

Parameters:

pName - The pName (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getCatalogPath

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

Description copied from interface: IDataElement

The string used to retrieve the element.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IDataElement

The string used to retrieve the element.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCatalogPath in interface IDataElement

Parameters:

path - The path (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getChildren

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

Description copied from interface: IDataElement

The list of sub-elements.

Supported Platforms

Windows, Solaris, Linux

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 ppDataElements)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IDataElement

The list of sub-elements.

Specified by:

setChildrenByRef in interface IDataElement

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isChildrenExpanded

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

Description copied from interface: IDataElement

Indicates if the children have been expanded.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isChildrenExpanded in interface IDataElement

Returns:

The pChildrenExpanded

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setChildrenExpanded

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

Description copied from interface: IDataElement

Indicates if the children have been expanded.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setChildrenExpanded in interface IDataElement

Parameters:

pChildrenExpanded - The pChildrenExpanded (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isMetadataRetrieved

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

Description copied from interface: IDataElement

Indicates if the metadata has been retrieved.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isMetadataRetrieved in interface IDataElement

Returns:

The pMetadataRetrieved

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMetadataRetrieved

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

Description copied from interface: IDataElement

Indicates if the metadata has been retrieved.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMetadataRetrieved in interface IDataElement

Parameters:

pMetadataRetrieved - The pMetadataRetrieved (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isFullPropsRetrieved

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

Description copied from interface: IDataElement

Indicates if full properties have been retrieved.

Supported Platforms

Windows, Solaris, Linux

Specified by:

isFullPropsRetrieved in interface IDataElement

Returns:

The pFullPropsRetrieved

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setFullPropsRetrieved

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

Description copied from interface: IDataElement

Indicates if full properties have been retrieved.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFullPropsRetrieved in interface IDataElement

Parameters:

pFullPropsRetrieved - The pFullPropsRetrieved (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getPath

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

Description copied from interface: IDataElement

File path.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPath in interface IDataElement

Returns:

The pPath

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

Description copied from interface: IDataElement

File name.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFile in interface IDataElement

Returns:

The pFile

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

Description copied from interface: IDataElement

File base name.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBaseName in interface IDataElement

Returns:

The pBaseName

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getExtension

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

Description copied from interface: IDataElement

File extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

getExtension in interface IDataElement

Returns:

The pExtension

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

Description copied from interface: IMetadata

The PropertySet containing metadata.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

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

Specified by:

getMetadata in interface IMetadata

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMetadata

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

Description copied from interface: IMetadata

The PropertySet containing metadata.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMetadata in interface IMetadata

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

synchronize

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

Description copied from interface: IMetadata

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

Supported Platforms

Windows, Solaris, Linux

Description

The Synchronize method is used to extract metadata properties from an object and write those properties to the metadata .xml. Depending on the value of the esriMetaSyncAction, the Synchronize method may generate a new set of metadata if it doesn't already exist.

Specified by:

synchronize in interface IMetadata

Parameters:

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

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataType

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

Description copied from interface: IGPValue

Provides the data type of the value object.

Remarks

The DataType property returns the DataType object associated with this Value object.

Specified by:

getDataType in interface IGPValue

Returns:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isEmpty

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

Description copied from interface: IGPValue

Indicates if the value object empty.

Specified by:

isEmpty in interface IGPValue

Returns:

The isEmpty

Throws:

AutomationException - If the ArcObject component throws an exception.

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

empty

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

Description copied from interface: IGPValue

Clears the value object.

Remarks

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

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

Description copied from interface: IGPValue

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.

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

Description copied from interface: IGPValue

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

Description copied from interface: IXMLSerialize

Serializes an object to XML.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IXMLSerialize

Deserializes an object from XML.

Supported Platforms

Windows, Solaris, Linux

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

Description copied from interface: IClone

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

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

assign in interface IClone

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

isEqual

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

Description copied from interface: IClone

Returns TRUE when 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:

AutomationException - If the ArcObject component throws an exception.

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

isIdentical

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

Description copied from interface: IClone

Returns TRUE when 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:

AutomationException - If the ArcObject component throws an exception.

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

isDirty

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

save

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getClassID

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

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

describe

public java.lang.Object describe(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

Specified by:

describe in interface IGPDescribe

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

AutomationException - If the ArcObject component throws an exception.

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