Home > Articles

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

This chapter is from the book

Creating an XML Document

XML is programming language–neutral. But because we are not neutral, we will be programming using the Java API for XML Parsing (JAXP) in all the examples in this chapter.

The important JAXP classes and interfaces are summarized here:

  • org.xml.sax.helpers.DefaultHandler—This class is the default base class for SAX2 event handlers. It serves as a convenience class, which means that it provides a default handler for any events that you don't want to handle. When writing applications, you can extend this class and override the parts of the interface that you want to control.

  • javax.xml.parsers.DocumentBuilder—This abstract class allows an application programmer to obtain a DOM version of an XML document.

  • javax.xml.parsers.DocumentBuilderFactory—This class allows a programmer to get a handle to a concrete DocumentBuilder object.

  • org.w3c.dom.Document—This interface provides a reference to the entire XML document tree. Using this handle, the contents of the tree can be analyzed.

  • javax.xml.transform.Transformer—An instance of this abstract class provides us with a way to stream XML to a file.

  • javax.xml.transform.stream.StreamResult—This class receives a stream representing the XML that is to be put in a file.

  • org.w3c.dom.Node—This interface provides references to the nodes in the document tree. As a reference, it can serve as a handle to any type of node.

The simplest way to create an XML document is to type it in using a text editor such as Notepad or vi. This is a useful approach while you are learning XML because it gives you time to think about each reserved character and its purpose.

Listing 3.1 is a simple XML document that illustrates several of the points that we have discussed.

NOTE

All the code in this chapter can be found on the Sams Publishing Web site at http://www.samspublishing.com.

Listing 3.1 A Simple XML File Representing a Request for a Cruise Ticket

<?xml version='1.0' encoding='utf-8' standalone='yes' ?>
<!--This XML document represents a request for a cruise ticket-->

<!DOCTYPE ticketRequest SYSTEM "ticketRequest.dtd">

<ticketRequest>
  <customer custID="10003" >
   <lastName>Carter</lastName>
   <firstName>Joseph</firstName>
  </customer>
  <cruise cruiseID="3004">
   <destination>Hawaii</destination>
   <port>Honolulu</port>
   <sailing>7/7/2001</sailing>
   <numberOfTickets>5</numberOfTickets>
   <isCommissionable/>
  </cruise>
</ticketRequest>

Let's take this example apart and figure out what each element in the file means. The first line is

<?xml version='1.0' encoding='utf-8' standalone='yes' ?>

This line starts with a <? character sequence. This line allows the parser or any other software that is looking at the file to detect that it is an XML file that is governed by the rules of version 1.0. This will become important as new versions are introduced. The encoding attribute tells us that the character set used in the document is utf-8, commonly known as text. The keyword standalone is set to yes, which indicates that this document is self-contained and references no other files.

The next line begins with <!--. This character sequence tells the processing program that this is a comment.

<!--This XML document represents a request for a cruise ticket-->

The drawback to this is the use of the comments to contain information that is processing-oriented. We see this in the very next line in the file:

<!DOCTYPE ticketRequest SYSTEM "ticketRequest.dtd">

This line associates the document with a more detailed definition of correctness called the Document Type Definition (DTD). We will see the DTD for this example in the next section. The word SYSTEM tells us to look for a file on our local file system relative to the location of this document. In this case, the DTD file, ticketRequest.dtd, would be in the same directory as this file. The word SYSTEM, if it appears here, tells the XML parser that the following string in quotes can be used to load the DTD. This can be used to provide a hyperlink to a DTD using a URL.

The next line is the root element of the document. You are only allowed to define one root element per XML document. The root element contains all other elements in the XML file. The <ticketRequest> form tells us that this is a user-defined tag with the name ticketRequest and that ticketRequest is in the default namespace. The tools that manipulate the XML document are oblivious to the fact that this is a request for tickets. Extracting meaningful information from the document is the job of the XML document consumer that we will create later in this chapter. All that the XML tools are able to do is notice whether the rules of XML are being followed and process the document according to those rules.

<ticketRequest>

Next, we see another tag named customer. The format is a little different, though, because we see extra characters before the > appears.

  <customer custID="10003" >

The extra characters represent an attribute of the customer tag. Defining an attribute is one way of associating information with a tag name. The syntax is formed by simply placing the name of the attribute next to the name of the tag followed by = and a quoted string. Even if a number appears in an attribute, it still appears inside quotes. The > tells us that there are no more attributes for this tag.

The following line is associated with the customer tag because it appears before the closing tag for customer. Any element that appears before the closing tag is considered a nested element. Nested elements are associated logically with the enclosing element. This means that they will be considered part of the enclosing tag by the parser. In this case, custID is considered the custID of the ticketRequest.

   <lastName>Carter</lastName>

There is another nested element in customer: the firstName element. We know that the firstName element is not nested inside the lastName element because the closing tag for lastName, </lastName> has already appeared in the file.

   <firstName>Joseph</firstName>

Finally, we come to the closing tag for customer. This tells us that there will not be any more attributes or nested elements defined for customer.

  </customer>

The next line creates a new element called cruise. It also has a cruiseID attribute defined:

  <cruise cruiseID="3004">

There are several nested elements inside the cruise tag. Each of them provides some detail about the cruise: where it is going, when it departs, and so on.

   <destination>Hawaii</destination>
   <port>Honolulu</port>
   <sailing>7/7/2001</sailing>
   <numberOfTickets>5</numberOfTickets>

The following syntax is somewhat different. This character sequence represents an empty tag. An empty tag is one that will never have a subtree of nested elements. The fact that it is present communicates information to the document's consumer. When the consuming program sees this tag, it will know to pay a commission to a travel agent for booking this cruise. If the cruise has been booked online, this tag will be left off, indicating to the consuming program that no commission need be paid.

   <isCommissionable\>

Next, the closing tag for cruise appears. After this line we could create another element if we chose to do so. This is because we have still not closed the root element, ticketRequest. However, we can only create elements that are allowed by the DTD that was referenced in the DOCTYPE declaration.

  <cruises

Finally, we close ticketRequest.

</ticketRequest>

This line must be the last one in the document. If you attempt to create another tag after this, it will be a second root element and that is not allowed. Each XML document is a representation of exactly one root tag.

At this point, we have created a file that contains a ticketRequest in a special format. In essence, we have a little piece of persistent storage in character form that can be transmitted anywhere a text file can go. This is the central idea behind XML.

  • + 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