Class XMLParameterTree

Object
   |
   +--XMLParameterTree

class XMLParameterTree

This class is used to interpret the received XML parameter information. The information is translated into a HTML tree structure that gives the user a graphical representation of the invocation parameters.


Field Summary
 var invocation
          
 var reply
          
 var tree
          
 var valid
          
 var xml
          
 
Constructor Summary
XMLParameterTree (html_tree, xml_doc)
           
 
Method Summary
 function any(dom_node, tree_node)
           Updates the HTML tree with any parameter information.
 function array(dom_node, tree_node)
           Updates the HTML tree with array parameter information.
 function data(dom_node, tree_node)
           Updates the HTML tree with simple parameter type information.
 function direction(dom_node, tree_node)
           Updates the HTML tree with directional information.
 function enumeration(dom_node, tree_node)
           Updates the HTML tree with enum parameter information.
 function exception(dom_node, tree_node)
           Updates the HTML tree with exception parameter information.
 function firstChildElement(node)
           This routine returns the first DOM child node of type 'element'.
 function interface(dom_node, tree_node)
           Updates the HTML tree with interface parameter information.
 function member(dom_node, tree_node)
           Updates the HTML tree with member parameter information.
 function sequence(dom_node, tree_node)
           Updates the HTML tree with sequence parameter information.
 function struct(dom_node, tree_node)
           Updates the HTML tree with struct parameter information.
 function union(dom_node, tree_node)
           Updates the HTML tree with union parameter information.
 function update()
           This routine is called to update the HTML parameter tree.
 function updateTree(dom_node, tree_node)
           This routine acts as a switch statement to test for all possible parameter types that must be handled.
 function valuetype(dom_node, tree_node)
           Updates the HTML tree with valuetype parameter information.
 function walk(dom_node, tree_node)
           This routine walks through a given DOM fragment looking for nodes of type 'element'.

Field Detail

invocation

var invocation

reply

var reply

tree

var tree

valid

var valid

xml

var xml

Constructor Detail

XMLParameterTree

function XMLParameterTree(html_tree, xml_doc)

Parameters:
html_tree - HTML tree object where the parameter information is placed into.

xml_doc - Contains the parser XML parameter information.

Method Detail

any

function any(dom_node, tree_node)
Updates the HTML tree with any parameter information.

Parameters:
dom_node - DOM fragment to examine.

tree_node - The parameter information will be added as a child to this HTML tree node.


array

function array(dom_node, tree_node)
Updates the HTML tree with array parameter information.

Parameters:
dom_node - DOM fragment to examine.

tree_node - The parameter information will be added as a child to this HTML tree node.


data

function data(dom_node, tree_node)
Updates the HTML tree with simple parameter type information.

Parameters:
dom_node - DOM fragment to examine.

tree_node - The parameter information will be added as a child to this HTML tree node.


direction

function direction(dom_node, tree_node)
Updates the HTML tree with directional information.

Parameters:
dom_node - DOM fragment to examine.

tree_node - The parameter information will be added as a child to this HTML tree node.


enumeration

function enumeration(dom_node, tree_node)
Updates the HTML tree with enum parameter information.

Parameters:
dom_node - DOM fragment to examine.

tree_node - The parameter information will be added as a child to this HTML tree node.


exception

function exception(dom_node, tree_node)
Updates the HTML tree with exception parameter information.

Parameters:
dom_node - DOM fragment to examine.

tree_node - The parameter information will be added as a child to this HTML tree node.


firstChildElement

function firstChildElement(node)
This routine returns the first DOM child node of type 'element'.

Parameters:
node - DOM node to examine.

Returns:
The first child element of type 'element'. null if not present.

interface

function interface(dom_node, tree_node)
Updates the HTML tree with interface parameter information.

Parameters:
dom_node - DOM fragment to examine.

tree_node - The parameter information will be added as a child to this HTML tree node.


member

function member(dom_node, tree_node)
Updates the HTML tree with member parameter information.

Parameters:
dom_node - DOM fragment to examine.

tree_node - The parameter information will be added as a child to this HTML tree node.


sequence

function sequence(dom_node, tree_node)
Updates the HTML tree with sequence parameter information.

Parameters:
dom_node - DOM fragment to examine.

tree_node - The parameter information will be added as a child to this HTML tree node.


struct

function struct(dom_node, tree_node)
Updates the HTML tree with struct parameter information.

Parameters:
dom_node - DOM fragment to examine.

tree_node - The parameter information will be added as a child to this HTML tree node.


union

function union(dom_node, tree_node)
Updates the HTML tree with union parameter information.

Parameters:
dom_node - DOM fragment to examine.

tree_node - The parameter information will be added as a child to this HTML tree node.


update

function update()
This routine is called to update the HTML parameter tree. It is called by the SVGController.operationComplete routine upon reception of the parameter information from the server.


updateTree

function updateTree(dom_node, tree_node)
This routine acts as a switch statement to test for all possible parameter types that must be handled. If it finds a known parameter type, a corresponding routine will update the HTML tree for that particular type.

Parameters:
dom_node - DOM fragment to examine.

tree_node - The parameter information will be added as a child to this HTML tree node.


valuetype

function valuetype(dom_node, tree_node)
Updates the HTML tree with valuetype parameter information.

Parameters:
dom_node - DOM fragment to examine.

tree_node - The parameter information will be added as a child to this HTML tree node.


walk

function walk(dom_node, tree_node)
This routine walks through a given DOM fragment looking for nodes of type 'element'. When an 'element' type is found it calls the updateTree routine.

Parameters:
dom_node - DOM fragment to examine.

tree_node - Argument to pass on to the updateTree routine.