Home > Articles

  • Print
  • + Share This
This chapter is from the book

This chapter is from the book

Parsing with the Document Object Model (DOM)

There is another approach to parsing XML documents called the Document Object Model (DOM) approach. This API produces an in-memory treelike version of the XML document, as well as a number of methods for traversing the model and obtaining the data stored in it.

There are many nice things about the DOM approach from a processing point of view. The first is that it is more intuitive than the SAX approach. As object-oriented programmers, we like being given an object structure. In addition, we can make changes to this model and persist these changes back to the XML document as output. SAX 2.0 allows this as well. This opens a world of possibilities where you can use the XML document as a sort of database.

Following the same approach that we used with SAX, we will show an example and then explain the whys and what fors of the code.

We will solve the same problem with DOM as we did with SAX—translating an XML document into an object. The code for this example is shown in Listing 3.4. The DOM approach creates a treelike structure in memory representing the XML document.

Listing 3.4 The Document Object Model Approach

/*
 * TicketRequestDOMParser.java
 *
 * Created on January 19, 2002, 5:33 PM
 */

package unleashed.ch3;

import unleashed.TicketRequest2;
import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.parsers.FactoryConfigurationError;
import javax.xml.parsers.ParserConfigurationException;

import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;

import java.io.*;

import org.w3c.dom.Document;
import org.w3c.dom.DOMException;
import org.w3c.dom.Node;
import org.w3c.dom.*;

/**
 *
 * @author Stephen Potts
 * @version
 */
public class TicketRequestDOMParser
{
  static Document document;
  TicketRequest2 tr2;
  String eleName;
  
   
   public TicketRequestDOMParser()
   {
     DocumentBuilderFactory factory =
        DocumentBuilderFactory.newInstance();
     try
     {
       tr2 = new TicketRequest2();
       DocumentBuilder builder = factory.newDocumentBuilder();
       document = builder.parse( new File(
       "C:/unleashed/ch3/ticketRequest.xml"));
       traverse(document);
     }catch (SAXException sxe)
     {
       Exception e = sxe;
       if (sxe.getException() != null)
         e = sxe.getException();
       e.printStackTrace();
     }
     catch (ParserConfigurationException pce)
     {
       pce.printStackTrace();
     }
     catch (IOException ioe)
     {
       ioe.printStackTrace();
     }
   }
   
   private void traverse(Node cNode)
   {
     switch (cNode.getNodeType() )
     {
       case Node.DOCUMENT_NODE:
         System.out.println("Element " + cNode.getNodeName());
         processChildren( cNode.getChildNodes());
         break;
         
       case Node.ELEMENT_NODE:
         eleName = cNode.getNodeName();
         System.out.println("Element " + eleName);
         NamedNodeMap attributeMap = cNode.getAttributes();
         int numAttrs = attributeMap.getLength();
         for (int i=0; i<attributeMap.getLength(); i++)
         {
           Attr attribute = (Attr)attributeMap.item(i);
           String attrName = attribute.getNodeName();
           String attrValue = attribute.getNodeValue();
           storeElementValue(attrName, attrValue);
         }
         if (eleName.equals("isCommissionable"))
         {
           storeElementValue("isCommissionable", "");
         }
         
         processChildren( cNode.getChildNodes());
         break;
       case Node.CDATA_SECTION_NODE:
       case Node.TEXT_NODE:
         
         System.out.println("Text " + cNode.getNodeValue());
         if (! cNode.getNodeValue().trim().equals(""))
         {
           System.out.println("eleName " + eleName);
           System.out.println("Text " + cNode.getNodeValue());
           storeElementValue(eleName, cNode.getNodeValue());
         }
         break;
     }
   }
   
