Inheritance diagram

Description

In SophiaFramework, process the XML document by constructing the DOM tree using the following 12 classes for the 12 types of nodes defined in W3C ( World Wide Web Consortium ), which inherit from the SFXXMLNode class.

	Note
	The values of nodeType, nodeName, nodeValue attributes can be obtained by the SFXXMLNode::GetNodeType, SFXXMLNode::GetNodeName, SFXXMLNode::GetNodeValue functions respectively.

	Note
	The attributes is valid only for the Element node, and can be obtained by the SFXXMLElement::GetAttributes function.

	Document Object Model (DOM) Specification
	W3C DOM Level 2 Specification: Document Object Model (DOM) Level 2 Core Specification

Reference

SFXXMLAttribute | SFXXMLCDATASection | SFXXMLComment | SFXXMLDocument | SFXXMLDocumentFragment | SFXXMLDocumentType | SFXXMLElement | SFXXMLEntity | SFXXMLEntityReference | SFXXMLNode | SFXXMLNotation | SFXXMLProcessingInstruction | SFXXMLText

Member

Return value

Return SFERR_UNSUPPORTED.

Reference

SFXXMLNode::RemoveChild | SFXXMLNode::ReplaceChild | SFXXMLNode::CloneNode | SFXXMLNode::InsertBefore

Return value

Return SFERR_UNSUPPORTED.

Reference

SFXXMLNode::RemoveChild | SFXXMLNode::ReplaceChild | SFXXMLNode::AppendChild | SFXXMLNode::InsertBefore

Return value

Description

The SFXXMLNode::EqualNode function check not the node identity(whether or not the reference to the node is same) but the node equality(whether or not the content of the node is same).

To check the node identity, use the SFXXMLNode::IsSameNode method.

Reference

SFXXMLNode::IsSameNode

Return value

Return null.

Description

Get a pointer to the SFXXMLNode::DOMNodeList instance that contains all child nodes of this node.

	Note
	Each element of SFXXMLNode::DOMNodeList is of the "pointer to the SFXXMLNode" type.

Reference

SFXXMLNode::DOMNodeList | SFXXMLNode::GetFirstChild | SFXXMLNode::GetLastChild | SFXXMLNode::GetNextSibling | SFXXMLNode::GetParentNode | SFXXMLNode::GetPreviousSibling

Return value

Return null.

Reference

SFXXMLNode::GetLastChild | SFXXMLNode::GetChildNodes | SFXXMLNode::GetNextSibling | SFXXMLNode::GetPreviousSibling | SFXXMLNode::GetParentNode

Return value

Return null.

Reference

SFXXMLNode::GetFirstChild | SFXXMLNode::GetChildNodes | SFXXMLNode::GetNextSibling | SFXXMLNode::GetPreviousSibling | SFXXMLNode::GetParentNode

Return value

Return null.

Reference

SFXXMLNode::GetPreviousSibling | SFXXMLNode::GetFirstChild | SFXXMLNode::GetLastChild | SFXXMLNode::GetChildNodes | SFXXMLNode::GetParentNode

Return value

Return null.

Description

	Node Name
	The node name is the value of nodeName attribute and differs depending on the node type. e.g. In case of an Element node (nodeType == ELEMENT_NODE), the tag name is returned. In case of a Text node (nodeType == TEXT_NODE), null is returned.

Return value

Return UNKNOWN_NODE.

Description

Node Type

The node type is the value of nodeType attribute and differs depending on the node type. And it is the same as NodeType defined in the W3C DOM Level1 Specification (www.w3.org/tr/1998/REC-DOM-Level-1-19981001/level-one-core.html) as below. Integer value Node type 1 ELEMENT_NODE 2 ATTRIBUTE_NODE 3 TEXT_NODE 4 CDATA_SECTION_NODE 5 ENTITY_REFERENCE_NODE 6 ENTITY_NODE 7 PROCESSING_INSTRUCTION_NODE 8 COMMENT_NODE 9 DOCUMENT_NODE 10 DOCUMENT_TYPE_NODE 11 DOCUMENT_FRAGMENT_NODE 12 NOTATION_NODE -1 UNKNOWN_NODE

