com.esri.arcgis.geoprocessing
Class GPFieldInfo

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.GPFieldInfo
All Implemented Interfaces:
IGPValue, IGPFieldInfo, IGPFieldInfo2, IGPFieldInfo3, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class GPFieldInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPValue, IGPFieldInfo, IGPFieldInfo2, IGPFieldInfo3, IClone, IXMLSerialize, IPersistStream, Externalizable

Geoprocessing value object describing a set of fields.

Product Availability

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

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
GPFieldInfo()
          Constructs a GPFieldInfo using ArcGIS Engine.
GPFieldInfo(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPFieldInfo theGPFieldInfo = (GPFieldInfo) obj;
 
Method Summary
 void addField(int fieldIndex, String fieldName, String newFieldName, boolean visible, int split)
          Add a field to the field info object.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 void empty()
          Clears the value object.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 int findFieldByIndex(int fieldIndex)
          Returns the index of the field in the field info object matching given the field index.
 int findFieldByName(String fieldName)
          Returns the index of the field in the field info object matching given the field name.
 int findFieldByNewName(String fieldName)
          Returns the index of the field in the field info object matching given the field new name.
 String getAliasName(int index)
          Returns the real alias of the specified field in the field info object.
 String getAsText()
          Provides the value of the value object.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getCount()
          The number of fields in the field info object.
 IGPDataType getDataType()
          The data type of the value object.
 int getFieldIndex(int index)
          Returns the field index of the specified field in the field info object.
 String getFieldName(int index)
          Returns the name of the specified field in the field info object.
 String getJoinDelimiter(int index)
          Returns the join delimiter of the specified field in the field info object.
 int getMergeRule(int index)
          Returns the merge rule of the specified field in the field info object.
 boolean getNamingError(int index)
          Returns whether there is an error with the specified field in the field info object.
 String getNewName(int index)
          Returns the new name of the specified field in the field info object.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getSplitRule(int index)
          Returns the split rule of the specified field in the field info object.
 void getTextPos(int index, int[] start, int[] end)
          Returns the start and end text positions.
 boolean getVisible(int index)
          Returns the visibility of the specified field in the field info object.
 int hashCode()
          the hashcode for this object
 void initialize(IDETable table, IDEWorkspace workspace)
          Initializes the field info object using the field information from the given table/workspace.
 void isDirty()
          isDirty
 boolean isEmpty()
          Indicates if the value object is empty.
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void load(IStream pstm)
          load
 void merge(IDETable table)
          Merges the field information from the given table data element into the field info object.
 void readExternal(ObjectInput in)
           
 void removeAll()
          Removes all the fields from the field info object.
 void removeField(int index)
          Removes the given field from the field info object.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setAliasName(int index, String alias)
          Sets the real alias of the specified field in the field info object.
 IGPMessage setAsText(String text)
          Provides the value of the value object with the given string value.
 void setFieldIndex(int index, int fieldIndex)
          Sets the name of the specified field in the field info object.
 void setFieldName(int index, String name)
          Sets the name of the specified field in the field info object.
 void setJoinDelimiter(int index, String delimiter)
          Sets the join delimiter of the specified field in the field info object.
 void setMergeRule(int index, int merge)
          Sets the merge rule of the specified field in the field info object.
 void setNamingError(int index, boolean error)
          Sets whether there is an error with the specified field in the field info object.
 void setNewName(int index, String name)
          Sets the new name of the specified field in the field info object.
 void setSplitRule(int index, int split)
          Sets the split rule of the specified field in the field info object.
 void setTextPos(int index, int start, int end)
          Sets the start and end text positions.
 void setVisible(int index, boolean visible)
          Sets the visibility of the specified field in the field info object.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

GPFieldInfo

public GPFieldInfo()
            throws IOException,
                   UnknownHostException
Constructs a GPFieldInfo using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GPFieldInfo

public GPFieldInfo(Object obj)
            throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPFieldInfo theGPFieldInfo = (GPFieldInfo) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

getDataType

public IGPDataType getDataType()
                        throws IOException,
                               AutomationException
The data type of the value object.

Remarks

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

Product Availability

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

Specified by:
getDataType in interface IGPValue
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPDataType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException
Indicates if the value object is empty.

Remarks

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

Product Availability

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

Specified by:
isEmpty in interface IGPValue
Returns:
The isEmpty
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

empty

public void empty()
           throws IOException,
                  AutomationException
Clears the value object.

Remarks

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

Product Availability

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

Specified by:
empty in interface IGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAsText

public String getAsText()
                 throws IOException,
                        AutomationException
Provides the value of the value object.

Remarks

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

Product Availability

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

Specified by:
getAsText in interface IGPValue
Returns:
The text
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAsText

public IGPMessage setAsText(String text)
                     throws IOException,
                            AutomationException
Provides the value of the value object with the given string value.

Remarks

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

Product Availability

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

Specified by:
setAsText in interface IGPValue
Parameters:
text - The text (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initialize

public void initialize(IDETable table,
                       IDEWorkspace workspace)
                throws IOException,
                       AutomationException
Initializes the field info object using the field information from the given table/workspace.

Product Availability

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

Supported Platforms

Windows

Specified by:
initialize in interface IGPFieldInfo
Parameters:
table - A reference to a com.esri.arcgis.geodatabase.IDETable (in)
workspace - A reference to a com.esri.arcgis.geodatabase.IDEWorkspace (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

merge

public void merge(IDETable table)
           throws IOException,
                  AutomationException
Merges the field information from the given table data element into the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
merge in interface IGPFieldInfo
Parameters:
table - A reference to a com.esri.arcgis.geodatabase.IDETable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException
Removes all the fields from the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
removeAll in interface IGPFieldInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addField

public void addField(int fieldIndex,
                     String fieldName,
                     String newFieldName,
                     boolean visible,
                     int split)
              throws IOException,
                     AutomationException
Add a field to the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
addField in interface IGPFieldInfo
Parameters:
fieldIndex - The fieldIndex (in)
fieldName - The fieldName (in)
newFieldName - The newFieldName (in)
visible - The visible (in)
split - A com.esri.arcgis.geoprocessing.esriGPFieldInfoSplitRule constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException
The number of fields in the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
getCount in interface IGPFieldInfo
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldName

public String getFieldName(int index)
                    throws IOException,
                           AutomationException
Returns the name of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
getFieldName in interface IGPFieldInfo
Parameters:
index - The index (in)
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFieldIndex

public int getFieldIndex(int index)
                  throws IOException,
                         AutomationException
Returns the field index of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
getFieldIndex in interface IGPFieldInfo
Parameters:
index - The index (in)
Returns:
The fieldIndex
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNamingError

public boolean getNamingError(int index)
                       throws IOException,
                              AutomationException
Returns whether there is an error with the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
getNamingError in interface IGPFieldInfo
Parameters:
index - The index (in)
Returns:
The error
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNewName

public String getNewName(int index)
                  throws IOException,
                         AutomationException
Returns the new name of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
getNewName in interface IGPFieldInfo
Parameters:
index - The index (in)
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSplitRule

public int getSplitRule(int index)
                 throws IOException,
                        AutomationException
Returns the split rule of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
getSplitRule in interface IGPFieldInfo
Parameters:
index - The index (in)
Returns:
A com.esri.arcgis.geoprocessing.esriGPFieldInfoSplitRule constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVisible

public boolean getVisible(int index)
                   throws IOException,
                          AutomationException
Returns the visibility of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
getVisible in interface IGPFieldInfo
Parameters:
index - The index (in)
Returns:
The visible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFieldName

public void setFieldName(int index,
                         String name)
                  throws IOException,
                         AutomationException
Sets the name of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
setFieldName in interface IGPFieldInfo
Parameters:
index - The index (in)
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFieldIndex

public void setFieldIndex(int index,
                          int fieldIndex)
                   throws IOException,
                          AutomationException
Sets the name of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
setFieldIndex in interface IGPFieldInfo
Parameters:
index - The index (in)
fieldIndex - The fieldIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNamingError

public void setNamingError(int index,
                           boolean error)
                    throws IOException,
                           AutomationException
Sets whether there is an error with the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
setNamingError in interface IGPFieldInfo
Parameters:
index - The index (in)
error - The error (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNewName

public void setNewName(int index,
                       String name)
                throws IOException,
                       AutomationException
Sets the new name of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
setNewName in interface IGPFieldInfo
Parameters:
index - The index (in)
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSplitRule

public void setSplitRule(int index,
                         int split)
                  throws IOException,
                         AutomationException
Sets the split rule of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
setSplitRule in interface IGPFieldInfo
Parameters:
index - The index (in)
split - A com.esri.arcgis.geoprocessing.esriGPFieldInfoSplitRule constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(int index,
                       boolean visible)
                throws IOException,
                       AutomationException
Sets the visibility of the specified field in the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
setVisible in interface IGPFieldInfo
Parameters:
index - The index (in)
visible - The visible (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeField

public void removeField(int index)
                 throws IOException,
                        AutomationException
Removes the given field from the field info object.

Product Availability

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

Supported Platforms

Windows

Specified by:
removeField in interface IGPFieldInfo
Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findFieldByName

public int findFieldByName(String fieldName)
                    throws IOException,
                           AutomationException
Returns the index of the field in the field info object matching given the field name.

Product Availability

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

Supported Platforms

Windows

Specified by:
findFieldByName in interface IGPFieldInfo
Parameters:
fieldName - The fieldName (in)
Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findFieldByNewName

public int findFieldByNewName(String fieldName)
                       throws IOException,
                              AutomationException
Returns the index of the field in the field info object matching given the field new name.

Product Availability

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

Supported Platforms

Windows

Specified by:
findFieldByNewName in interface IGPFieldInfo
Parameters:
fieldName - The fieldName (in)
Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findFieldByIndex

public int findFieldByIndex(int fieldIndex)
                     throws IOException,
                            AutomationException
Returns the index of the field in the field info object matching given the field index.

Product Availability

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

Supported Platforms

Windows

Specified by:
findFieldByIndex in interface IGPFieldInfo
Parameters:
fieldIndex - The fieldIndex (in)
Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMergeRule

public int getMergeRule(int index)
                 throws IOException,
                        AutomationException
Returns the merge rule of the specified field in the field info object.

Product Availability

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

Specified by:
getMergeRule in interface IGPFieldInfo2
Parameters:
index - The index (in)
Returns:
A com.esri.arcgis.geoprocessing.esriGPFieldMapMergeRule constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMergeRule

public void setMergeRule(int index,
                         int merge)
                  throws IOException,
                         AutomationException
Sets the merge rule of the specified field in the field info object.

Product Availability

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

Specified by:
setMergeRule in interface IGPFieldInfo2
Parameters:
index - The index (in)
merge - A com.esri.arcgis.geoprocessing.esriGPFieldMapMergeRule constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJoinDelimiter

public String getJoinDelimiter(int index)
                        throws IOException,
                               AutomationException
Returns the join delimiter of the specified field in the field info object.

Product Availability

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

Specified by:
getJoinDelimiter in interface IGPFieldInfo2
Parameters:
index - The index (in)
Returns:
The delimiter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setJoinDelimiter

public void setJoinDelimiter(int index,
                             String delimiter)
                      throws IOException,
                             AutomationException
Sets the join delimiter of the specified field in the field info object.

Product Availability

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

Specified by:
setJoinDelimiter in interface IGPFieldInfo2
Parameters:
index - The index (in)
delimiter - The delimiter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTextPos

public void getTextPos(int index,
                       int[] start,
                       int[] end)
                throws IOException,
                       AutomationException
Returns the start and end text positions.

Product Availability

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

Specified by:
getTextPos in interface IGPFieldInfo2
Parameters:
index - The index (in)
start - The start (out: use single element array)
end - The end (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextPos

public void setTextPos(int index,
                       int start,
                       int end)
                throws IOException,
                       AutomationException
Sets the start and end text positions.

Product Availability

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

Specified by:
setTextPos in interface IGPFieldInfo2
Parameters:
index - The index (in)
start - The start (in)
end - The end (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAliasName

public String getAliasName(int index)
                    throws IOException,
                           AutomationException
Returns the real alias of the specified field in the field info object.

Product Availability

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

Specified by:
getAliasName in interface IGPFieldInfo3
Parameters:
index - The index (in)
Returns:
The alias
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAliasName

public void setAliasName(int index,
                         String alias)
                  throws IOException,
                         AutomationException
Sets the real alias of the specified field in the field info object.

Product Availability

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

Specified by:
setAliasName in interface IGPFieldInfo3
Parameters:
index - The index (in)
alias - The alias (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException