Home > Articles > Programming > Java

XML Processing with Java

Learn how to process XML documents with Java in this sample chapter from Core Web Programming. Larry Brown and Marty Hall show you how to use Java to process XML documents by using the Document Object Model (DOM), the Simple API for XML (SAX), and the Extensible Style sheet Language for Transformations (XSLT).
This sample chapter is excerpted from Core Web Programming, by Larry Brown and Marty Hall.
This chapter is from the book

This chapter is from the book

Topics in This Chapter

  • Representing an entire XML document using the Document Object Model (DOM) Level 2

  • Using DOM to display the outline of an XML document in a JTree

  • Responding to individual XML parsing events with the Simple API for XML Parsing (SAX) 2.0

  • Printing the outline of an XML document using SAX

  • Counting book orders using SAX

  • Transforming XML using XSLT

  • Invoking XSLT through custom JSP tags

  • Hiding vendor-specific details with the Java API for XML Processing (JAXP)

XML is a "meta" markup language used to describe the structure of data.

XML has numerous advantages including being easy to read, easy to parse, extensible, and widely adopted. In addition, you can define a grammar through a Docu_ment Type Definition (DTD) to enforce application-specific syntax. However, the greatest single advantage of XML is that the data can be easily processed by other applications; XML data is not in a proprietary format. In essence, XML has done for data what the Java language has done for programs:

Java = Portable Programs

XML = Portable Data

This chapter doesn't focus on how to write XML but rather how to process XML documents with Java. We show you how to use Java to process XML documents by using the Document Object Model (DOM), the Simple API for XML (SAX), and the Extensible Style sheet Language for Transformations (XSLT). If you are new to XML, here are some good starting points for additional information:

XML 1.0 Specification

http://www.w3.org/TR/REC-xml

Sun Page on XML and Java

http://java.sun.com/xml/

WWW Consortium's Home Page on XML

http://www.w3.org/XML/

Apache XML Project

http://xml.apache.org/

XML Resource Collection

http://xml.coverpages.org/

O'Reilly XML Resource Center

http://www.xml.com/

23.1 Parsing XML Documents with DOM Level 2

The Document Object Model (DOM) represents an entire XML document in a tree-like data structure that can be easily manipulated by a Java program. The advantages of DOM are that it is relatively simple to use and you can modify the data structure in addition to extracting data from it. However, the disadvantage is that DOM parses and stores the entire document, even if you only care about part of it. Section 23.3 (Parsing XML Documents with SAX 2.0) discusses an alternative approach appropriate for cases when you are dealing with very large XML documents but care about only small sections of them.

Installation and Setup

DOM is not a standard part of either Java 2 Standard Edition or the servlet and JSP APIs. So, your first step is to download the appropriate classes and configure them for use in your programs. Here is a summary of what is required.

  1. Download a DOM-compliant parser. The parser provides the Java classes that follow the DOM Level 2 API as specified by the WWW Consortium. You can obtain a list of XML parsers in Java at http://www.xml.com/pub/rg/Java_Parsers. We use the Apache Xerces-J parser in this book. See http://xml.apache.org/xerces-j/. This parser also comes with the complete DOM API in Javadoc format.

  2. Download the Java API for XML Processing (JAXP). This API provides a small layer on top of DOM that lets you plug in different vendor's parsers without making any changes to your basic code. See http://java.sun.com/xml/.

  3. Set your CLASSPATH to include the DOM classes. In the case of Apache Xerces, you need to include xerces_install_dir\ xerces.jar. For example, for desktop applications on Windows you would do

    set CLASSPATH=xerces_install_dir\xerces.jar;%CLASSPATH%

    If you wanted to use DOM from servlets and JSP, you would copy the appropriate JAR file to the server's lib directory (if supported), unpack the JAR file (using jar -xvf) into the server's classes directory, or explicitly change the server's CLASSPATH, usually by modifying the server start-up script.

  4. Set your CLASSPATH to include the JAXP classes. These classes are in jaxp_install_dir/jaxp.jar. For example, on Unix/Linux and the C shell, you would do

    setenv CLASSPATH jaxp_install_dir/jaxp.jar:$CLASSPATH

    For use from servlets and JSP, see the preceding step.

  5. Bookmark the DOM Level 2 and JAXP APIs. The official DOM specification can be found at http://www.w3.org/TR/ DOM-Level-2-Core/, but the API in Javadoc format that comes with Apache Xerces is easier to read and also includes the JAXP and SAX (see Section 23.3) APIs.

  6. Print the JAXP specification for your reference. Download it from http://java.sun.com/xml/jaxp-1_1-spec.pdf.

Parsing

With DOM processing, there are two high-level tasks: turning an XML document into a DOM data structure and looking through that data structure for the data that interests you. The following list summarizes the detailed steps needed to accomplish these tasks.

  1. Tell the system which parser you want to use. This can be done in a number of ways: through the javax.xml.parsers.DocumentBuilderFactory system property, through jre_dir/lib/ jaxp.properties, through the J2EE Services API and the class specified in META-INF/services/javax.xml.parsers.Document1. BuilderFactory, or with a system-dependent default parser. The system property is the easiest method. For example, the following code permits users to specify the parser on the command line with the -D option to java, and uses the Apache Xerces parser otherwise.

    public static void main(String[] args) {
      String jaxpPropertyName =
        "javax.xml.parsers.DocumentBuilderFactory";
      if (System.getProperty(jaxpPropertyName) == null) {
        String apacheXercesPropertyValue =
          "org.apache.xerces.jaxp.DocumentBuilderFactoryImpl";
        System.setProperty(jaxpPropertyName,
                           apacheXercesPropertyValue);
      }
      ...
    }
  2. Create a JAXP document builder. This is basically a wrapper around a specific XML parser.

    DocumentBuilderFactory builderFactory =
      DocumentBuilderFactory.newInstance();
    DocumentBuilder builder =
      builderFactory.newDocumentBuilder();

    Note that you can use the setNamespaceAware and set_Validating methods on the DocumentBuilderFactory to make the parser namespace aware and validating, respectively.

  3. Invoke the parser to create a Document representing an XML document. You invoke the parser by calling the parse method of the document builder, supplying an input stream, URI (represented as a string), or org.xml.sax.InputSource. The Document class represents the parsed result in a tree structure.

    Document document = builder.parse(someInputStream);
  4. Normalize the tree. This means to combine textual nodes that were on multiple lines and to eliminate empty textual nodes.

    document.getDocumentElement().normalize();
  5. Obtain the root node of the tree. This returns an Element, which is a subclass of the more general Node class that represents an XML element.

    Element rootElement = document.getDocumentElement();
  6. Examine various properties of the node. These properties include the name of the element (getNodeName), the node type (getNodeType; compare the return value to predefined constants in the Node class), the node value (getNodeValue; e.g., for text nodes the value is the string between the element's start and end tags), the attributes used by the element's start tag (getAttributes), and the child 6. nodes (getChildNodes; i.e., the elements contained between the current element's start and end tags). You can recursively examine each of the child nodes.

  7. Modify properties of the nodes. Instead of just extracting data from an XML document, you can modify the document by adding child nodes (appendChild), removing child nodes (removeChild), and changing the node's value (setNodeValue). Unfortunately, however, DOM doesn't provide a standard method of writing out a DOM structure in textual format. So, you have to either do it yourself (printing out a "<", the node name, the attribute names and values with equal signs between them and quotes around the values, a ">", etc.) or use one of the many existing packages that generate text from a DOM element.

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