Reference

SFXXMLNode::NodeType

Return value

Return null.

Description

	Node Value
	The node value is the value of nodeValue attribute and differs depending on the node type. e.g. In case of a Text node (nodeType == TEXT_NODE), the text of the node is returned. In case of an Element node (nodeType == ELEMENT_NODE), null is returned.

Reference

SFXXMLNode::SetNodeValue

Return value

Return null.

Description

If the node has no parent node, null is returned. (e.g. a node that does not belong to the DOM tree)

All the nodes except the Attribute, Document, DocumentFragment, Entity and Notation nodes always have the parent node.

Reference

SFXXMLNode::GetFirstChild | SFXXMLNode::GetLastChild | SFXXMLNode::GetChildNodes | SFXXMLNode::GetNextSibling | SFXXMLNode::GetPreviousSibling

Return value

Return null.

Reference

SFXXMLNode::GetNextSibling | SFXXMLNode::GetFirstChild | SFXXMLNode::GetLastChild | SFXXMLNode::GetChildNodes | SFXXMLNode::GetParentNode

Description

Return value differs depending on the node type.

	Note
	The node text does not contain any markup, and white spaces are not normalized.

Reference

SFXXMLNode::SetText

Return value

Retrun false.

Return value

Return SFERR_UNSUPPORTED.

Description

Insert the newchild node before the refchild node. If the refchild argument is specified as null, append the newchild node as the last child node.

When the newchild node is the DocumentFragment node, all the child nodes of the newchild node are inserted in the same order before the refchild node.

When the newchild node has already existed in the DOM tree, it is removed before insertion.

Reference

SFXXMLNode::RemoveChild | SFXXMLNode::ReplaceChild | SFXXMLNode::CloneNode | SFXXMLNode::AppendChild

Return value

Description

Chech whether the two nodes refer to the same node or not.

Reference

SFXXMLNode::EqualNode

Return value

Return SFERR_UNSUPPORTED.

Reference

SFXXMLNode::AppendChild | SFXXMLNode::ReplaceChild | SFXXMLNode::CloneNode | SFXXMLNode::InsertBefore

Return value

Return SFERR_UNSUPPORTED.

Reference

SFXXMLNode::AppendChild | SFXXMLNode::RemoveChild | SFXXMLNode::CloneNode | SFXXMLNode::InsertBefore

Reference

SFXXMLNode::GetNodeValue

Return value

Description

The behaviour of SFXXMLNode::SetText function differs depending on the node type.

Reference

SFXXMLNode::GetText

Description

The SFXXMLNode::DOMNamedNodeMap class for managing the DOM nodes provides the function to obtain a node by name(the nodeName attribute value).

Though no order relation exists among the nodes stored in the map(instance of SFXXMLNode::DOMNamedNodeMap class), a node can be obtained by index.

The following functions are available for the SFXXMLNode::DOMNamedNodeMap class.

Example

// XML document to be parsed ("apple.xml")
<fruit>
    <name made="japan" date="2007-06-20" size="XS">apple</name>
</fruit>

Sample code using SFXXMLNode::DOMNamedNodeMap class.

SFCError error;             // error value
SFXXMLDOMParser parser;     // DOM parser
SFXAnsiString resultString; // variable to store node value of Attribute node

