com.esri.arcgis.carto
Interface IIMSGlobeXMLNode

All Superinterfaces:
Serializable
All Known Implementing Classes:
IMSGlobeXMLNode

public interface IIMSGlobeXMLNode
extends Serializable

Provides access to an XML node.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


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.
 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.
 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.
 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.
 

Method Detail

getNumChildren

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

Returns:
The num
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getXmlTag

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

Returns:
The tag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumAttrib

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

Returns:
The num
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getChildByIndex

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.

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

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.

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

String getAttribName(int pos)
                     throws IOException,
                            AutomationException
The attribute number i's name.

Product Availability

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

Parameters:
pos - The pos (in)
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAttribValueByIndex

String getAttribValueByIndex(int pos)
                             throws IOException,
                                    AutomationException
The attribute number i's value.

Product Availability

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

Parameters:
pos - The pos (in)
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAttribValueByIndex

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.

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

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

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

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

Returns:
The num
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteChild

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

Parameters:
num - The num (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAttribName

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.

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

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.

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

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

Parameters:
tag - The tag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShallowClone

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

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

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

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

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

Parameters:
xmlStrOrig - The xmlStrOrig (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

makeXmlStr

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

Returns:
The xmlStr
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addFullAttrib

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

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

String getAttribValueByName(String name)
                            throws IOException,
                                   AutomationException
The attribute value by name.

Product Availability

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

Parameters:
name - The name (in)
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getChildByAttribNameValue

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.

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

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.

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.