Inheritance diagram

Collaboration diagram

Description

The DOM parser(SFXXMLDOMParser) converts an XML document into a tree called "the DOM tree", where any data of the XML document can be obtained flexibly regardless of its order.

	Document Object Model (DOM) Specification
	W3C DOM level 1 recommendation: Document Object Model (DOM) Level 1 Specification )

//XML document to be parsed ( file.xml )
<fruit>
    <name language="english" code="ascii">apple</name>
    <size>XS</size>
    <color>red</color>
</fruit>

SFCError error;             // error value
SFXXMLDOMParser parser;     // DOM parser
SFXAnsiString resultString; // variable to store string obtained from XML document

// parse XML document stored in file.xml 
if ((error = parser.Parse(SFXPath("/file.xml"))) == SFERR_NO_ERROR) {

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

    // get first child node of root node(root element of XML document: "fruit" element)
    SFXXMLNodePtr child = root->GetFirstChild();  
    
    // get first child node of "fruit" node, i.e., "name" node)
    child = child->GetFirstChild();   

    // if name of child node is "name"
    if (SFXAnsiString("name").Equals(child->GetNodeName())) {

        // cast SFXXMLNodePtr into SFXXMLElementPtr to get attribute value of this node
 SFXXMLElementPtr element = static_cast<SFXXMLElementPtr>(child);

        // get value of "language" attribute
        // resultString is "english"
        resultString = element->GetAttribute("language");

        // get Attribute node which name is "language"
 SFXXMLAttributePtr attr = element->GetAttributeNode("language");
        
        // get value of this Attribute node
        resultString = attr->GetNodeValue();
        
        // get all Attribute nodes
 SFXXMLNode::DOMNamedNodeMapPtr nodeMap = element->GetAttributes();

        // get Attribute node which name is "code"
        attr = static_cast<SFXXMLAttributePtr>(nodeMap->GetNamedItem("code"));

        // get value of this Attribute node
        resultString = attr->GetNodeValue();
    }
}

Reference

SFXXMLSAXParser | SFXXMLDefaultHandler

Members

Reference

SFXXMLDOMParser::SetCreateCommentNodes

Reference

SFXXMLDOMParser::SetDoIndent

Reference

SFXXMLDOMParser::SetDoNamespaces

Reference

SFXXMLDOMParser::SetDoSchema

Description

The Document node is the root node of the DOM tree.

Reference

SFXXMLDOMParser::GetFirstChildElementNS | SFXXMLDOMParser::GetNextSiblingElement | SFXXMLDOMParser::GetNextSiblingElementNS

Description

	Note
	The Element node needs to match one of the element names(local name) specified with the "elemNames" argument.

Reference

SFXXMLDOMParser::GetFirstChildElement | SFXXMLDOMParser::GetNextSiblingElement | SFXXMLDOMParser::GetNextSiblingElementNS

Reference

SFXXMLDOMParser::SetIgnoreAnnotations

Reference

SFXXMLDOMParser::SetLoadExternalDTD

Reference

SFXXMLDOMParser::GetNextSiblingElementNS | SFXXMLDOMParser::GetFirstChildElement | SFXXMLDOMParser::GetFirstChildElementNS

Reference

SFXXMLDOMParser::GetNextSiblingElement | SFXXMLDOMParser::GetFirstChildElement | SFXXMLDOMParser::GetFirstChildElementNS

Reference

SFXXMLDOMParser::SetValidationDTD

Reference

SFXXMLDOMParser::SetValidationSchema

Return value

The error codes that may occur when parsing the XML document are as follows:

The error codes that may occur when parsing the XML document with DTD are as follows:

The error codes that may occur when parsing the XML document with Schema are as follows:

Reference: SFCErrorEnum

Description

The SFXXMLDOMParser::Parse function is to read and parse the specified XML document using the DOM parser. The argument can be an input stream, file name (of file path type), or string. The default directory of the file path is the home directory of application.

Reference

SFCErrorEnum

