Home > Articles

This chapter is from the book

Well-Formed vs. Valid Documents

We learned that if a document follows the XML syntax rules discussed in the previous section, the document is said to be well-formed, the minimal requirement to be an XML document. That is, if a document isn't well-formed, it can't even be called XML (excepting XML fragments).

Validity

Even if a document is well-formed, however, it may not be valid. According to the XML specification (see http://www.w3.org/TR/REC-xml#sec-documents and http://www.w3.org/TR/REC-xml#dt-valid),

A data object is an XML document if it is well-formed, as defined in this specification. A well-formed XML document may in addition be valid if it meets certain further constraints. . . . An XML document is valid if it has an associated document type declaration and if the document complies with the constraints expressed in it.

In other words, since a document type declaration (and therefore a DTD) is optional, only documents that refer to a DTD can be checked for validity. This makes sense because following the well-formedness rules only indicates adherence to basic syntactical constraints; it says nothing about meeting the more stringent requirements of a specific structural model.

To reinforce the difference, let's take another look at the Employees example from chapter 2. The DTD is repeated here in Listing 3-4 for convenience.

Listing 3-4 Employees DTD (employee.dtd)

<!ELEMENT Employees ( Employee+ ) >
<!ELEMENT Employee ( Name, Title, Projects, Email, PhoneNumbers, Address ) >
<!ATTLIST Employee sex NMTOKEN #REQUIRED >
<!ELEMENT Name ( First, Last ) >
<!ELEMENT First ( #PCDATA ) >
<!ELEMENT Last ( #PCDATA ) >
<!ELEMENT Title ( #PCDATA ) >
<!ELEMENT Projects ( Project+ ) >
<!ELEMENT Project ( #PCDATA ) >
<!ELEMENT Email ( #PCDATA ) >
<!ELEMENT PhoneNumbers ( Home, Office, Cell ) >
<!ELEMENT Home ( #PCDATA ) >
<!ELEMENT Office ( #PCDATA ) >
<!ELEMENT Cell ( #PCDATA ) >
<!ELEMENT Address ( Street, City, State, Zip ) >
<!ELEMENT Street ( #PCDATA ) >
<!ELEMENT City ( #PCDATA ) >
<!ELEMENT State ( #PCDATA ) >
<!ELEMENT Zip ( #PCDATA ) >

Now consider the document in Listing 3-5. Is it valid?

Listing 3-5 Employee Example 1 (employee-WF.xml)

<?xml version='1.0' standalone='yes'?>
<Employees>
 <Employee sex="female">
  <Name>
   <First>Betty Jo</First>
   <Last>Bialowsky</Last>
   <!-- aka: Melanie Haber, Audrey Farber, Susan Underhill, Nancy -->
  </Name>
  <Title>Project Leader</Title>
  <Projects>
   <Project>MegaProject</Project>
   <Project>SmallProject</Project>
   <Project>others</Project>
  </Projects>
  <Email>BettyJo.Bialowsky@home.com</Email>
  <PhoneNumbers>
   <Home>555-abc-1235</Home>
   <Office>555-xyz-4321</Office>
   <Cell>555-pqr-1267</Cell>
  </PhoneNumbers>
  <Address>
   <Street>321 Carmel Court</Street>
   <City>Columbia</City>
   <State>MD</State>
   <Zip>20777</Zip>
  </Address>
 </Employee>
</Employees>

At first glance, it appears to be valid because it follows the structural rules of the DTD. However, because it does not contain a document type declaration, the parser has no DTD to compare the document instance against in order to determine validity. Therefore, it is well-formed, but not valid, or at least its validity cannot be determined. What about the document in Listing 3-6?

Listing 3-6 Employee Example 2 (employee-Miss-Elt.xml)

<?xml version='1.0' standalone='no'?>
<!DOCTYPE Employees SYSTEM "employee.dtd" >
<Employees>
 <Employee sex="female">
  <Name>
   <First>Betty Jo</First>
   <Last>Bialowsky</Last>
   <!-- aka: Melanie Haber, Audrey Farber, Susan Underhill, Nancy -->
  </Name>
  <Projects>
   <Project>MegaProject</Project>
   <Project>SmallProject</Project>
   <Project>others</Project>
  </Projects>
  <Email>BettyJo.Bialowsky@home.com</Email>
  <PhoneNumbers>
   <Home>555-abc-1235</Home>
   <Office>555-xyz-4321</Office>
  </PhoneNumbers>
  <Address>
   <Street>321 Carmel Court</Street>
   <City>Columbia</City>
   <State>MD</State>
   <Zip>20777</Zip>
  </Address>
 </Employee>
</Employees> 

With the inclusion of a reference to a DTD, a validating parser can check this instance. It will conclude, however, that there are two missing elements, namely Title and Cell, so this document is well-formed but invalid. In fact, most parsers diagnose the problem quite clearly. For example, the free parser XML Validator from ElCel Technology (http://www.elcel.com/products/xmlvalid.html) reports:

employee-Miss-Elts.xml [10:15] : Error: element content invalid. Element 'Projects' is not expected here, expecting 'Title'
employee-Miss-Elts.xml [19:20] : Error: premature end to content of element 'PhoneNumbers'. Expecting child element 'Cell'

This indicates, among other things, that the errors are detected on lines 10 and 19. And what about this one in Listing 3-7?

Listing 3-7 Employee Example 3 (employee-BJB.xml)

<?xml version='1.0' standalone='no'?>
<!DOCTYPE Employees SYSTEM "employee.dtd" >
<Employees>
 <Employee sex="female">
  <Name>
   <First>Betty Jo</First>
   <Last>Bialowsky</Last>
   <!-- aka: Melanie Haber, Audrey Farber, Susan Underhill, Nancy -->
  </Name>
  <Title>Project Leader</Title>
  <Projects>
   <Project>MegaProject</Project>
   <Project>SmallProject</Project>
   <Project>others</Project>
  </Projects>
  <Email>BettyJo.Bialowsky@home.com</Email>
  <PhoneNumbers>
   <Home>555-abc-1235</Home>
   <Office>555-xyz-4321</Office>
   <Cell>555-pqr-1267</Cell>
  </PhoneNumbers>
  <Address>
   <Street>321 Carmel Court</Street>
   <City>Columbia</City>
   <State>MD</State>
   <Zip>20777</Zip>
  </Address>
 </Employee>
</Employees>

This document is well-formed and valid because it matches the structure defined by the DTD, which is referenced in the document type declaration.

Well-Formed or Toast?

Ignoring for a moment the potential importance of validity to data-oriented applications, you might wonder why even when an XML document does not require a DTD (i.e., is standalone), it still must be well-formed. In fact, if a document is not well-formed, it cannot even be called an XML document.

The reason for insisting on well-formedness is to counteract the "browser bloat" syndrome that occurred when the major browser vendors decided they wanted their browser to be able to render the horribly inaccurate HTML developed by graduates (or perhaps flunkies) of the Learn HTML in 2 Days or Less school. Many Web pages contain completely invalid HTML, with improperly nested elements, missing end tags, misspelled element names, missing delimiters, and other aberrations. Browsers such as Netscape Communicator and Internet Explorer do an admirable job of recovering from these errors, but only at the expense of a considerable amount of built-in recovery code.

Fortunately, with XML (and XHTML), parsers do not need to implement recovery code and can therefore stay trim and lightweight. If the parser encounters a well-formedness problem, it should only report the problem to the calling application. It explicitly must not attempt to correct what might be missing, overlapping, or misspelled. Violations of well-formedness constraints are considered fatal errors, according to the XML 1.0 Recommendation. The bottom line here is: either a document is well-formed XML, or it's toast; that is, it's not XML.

The extra code necessary to do the HTML-like corrections might not be a significant problem for a desktop PC with lots of memory. It's more of an issue as XML is fed to handheld PCs and other devices with limited memory and/or processing power.

Validating and Nonvalidating Parsers

The differences between validating and nonvalidating parsers are not quite as clear as you might think. According to the XML 1.0 specification (http://www.w3.org/ TR/REC-xml#proc-types),

Validating processors must, at user option, report violations of the constraints expressed by the declarations in the DTD, and failures to fulfill the validity constraints given in this specification. To accomplish this, validating XML processors must read and process the entire DTD and all external parsed entities referenced in the document. Non-validating processors are required to check only the document entity, including the entire internal DTD subset, for well-formedness.

In other words, validating parsers must read the entire DTD and check the document against the structural constraints it describes. You might conclude, therefore, that nonvalidating parsers do not need to consult the DTD, but that turns out to be incorrect. Even nonvalidating parsers need to supply default values for attributes and to replace text based on internal entities (discussed in chapter 4).

Although there used to be a class of strictly nonvalidating parsers, they tend to be much less popular of late. Most modern parsers (2000 and beyond) can be run in either validating or nonvalidating mode. Why run in nonvalidating mode when a parser is capable of validation? Because validation can significantly impact performance, especially when long and complex DTDs are involved. Some developers find that while enabling validation during development and test phases is crucial, it's sometimes beneficial to surpress validation in production systems where document throughput is most valued and the reliability of the data is already known. Consult the documentation of prospective parsers to determine how to toggle this switch, and which is the default mode. For example, the Apache Xerces parser is nonvalidating by default.

Some of the more highly regarded XML parsers include:

  • Apache XML Project's Xerces

  • IBM's XML Parser for Java (xml4j)

  • JavaSoft's XML Parser

  • MSXML 4.0 Release: Microsoft XML Core Services component (aka MSXML Parser) and SDK

  • Oracle's XML Parser

  • ElCel Technology's XML Validator

URLs for these parsers and many more can be found on the XML Parsers/ Processors list at XMLSoftware.com, http://www.xmlsoftware.com/.

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