com.esri.arcgis.system

Class XMLReader

java.lang.Object

com.esri.arcgis.system.XMLReader

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, IXMLReader, IXMLReader2, IXMLReader3, java.io.Serializable

public class XMLReader
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IXMLReader, IXMLReader2, IXMLReader3, ISupportErrorInfo

COM Class 'XMLReader'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description 'An XML sequential document reader.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

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

IID, IID1b8a0010_70d1_4461_8f53_230fe5dc42ed, xxDummy

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

IID93c1ac3b_4520_450d_b005_95fd01b50c4a

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

IIDd405f844_8057_4df4_b2da_df25dedebf4c

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

Constructors

Constructor and Description
XMLReader() Constructs a XMLReader using ArcGIS Engine.
XMLReader(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. XMLReader theXMLReader = (XMLReader) obj;

Method Summary

Modifier and Type	Method and Description
void	closeElement() Moves position to parent element.
boolean	equals(java.lang.Object o) Compare this object with another
IXMLAttributes	getAttributes() Attributes of current element.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getLocalName() Local name of current element.
IXMLNamespaces	getNamespaceDeclarations() Namespace declarations of current element.
java.lang.String	getNamespacePrefix() Namespace prefix of current element.
java.lang.String	getNamespaceURI() Namespace URI of current element.
java.lang.String	getText() Text value of current element.
java.lang.String	getXML() XML representation of the current element.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isHasElementChildren() Indicates whether the current element has child elements.
boolean	isLastChild() Indicates whether the current element is the last child element of its parent.
java.lang.String	lookupPrefix(java.lang.String prefix) Obtains the prefix for a declared URI.
void	nextElement() Moves position to next element.
void	openElement() Moves position to first child element.
byte[]	readBinary() Reads the current element value as a binary array.
boolean	readBoolean() Reads the current element value as a boolean.
byte	readByte() Reads the current element value as a byte.
java.util.Date	readDate() Reads the current element value as a date.
double	readDouble() Reads the current element value as a double.
float	readFloat() Reads the current element value as a float.
void	readFrom(IStream inputStream) Specifies the input XML stream.
long	readInt64() Reads the current element value as an int64.
int	readInteger() Reads the current element value as a long.
short	readShort() Reads the current element value as a short.
int	readUInteger() Reads the current element value as an usigned long.
short	readUShort() Reads the current element value as an unsigned short.
java.lang.Object	readVariant() Reads the current element value as a variant.
void	release() Release this COM object reference

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLReader

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

Constructs a XMLReader using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

XMLReader

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

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

readFrom

public void readFrom(IStream inputStream)
              throws java.io.IOException,
                     AutomationException

Specifies the input XML stream.

Specified by:

readFrom in interface IXMLReader

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLocalName

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

Local name of current element.

Specified by:

getLocalName in interface IXMLReader

Returns:

The localName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNamespaceURI

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

Namespace URI of current element.

Specified by:

getNamespaceURI in interface IXMLReader

Returns:

The uri

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNamespacePrefix

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

Namespace prefix of current element.

Specified by:

getNamespacePrefix in interface IXMLReader

Returns:

The prefix

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNamespaceDeclarations

public IXMLNamespaces getNamespaceDeclarations()
                                        throws java.io.IOException,
                                               AutomationException

Namespace declarations of current element.

Specified by:

getNamespaceDeclarations in interface IXMLReader

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAttributes

public IXMLAttributes getAttributes()
                             throws java.io.IOException,
                                    AutomationException

Attributes of current element.

Specified by:

getAttributes in interface IXMLReader

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getText

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

Text value of current element.

Specified by:

getText in interface IXMLReader

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasElementChildren

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

Indicates whether the current element has child elements.

Specified by:

isHasElementChildren in interface IXMLReader

Returns:

The hasChildren

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isLastChild

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

Indicates whether the current element is the last child element of its parent.

Specified by:

isLastChild in interface IXMLReader

Returns:

The isLast

Throws:

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

AutomationException - If the ArcObject component throws an exception.

nextElement

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

Moves position to next element.

Specified by:

nextElement in interface IXMLReader

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openElement

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

Moves position to first child element.

Specified by:

openElement in interface IXMLReader

Throws:

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

AutomationException - If the ArcObject component throws an exception.

closeElement

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

Moves position to parent element.

Specified by:

closeElement in interface IXMLReader

Throws:

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

AutomationException - If the ArcObject component throws an exception.

lookupPrefix

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

Obtains the prefix for a declared URI.

Specified by:

lookupPrefix in interface IXMLReader

Parameters:

prefix - The prefix (in)

Returns:

The uri

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readBoolean

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

Reads the current element value as a boolean.

Specified by:

readBoolean in interface IXMLReader

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readByte

public byte readByte()
              throws java.io.IOException,
                     AutomationException

Reads the current element value as a byte.

Specified by:

readByte in interface IXMLReader

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readShort

public short readShort()
                throws java.io.IOException,
                       AutomationException

Reads the current element value as a short.

Specified by:

readShort in interface IXMLReader

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readInteger

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

Reads the current element value as a long.

Specified by:

readInteger in interface IXMLReader

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readFloat

public float readFloat()
                throws java.io.IOException,
                       AutomationException

Reads the current element value as a float.

Specified by:

readFloat in interface IXMLReader

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readDouble

public double readDouble()
                  throws java.io.IOException,
                         AutomationException

Reads the current element value as a double.

Specified by:

readDouble in interface IXMLReader

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readDate

public java.util.Date readDate()
                        throws java.io.IOException,
                               AutomationException

Reads the current element value as a date.

Specified by:

readDate in interface IXMLReader

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readBinary

public byte[] readBinary()
                  throws java.io.IOException,
                         AutomationException

Reads the current element value as a binary array.

Specified by:

readBinary in interface IXMLReader

Returns:

An unsigned byte

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readVariant

public java.lang.Object readVariant()
                             throws java.io.IOException,
                                    AutomationException

Reads the current element value as a variant.

Specified by:

readVariant in interface IXMLReader

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getXML

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

XML representation of the current element.

Specified by:

getXML in interface IXMLReader2

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readInt64

public long readInt64()
               throws java.io.IOException,
                      AutomationException

Reads the current element value as an int64.

Specified by:

readInt64 in interface IXMLReader2

Returns:

Signed 64-bit int

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readUShort

public short readUShort()
                 throws java.io.IOException,
                        AutomationException

Reads the current element value as an unsigned short.

Specified by:

readUShort in interface IXMLReader3

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

readUInteger

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

Reads the current element value as an usigned long.

Specified by:

readUInteger in interface IXMLReader3

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.