Reference

SFXXMLDOMParser::GetCreateCommentNodes

Reference

SFXXMLDOMParser::GetDoIndent

Reference

SFXXMLDOMParser::GetDoNamespaces

Reference

SFXXMLDOMParser::GetDoSchema

Reference

SFXXMLDOMParser::GetIgnoreAnnotations

Reference

SFXXMLDOMParser::GetLoadExternalDTD

Example

// XML document to be parsed ("file.xml")
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE Mail SYSTEM "personal.dtd">
<Mail>
  <From>&name;</From>
  <To>Receiver</To>
  <Cc>&Email;</Cc>
  <Date> Thu, 7 Oct 1999 11:15:16 -0600</Date>
  <Subject>XML Introduction</Subject>
  <Body>Comments:<P align = "right">Thanks for reading<br/>this article</P>
    <br/>
    <P>Hope you enjoyed this article</P>
    <P>&copyright;</P>
  </Body>
</Mail>

// DTD file for validation ("personal.dtd")
<?xml encoding="ISO-8859-1"?>

<!-- @version: 10.1-->

<!ELEMENT Mail (From, To, Cc?, Date?, Subject, Body)>
<!ELEMENT From (#PCDATA)>
<!ELEMENT To (#PCDATA)>
<!ELEMENT Cc (#PCDATA)>
<!ELEMENT Date (#PCDATA)>
<!ELEMENT Subject (#PCDATA)>
<!ELEMENT Body (#PCDATA | P | Br)*>
<!ELEMENT P (#PCDATA | br)*>
<!ATTLIST P align (left | right | justify) "left">
<!ELEMENT br EMPTY>
<!ENTITY  name "sophia">
<!ENTITY  Email "&name;@s-cradle.com">
<!ENTITY  copyright "Copyright (C) 2002 - 2024 Sophia Cradle Incorporated.">

// parse the XML document with DTD
SFXXMLDOMParser parser;
SFCError error;

// set grammar type to parse XML document with DTD
parser.SetGrammar(SFXXMLGrammar::GRAMMAR_DTD);

// set to validate XML document with DTD
parser.SetValidationDTD(true);

// set to load external DTD
parser.SetLoadExternalDTD(true);

// parse XML document with DTD using DOM parser
error = parser.Parse(SFXPath("/file.xml"));

if (error == SFERR_NO_ERROR) {
    // get root node of DOM tree
    SFXXMLDocumentPtr root = parser.GetDocument();

    // get DocumentType node
    SFXXMLDocumentTypePtr documentType = root->GetDocumentType();

    // get system identifier of external DTD subset
    // the id variable will be "personal.dtd"
    SFXAnsiString id = documentType->GetSystemID();

    // get Entity nodes defined in DTD as DOMNamedNodeMap
    SFXXMLNode::DOMNamedNodeMapPtr entitymap = documentType->GetEntities();

    // get value of the "name" entity
    // the name variable will be "sophia"
    SFXAnsiString name = SFXXMLEntityPtr(entitymap->GetNamedItem("name"))->GetValue();
}

Reference

SFXXMLDOMParser::GetValidationDTD

Example

SFXXMLDOMParser parser;

// set to to create comment nodes
parser.SetCreateCommentNodes(true);

// set to namespaces
parser.SetDoNamespaces(true);

// set grammar type to parse XML document with XML Schema
parser.SetGrammar(SFXXMLGrammar::GRAMMAR_SCHEMA);

// set to process XML Schema
parser.SetDoSchema(true);

// set XSD file for XML document with XML Schema
// (default directory: home directory of application)
parser.SetSchemaLocation("schema.xsd");

// set to validate XML document with XML Schema
parser.SetValidationSchema(true);

// set to ignore annotations
parser.SetIgnoreAnnotations(false);

// parse XML document with XML Schema using DOM parser
error = parser.Parse(SFXPath("/file.xml"));

Reference

SFXXMLDOMParser::GetValidationSchema