com.esri.arcgis.carto
Class IMSGlobeXMLNode

java.lang.Object
  com.esri.arcgis.carto.IMSGlobeXMLNode

All Implemented Interfaces:

IIMSGlobeXMLNode, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class IMSGlobeXMLNode
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IIMSGlobeXMLNode

IMS Globe Sub Service.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

IMSGlobeXMLNode()
Constructs a IMSGlobeXMLNode using ArcGIS Engine.

IMSGlobeXMLNode(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
IMSGlobeXMLNode theIMSGlobeXMLNode = (IMSGlobeXMLNode) obj;

Method Summary

int	addBlankAttrib() Adds a blank attribute to the list of attributes.
void	addChild(IIMSGlobeXMLNode node) Adds a child node to the end of the list.
int	addFullAttrib(String name, String value) Add an attibute to the node.
void	deleteChild(int num) Deletes a child at position.
boolean	equals(Object o) Compare this object with another
String	getAttribName(int pos) The attribute number i's name.
String	getAttribValueByIndex(int pos) The attribute number i's value.
String	getAttribValueByName(String name) The attribute value by name.
IIMSGlobeXMLNode	getChildByAttribNameValue(String attribName, String atttribValue) The node for which the specified attrib is present and equal to value: if value is null then the first node with name is returned.
IIMSGlobeXMLNode	getChildByIndex(int i) The reference to the child at pos i.
IIMSGlobeXMLNode	getChildByName(String tagName) The reference to the child based on its tag name.
static String	getClsid() getClsid.
IIMSGlobeXMLNode	getDeepClone() Makes a copy of input -- including children.
IIMSGlobeXMLNode	getHighestNode(String searchString) Traverses the tree to find the highest node in the tree that matched the searchString.
int	getNumAttrib() The number of attributes for this node.
int	getNumChildren() The number of children nodes.
IIMSGlobeXMLNode	getShallowClone() Makes a copy of input -- except children.
String	getXmlTag() The tag of this node.
int	hashCode() the hashcode for this object
String	makeXmlStr() Outputs an xml string representation of the internal node representation.
void	parse(String xmlStrOrig) Parse the nodes from an input string.
void	setAttribName(int pos, String name) The attribute number i's name.
void	setAttribValueByIndex(int pos, String value) The attribute number i's value.
void	setAttribValueByName(String name, String value) The attribute value by name.
void	setXmlTag(String tag) The tag of this node.

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

IMSGlobeXMLNode

public IMSGlobeXMLNode()
                throws IOException,
                       UnknownHostException

Constructs a IMSGlobeXMLNode using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

IMSGlobeXMLNode

public IMSGlobeXMLNode(Object obj)
                throws IOException

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

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

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

getNumChildren

public int getNumChildren()
                   throws IOException,
                          AutomationException

The number of children nodes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNumChildren in interface IIMSGlobeXMLNode

Returns:

The num

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXmlTag

public String getXmlTag()
                 throws IOException,
                        AutomationException

The tag of this node.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getXmlTag in interface IIMSGlobeXMLNode

Returns:

The tag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumAttrib

public int getNumAttrib()
                 throws IOException,
                        AutomationException

The number of attributes for this node.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNumAttrib in interface IIMSGlobeXMLNode

Returns:

The num

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildByIndex

public IIMSGlobeXMLNode getChildByIndex(int i)
                                 throws IOException,
                                        AutomationException

The reference to the child at pos i.

Product Availability

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

Specified by:

getChildByIndex in interface IIMSGlobeXMLNode

Parameters:

i - The i (in)

Returns:

A reference to a com.esri.arcgis.carto.IIMSGlobeXMLNode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildByName

public IIMSGlobeXMLNode getChildByName(String tagName)
                                throws IOException,
                                       AutomationException

The reference to the child based on its tag name.

Product Availability

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

Specified by:

getChildByName in interface IIMSGlobeXMLNode

Parameters:

tagName - The tagName (in)

Returns:

A reference to a com.esri.arcgis.carto.IIMSGlobeXMLNode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttribName

public String getAttribName(int pos)
                     throws IOException,
                            AutomationException

The attribute number i's name.

Product Availability

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

Specified by:

getAttribName in interface IIMSGlobeXMLNode

Parameters:

pos - The pos (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttribValueByIndex

public String getAttribValueByIndex(int pos)
                             throws IOException,
                                    AutomationException

The attribute number i's value.

Product Availability

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

Specified by:

getAttribValueByIndex in interface IIMSGlobeXMLNode

Parameters:

pos - The pos (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttribValueByIndex

public void setAttribValueByIndex(int pos,
                                  String value)
                           throws IOException,
                                  AutomationException

The attribute number i's value.

Product Availability

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

Specified by:

setAttribValueByIndex in interface IIMSGlobeXMLNode

Parameters:

pos - The pos (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addChild

public void addChild(IIMSGlobeXMLNode node)
              throws IOException,
                     AutomationException

Adds a child node to the end of the list.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addChild in interface IIMSGlobeXMLNode

Parameters:

node - A reference to a com.esri.arcgis.carto.IIMSGlobeXMLNode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addBlankAttrib

public int addBlankAttrib()
                   throws IOException,
                          AutomationException

Adds a blank attribute to the list of attributes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addBlankAttrib in interface IIMSGlobeXMLNode

Returns:

The num

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteChild

public void deleteChild(int num)
                 throws IOException,
                        AutomationException

Deletes a child at position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteChild in interface IIMSGlobeXMLNode

Parameters:

num - The num (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttribName

public void setAttribName(int pos,
                          String name)
                   throws IOException,
                          AutomationException

The attribute number i's name.

Product Availability

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

Specified by:

setAttribName in interface IIMSGlobeXMLNode

Parameters:

pos - The pos (in)

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttribValueByName

public void setAttribValueByName(String name,
                                 String value)
                          throws IOException,
                                 AutomationException

The attribute value by name.

Product Availability

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

Specified by:

setAttribValueByName in interface IIMSGlobeXMLNode

Parameters:

name - The name (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXmlTag

public void setXmlTag(String tag)
               throws IOException,
                      AutomationException

The tag of this node.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setXmlTag in interface IIMSGlobeXMLNode

Parameters:

tag - The tag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShallowClone

public IIMSGlobeXMLNode getShallowClone()
                                 throws IOException,
                                        AutomationException

Makes a copy of input -- except children.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getShallowClone in interface IIMSGlobeXMLNode

Returns:

A reference to a com.esri.arcgis.carto.IIMSGlobeXMLNode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDeepClone

public IIMSGlobeXMLNode getDeepClone()
                              throws IOException,
                                     AutomationException

Makes a copy of input -- including children.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDeepClone in interface IIMSGlobeXMLNode

Returns:

A reference to a com.esri.arcgis.carto.IIMSGlobeXMLNode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

parse

public void parse(String xmlStrOrig)
           throws IOException,
                  AutomationException

Parse the nodes from an input string.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

parse in interface IIMSGlobeXMLNode

Parameters:

xmlStrOrig - The xmlStrOrig (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

makeXmlStr

public String makeXmlStr()
                  throws IOException,
                         AutomationException

Outputs an xml string representation of the internal node representation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

makeXmlStr in interface IIMSGlobeXMLNode

Returns:

The xmlStr

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFullAttrib

public int addFullAttrib(String name,
                         String value)
                  throws IOException,
                         AutomationException

Add an attibute to the node.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addFullAttrib in interface IIMSGlobeXMLNode

Parameters:

name - The name (in)

value - The value (in)

Returns:

The pos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttribValueByName

public String getAttribValueByName(String name)
                            throws IOException,
                                   AutomationException

The attribute value by name.

Product Availability

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

Specified by:

getAttribValueByName in interface IIMSGlobeXMLNode

Parameters:

name - The name (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildByAttribNameValue

public IIMSGlobeXMLNode getChildByAttribNameValue(String attribName,
                                                  String atttribValue)
                                           throws IOException,
                                                  AutomationException

The node for which the specified attrib is present and equal to value: if value is null then the first node with name is returned.

Product Availability

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

Specified by:

getChildByAttribNameValue in interface IIMSGlobeXMLNode

Parameters:

attribName - The attribName (in)

atttribValue - The atttribValue (in)

Returns:

A reference to a com.esri.arcgis.carto.IIMSGlobeXMLNode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHighestNode

public IIMSGlobeXMLNode getHighestNode(String searchString)
                                throws IOException,
                                       AutomationException

Traverses the tree to find the highest node in the tree that matched the searchString.

Product Availability

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

Specified by:

getHighestNode in interface IIMSGlobeXMLNode

Parameters:

searchString - The searchString (in)

Returns:

A reference to a com.esri.arcgis.carto.IIMSGlobeXMLNode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.