com.esri.arcgis.system
Class IXMLSerializeDataProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.system.IXMLSerializeDataProxy

All Implemented Interfaces:

IXMLSerializeData, Externalizable, Serializable

public class IXMLSerializeDataProxy
extends com.esri.arcgis.interop.Dispatch
implements IXMLSerializeData, Serializable

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

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IXMLSerializeDataProxy()
	IXMLSerializeDataProxy(Object obj)
protected	IXMLSerializeDataProxy(Object obj, String iid)

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	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IXMLSerializeDataProxy

public IXMLSerializeDataProxy()

IXMLSerializeDataProxy

public IXMLSerializeDataProxy(Object obj)
                       throws IOException

Throws:

IOException

IXMLSerializeDataProxy

protected IXMLSerializeDataProxy(Object obj,
                                 String iid)
                          throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

getTypeName

public 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

Specified by:

getTypeName in interface IXMLSerializeData

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTypeNamespaceURI

public 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

Specified by:

getTypeNamespaceURI in interface IXMLSerializeData

Returns:

The ns

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTypeName

public 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

Specified by:

setTypeName in interface IXMLSerializeData

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTypeNamespaceURI

public 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

Specified by:

setTypeNamespaceURI in interface IXMLSerializeData

Parameters:

ns - The ns (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

public 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

Specified by:

getProperties in interface IXMLSerializeData

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

public void setPropertiesByRef(IPropertySet props)
                        throws IOException,
                               AutomationException

Properties for serialization and deserialization.

Product Availability

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

Specified by:

setPropertiesByRef in interface IXMLSerializeData

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

public 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

Specified by:

find in interface IXMLSerializeData

Parameters:

name - The name (in)

Returns:

The index

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public 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

Specified by:

getCount in interface IXMLSerializeData

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getString

public 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

Specified by:

getString in interface IXMLSerializeData

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBoolean

public 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

Specified by:

getBoolean in interface IXMLSerializeData

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getByte

public 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

Specified by:

getByte in interface IXMLSerializeData

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

public 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

Specified by:

getShort in interface IXMLSerializeData

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInteger

public 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

Specified by:

getInteger in interface IXMLSerializeData

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFloat

public 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

Specified by:

getFloat in interface IXMLSerializeData

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDouble

public 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

Specified by:

getDouble in interface IXMLSerializeData

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDate

public 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

Specified by:

getDate in interface IXMLSerializeData

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObject

public 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

Specified by:

getObject in interface IXMLSerializeData

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

public 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

Specified by:

getBinary in interface IXMLSerializeData

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

public 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

Specified by:

getVariant in interface IXMLSerializeData

Parameters:

index - The index (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addString

public 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

Specified by:

addString in interface IXMLSerializeData

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

public 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

Specified by:

addBoolean in interface IXMLSerializeData

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

public 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

Specified by:

addByte in interface IXMLSerializeData

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

public 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

Specified by:

addShort in interface IXMLSerializeData

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

public 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

Specified by:

addInteger in interface IXMLSerializeData

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

public 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

Specified by:

addFloat in interface IXMLSerializeData

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

public 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

Specified by:

addDouble in interface IXMLSerializeData

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

public 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

Specified by:

addDate in interface IXMLSerializeData

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

public 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

Specified by:

addObject in interface IXMLSerializeData

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

public 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

Specified by:

addBinary in interface IXMLSerializeData

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

public 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

Specified by:

addVariant in interface IXMLSerializeData

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

public 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

Specified by:

setFlag in interface IXMLSerializeData

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

public 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

Specified by:

getFlag in interface IXMLSerializeData

Parameters:

name - The name (in)

Returns:

The flagValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.