com.esri.arcgis.system
Interface IXMLSerializeData

All Superinterfaces:

Serializable

All Known Implementing Classes:

IXMLSerializeDataProxy

public interface IXMLSerializeData
extends Serializable

Provides access to members that serialize and deserialize data from XML.

Product Availability

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

Method Summary

void	addBinary(String name, byte[] value) Adds element value as an array of bytes.
void	addBoolean(String name, boolean value) Adds element value as a boolean.
void	addByte(String name, byte value) Adds element value as a byte.
void	addDate(String name, Date value) Adds element value as a date.
void	addDouble(String name, double value) Adds element value as a double.
void	addFloat(String name, float value) Adds element value as a float.
void	addInteger(String name, int value) Adds element value as an integer.
void	addObject(String name, Object value) Adds element value as an object.
void	addShort(String name, short value) Adds element value as a short.
void	addString(String name, String value) Adds element value as a string.
void	addVariant(String name, Object value) Adds element value as a variant.
int	find(String name) Finds an XML element by name.
byte[]	getBinary(int index) Obtains element value as an array of bytes.
boolean	getBoolean(int index) Obtains element value as a boolean.
byte	getByte(int index) Obtains element value as a byte.
int	getCount() Number of XML elements.
Date	getDate(int index) Obtains element value as a date.
double	getDouble(int index) Obtains element value as a double.
boolean	getFlag(String name) Obtains the value for a serialization flag.
float	getFloat(int index) Obtains element value as a float.
int	getInteger(int index) Obtains element value as an integer.
Object	getObject(int index, String typeNamespace, String typeName) Obtains element value as an object instance.
IPropertySet	getProperties() Properties for serialization and deserialization.
short	getShort(int index) Obtains element value as a short.
String	getString(int index) Obtains element value as a string.
String	getTypeName() XML type of the object.
String	getTypeNamespaceURI() XML type namespace of the object.
Object	getVariant(int index) Obtains element value as a variant.
void	setFlag(String name, boolean flagValue) Writes the value for a serialization flag.
void	setPropertiesByRef(IPropertySet props) Properties for serialization and deserialization.
void	setTypeName(String name) XML type of the object.
void	setTypeNamespaceURI(String ns) XML type namespace of the object.

Method Detail

getTypeName

String getTypeName()
                   throws IOException,
                          AutomationException

XML type of the object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTypeNamespaceURI

String getTypeNamespaceURI()
                           throws IOException,
                                  AutomationException

XML type namespace of the object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The ns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTypeName

void setTypeName(String name)
                 throws IOException,
                        AutomationException

XML type of the object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTypeNamespaceURI

void setTypeNamespaceURI(String ns)
                         throws IOException,
                                AutomationException

XML type namespace of the object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

ns - The ns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

IPropertySet getProperties()
                           throws IOException,
                                  AutomationException

Properties for serialization and deserialization.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertiesByRef

void setPropertiesByRef(IPropertySet props)
                        throws IOException,
                               AutomationException

Properties for serialization and deserialization.

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

find

int find(String name)
         throws IOException,
                AutomationException

Finds an XML element by name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

Number of XML elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getString

String getString(int index)
                 throws IOException,
                        AutomationException

Obtains element value as a string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoolean

boolean getBoolean(int index)
                   throws IOException,
                          AutomationException

Obtains element value as a boolean.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getByte

byte getByte(int index)
             throws IOException,
                    AutomationException

Obtains element value as a byte.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShort

short getShort(int index)
               throws IOException,
                      AutomationException

Obtains element value as a short.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInteger

int getInteger(int index)
               throws IOException,
                      AutomationException

Obtains element value as an integer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFloat

float getFloat(int index)
               throws IOException,
                      AutomationException

Obtains element value as a float.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDouble

double getDouble(int index)
                 throws IOException,
                        AutomationException

Obtains element value as a double.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDate

Date getDate(int index)
             throws IOException,
                    AutomationException

Obtains element value as a date.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObject

Object getObject(int index,
                 String typeNamespace,
                 String typeName)
                 throws IOException,
                        AutomationException

Obtains element value as an object instance.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

typeNamespace - The typeNamespace (in)

typeName - The typeName (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBinary

byte[] getBinary(int index)
                 throws IOException,
                        AutomationException

Obtains element value as an array of bytes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

An unsigned byte

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVariant

Object getVariant(int index)
                  throws IOException,
                         AutomationException

Obtains element value as a variant.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

index - The index (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addString

void addString(String name,
               String value)
               throws IOException,
                      AutomationException

Adds element value as a string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addBoolean

void addBoolean(String name,
                boolean value)
                throws IOException,
                       AutomationException

Adds element value as a boolean.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addByte

void addByte(String name,
             byte value)
             throws IOException,
                    AutomationException

Adds element value as a byte.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

value - An unsigned byte (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addShort

void addShort(String name,
              short value)
              throws IOException,
                     AutomationException

Adds element value as a short.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addInteger

void addInteger(String name,
                int value)
                throws IOException,
                       AutomationException

Adds element value as an integer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFloat

void addFloat(String name,
              float value)
              throws IOException,
                     AutomationException

Adds element value as a float.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDouble

void addDouble(String name,
               double value)
               throws IOException,
                      AutomationException

Adds element value as a double.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addDate

void addDate(String name,
             Date value)
             throws IOException,
                    AutomationException

Adds element value as a date.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addObject

void addObject(String name,
               Object value)
               throws IOException,
                      AutomationException

Adds element value as an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

value - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addBinary

void addBinary(String name,
               byte[] value)
               throws IOException,
                      AutomationException

Adds element value as an array of bytes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

value - An unsigned byte (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addVariant

void addVariant(String name,
                Object value)
                throws IOException,
                       AutomationException

Adds element value as a variant.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlag

void setFlag(String name,
             boolean flagValue)
             throws IOException,
                    AutomationException

Writes the value for a serialization flag.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

flagValue - The flagValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFlag

boolean getFlag(String name)
                throws IOException,
                       AutomationException

Obtains the value for a serialization flag.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Returns:

The flagValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.