// parse "apple.xml" document 
if ((error = parser.Parse("/apple.xml")) == SFERR_NO_ERROR) {

    // get root of DOM tree
    SFXXMLDocumentPtr root = parser.GetDocument(); 

    // get root element of xml document(first child node of root of DOM tree. In this case, "fruit" element)
    SFXXMLNodePtr child = root->GetFirstChild(); 

    // get first child element of "fruit" element( "name" element )
    child = child->GetFirstChild(); 

    // get all Attribute nodes of "name" element
    SFXXMLNode::DOMNamedNodeMapPtr nodeMap = SFXXMLElementPtr(child)->GetAttributes();

    //  display number of Attribute nodes in map
    TRACE("%d",nodeMap->GetLength());   // "3" will be displayed

    //  display all attribute values of "name" element
    for (int i = 0; i < nodeMap->GetLength(); i++) {
 SFXXMLNodePtr node = nodeMap->Item(i); // get i-th item(Attribute node) from map by index
        resultString = node->GetNodeValue();   // get node value of i-th item(Attribute node)

        // display the obtained node value
        TRACE("%s",resultString.GetCString()); 
    }
    // "XS", "2007-06-20", and "japan" will be displayed
    
    // get node by name("date ")
    SFXXMLAttributePtr date = static_cast<SFXXMLAttributePtr>(nodeMap->GetNamedItem( "date "));
    resultString = date->GetNodeValue();     // get node value
	
    // display obtained node value
    TRACE("%s",resultString.GetCString());      // "2007-06-20" will be displayed
    
    // delete node specified by name("made")
    SFXXMLNodePtr remove = nodeMap->RemoveNamedItem("made");
    // delete node pointer
    ::delete remove;
	
    //  display all attribute values of "name" element
    for (int i = 0; i < nodeMap->GetLength(); i++) {
 SFXXMLNodePtr node = nodeMap->Item(i); // get i-th item(Attribute node) from map by index
        resultString = node->GetNodeValue();   // get node value of i-th item(Attribute node)

        // display obtained node value
        TRACE("%s",resultString.GetCString()); 
    }
    // "XS" and "2007-06-20" will be displayed
    
    // add specified node to map
    nodeMap->SetNamedItem(root->CreateAttribute("color", "red"));
    
    //  display number of nodes in map
    TRACE("%d",nodeMap->GetLength());   // 3
    
    //  display all attribute values of "name" element
    for (int i = 0; i < nodeMap->GetLength(); i++) {
 SFXXMLNodePtr node = nodeMap->Item(i); // get i-th item(Attribute node) from map by index
        resultString = node->GetNodeValue();   // get node value of i-th item(Attribute node)

        // display obtained node value
        TRACE("%s",resultString.GetCString()); 
    }
    // "XS", "2007-06-20", and "red" will be displayed
}

Reference

SFXXMLNode::DOMNodeList

Description

SFXXMLNode::DOMNodeList is the same as SFXList<SFXXMLNodePtr>. There is an order relation among the nodes of this node list.

Example

// XML document to be parsed ("apple.xml")
<fruit>
  <name>apple</name>
  <size>XS</size>
  <color>red</color>
</fruit>

SFCError error;             // error value
SFXXMLDOMParser parser;     // DOM parser
SFXAnsiString resultString; // variable to store node text

// parse "apple.xml" document 
if ((error = parser.Parse("/apple.xml")) == SFERR_NO_ERROR) {

    // get root of DOM tree
    SFXXMLDocumentPtr root = parser.GetDocument(); 

    // get root element of xml document(first child node of root of DOM tree. In this case, "fruit" element)
    SFXXMLNodePtr child = root->GetFirstChild();   

    // get all child elements of "fruit" element
    SFXXMLNode::DOMNodeListPtr nodeList = child->GetChildNodes();

    // get iterator
    SFXXMLNode::DOMNodeList::Iterator itor = nodeList->GetFirstIterator();   
    
    // display texts of all child elements of "fruit" element
    while (itor.HasNext()) { 
        // get "name" element, "size" element,"color" element sequentially
 SFXXMLNodePtr node = itor.GetNext();

        // get node name
        resultString = node->GetNodeName();

        // get node text
        resultString = node->GetText();
        // display node text(e.g. in case of "name" element, "apple")
        TRACE("%s",resultString.GetCString());
    }
}

Reference

SFXXMLNode::DOMNamedNodeMap