   private void processChildren(NodeList nList)
   {
     if(nList.getLength() != 0)
     {
       for (int i=0; i<nList.getLength(); i++)
         traverse(nList.item(i));
     }
   }
   
   
   private void storeElementValue(String elementName,
                   String elementValue)
   {
     if (elementName.equals("ticketRequest"))
     {
     }
     
     if (elementName.equals("custID"))
     {
       tr2.setCustID(Integer.parseInt(elementValue));
     }
     
     if (elementName.equals("lastName"))
     {
       tr2.setLastName(elementValue);
     }
     
     if (elementName.equals("firstName"))
     {
       tr2.setFirstName(elementValue);
     }
     
     if (elementName.equals("cruiseID"))
     {
       tr2.setCruiseID(Integer.parseInt(elementValue));
     }
     
     if (elementName.equals("destination"))
     {
       tr2.setDestination(elementValue);
     }
     
     if (elementName.equals("port"))
     {
       tr2.setPort(elementValue);
     }
     
     if (elementName.equals("sailing"))
     {
       tr2.setSailing(elementValue);
     }
     
     if (elementName.equals("numberOfTickets"))
     {
       String numberOfTicketsString = elementValue;
       int numberOfTickets = 
          Integer.parseInt(numberOfTicketsString);
       tr2.setNumberOfTickets(numberOfTickets);
     }
     
     if (elementName.equals("isCommissionable"))
     {
       tr2.setCommissionable(true);
     }
   }
   
   public String toString()
   {
     return tr2.toString();
   }
   
   
   public static void main(String args[])
   {
     TicketRequestDOMParser tp = new TicketRequestDOMParser();
     System.out.println(tp);
   }
   
}

This program contains quite a few lines that require some explanation.

There are three main variables in this program:

  static Document document;
  TicketRequest2 tr2;
  String eleName;

The stars of the show are the document object, which holds the DOM structure; the eleName, which contains the name of whatever element we are working on at the moment; and the TicketRequest2, which is the product of our efforts.

The good news about DOM is that tree building is automatic. All that you have to do is create a factory, which creates a builder. The builder's parse method is called, which translates the XML document into the DOM tree.

DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
tr2 = new TicketRequest2();
DocumentBuilder builder = factory.newDocumentBuilder();
document = builder.parse(
  new File("C:/projects/sampledir/unleashed/ch3/ticketRequest.xml"));

Once we have created a DOM tree, we call the traverse() method and pass the document into it:

traverse(document);

The traverse() method is a big switch statement that contains three main cases: document, element, and text. Whenever an element is encountered, its attributes are processed with the following code:

          Attr attribute = (Attr)attributeMap.item(i);
           String attrName = attribute.getNodeName();
           String attrValue = attribute.getNodeValue();
           storeElementValue(attrName, attrValue);

The isCommissionable switch requires special treatment because it has no value. Because it is a flag, its presence alone tells you that the boolean needs to be set to true.

         if (eleName.equals("isCommissionable"))
         {
           storeElementValue("isCommissionable", "");
         }

Whenever we find either an attribute or element text that corresponds to a field in our object, we make a call and pass in two strings:

           storeElementValue(eleName, cNode.getNodeValue());

Because some nodes contain other nodes, we have to process our tree recursively. The processChildren() method takes in the children of a node in a list. It tests to see whether any children really do exist. If so, it calls the traverse() method on that branch of the tree:

   private void processChildren(NodeList nList)
   {
     if(nList.getLength() != 0)
     {
       for (int i=0; i<nList.getLength(); i++)
         traverse(nList.item(i));
     }
   }

The main method of this program is very simple. It instantiates the object and prints the result:

  TicketRequestDOMParser tp = new TicketRequestDOMParser();
     System.out.println(tp);

The result of running this example is shown here:

------------------------------------------------
custID = 10003
lastName = Carter
firstName = Joseph
------------------------------------------------
cruiseID = 3004
destination = Hawaii
port = Honolulu
sailing = 7/7/2001
numberOfTickets = 5
isCommissionable = true
------------------------------------------------

Prior to seeing this output, you will see some tracing information to show you some of the program flow. (It is not shown here.) The TicketRequest object is shown via its toString() method.

You can see from this that it is a relatively straightforward process to transform an XML file into a Java object. Once you have a Java object in your program, you are back in familiar territory.

How do we move XML documents between servers to support distributed computing? That is the topic of the next section.

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020