Home > Articles

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

This chapter is from the book

Document Interface

The Document interface is the topmost interface in the XML document tree. It contains nine defined methods, five additional methods derived from the various document attributes, and those methods and variables inherited from the Node interface. The Document interface performs four major functions, allowing developers to do the following:

  • Query for information about the document, such as its name, entities, and notations.

  • Query for information about the implementation, such as what version of the DOM core is supported.

  • Create documents, DocumentFragments, Elements, Nodes, Attributes, Comments, and so on.

  • Traverse the document tree.

The Document object always has Node type DOCUMENT_NODE. The following sections describe the methods on the Document object.

Methods that Return Information About the Document or Implementation

There are a number of methods for returning information about the DTD associated with a document. The most common methods are listed below.

  • DocumentType getDocType() Returns a DocumentType object that has three methods. NamedNodeMap getEntities() returns all the defined entities within the document. NamedNodeMap getNotations() returns all the notations, and String getName() returns the name immediately following the DOCTYPE keyword within the DTD.

  • DOMImplementation getImplementation() Returns a DOMImplementation object that has a single method boolean hasFeature();. A typical use might be getImplementation.hasFeature("XML,"1.0");.

Methods that Return Information About Descendant Nodes

In addition to those inherited from the node interface, two methods exist for accessing the children of a Node.

  • Element getDocumentElement(...) Returns the root Element of the Document. In the case of HTML it is the element containing the <html> tag. In XML, this method returns the Element representing the root of the XML tree.

  • NodeList getElementsByTagName(String tag) Returns a NodeList of all the nodes that match the given tag. This method is interesting in that it returns all the nodes represented by the tag regardless of their level within the XML tree.

Methods that Create Descendant Nodes

There are a number of methods that can be used to create child nodes, which can then be inserted into an XML document. The various Create methods can be used to create empty elements that can then be inserted into a DOM tree.

  • Attr createAttribute(String name) Creates an attribute of the given name.

  • CDATASection createCDATASection(String name) Creates a CDATA node.

  • Comment createComment(String comment) Create a comment.

  • DocumentFragment createDocumentFragment() Creates an empty document that can then be used to add additional elements.

  • Element createElement(String tag) Creates an empty element of name tag. This element may later have child nodes added to it.

  • EntityReference createEntityReference(String name) Creates an EntityReference of the given name.

  • ProcessingInstruction createProcessingInstruction(String target, String data) Creates a ProcessingInstruction node.

  • TextNode createTextNode(String data) Creates a TextNode with the given data as its value.

Before we move on and examine the Element interface, a short example of the use of getElementsByTag(...) would be beneficial (see Listing 3.5).

Listing 3.5 ElementsByTag.java—Using getElementsByTag

 1: /*
 2:  * @(#)ElementsByTag.java         1.0 99/05/28
 3:  *
 4:  * Copyright (c) 1999 Sams Publishing. All Rights Reserved.
 5:  *
 6:  */
 7:
 8: import java.io.*;
 9: import com.sun.xml.tree.*;
10: import org.w3c.dom.*;
11:
12: public class ElementsByTag
13: {
14:     public static void main (String argv [])
15:     {
16:         FileInputStream inStream;
17:         Document document;
18:         String xmlDocumentPath = "catalog.xml";
19:         try
20:         {
21:             inStream = new FileInputStream(xmlDocumentPath);
22:             document = XmlDocument.createXmlDocument(inStream,true);
23:
24:             NodeList entries = document.getElementsByTagName( "entry" );
25:             if ( entries.getLength()== 0)
26:             {
27:                 System.out.println("No entries in this catalog, exiting");
28:                 System.exit(0);
29:             }
30:
31:             for (int i = 0; i < entries.getLength(); i++)
32:             {
33:                 System.out.print(i + " ");
34:                 Element entryNode = (Element) entries.item(i);
35:                 NodeList titles = entryNode.getElementsByTagName ("title");
36:                 if ( titles.getLength() == 0)
37:                     System.out.println("Unknown");
38:                 else
39:                 {
40:                     Node titleElement = titles.item(0);
41:                     NodeList titleValues = titleElement.getChildNodes();
42:                     Node titleValue = titleValues.item(0);
43:                     System.out.print (" "+titleValue.getNodeValue());
44:                 }
45:
46:                 //
47:                 // Now show author entries
48:                 //
49:                 NodeList authors = entryNode. getElementsByTagName ("author");
50:                 if ( authors.getLength() == 0)
51:                     System.out.println("Unknown");
52:                 else
53:                 {
54: . . .
55:                 }
56:                 //
57:                 // Now show prices
58:                 //
59:                 NodeList prices = entryNode.getElementsByTagName ("price");
60:                 if ( prices.getLength() == 0)
61:                     System.out.println("Unknown");
62:                 else
63:                 {
64: . . .
65:                 System.out.println("");
66:             }
67:         }
68:         catch (Exception e)
69:         {
70:             System.out.println( "Unexpected exception reading document!" +e);
71:             System.exit (0);
72:         }
73:
74:
75:     }
76: }

Listing 3.5 produces output similar to Listing 3.6.

Listing 3.6 Output of GetElementsByTag.java

1: C:\java sams.chp3.GetElementsByTab
2: 0  Better Living Thru Chemistry I. W. Books 9.95 discount:retail cur:us 7.95 discount:
wholesale cur:us
3: 1  Special Edition:Using XML and Java 2.0  Al Saganich Mike Daconta 9.95 discount:
retail cur:us 7.95 discount:wholesale cur:us
4: 2  Java 2.0 and JavaScript for C/C++ Programmers Al Saganich Mike Daconta 59.95 
discount:retail cur:us 74.95 discount:wholesale cur:us
5: 3  Converational French R. Weiman 7.00 discount:retail cur:can 4.25     discount:
wholesale cur:us

In GetElementsByTag.java, we use the getElementsByTag method multiple times on both the Document object and its underlying Element object. As we'll see in the next section, the Element interface has an identical method to the Document.getElementsByTag() method.

Again we use the method several times, once to return a list of the entry elements and within entries to directly get entry information such as title, author, and price. Both are simple enough, but what is important to understand is that we could have completely ignored the fact that titles exist within entries. If we remember that our catalog contains entries and entry titles, we could have just as easily listed all the titles with the catalog directly with the following code snippet:

					
NodeList document = entryNode.getElementsByTagName ("title");

This command takes the parent Document object, rather then acting on a child node somewhere down the DOM document. The code snippet also returns all title objects. For example, if we are only interested in collecting all the currencies associated with a catalog, we could write the following:

					
NodeList document = entryNode.getElementsByTagName ("price");

which, again, takes the parent Document object and returns all the child price Elements, regardless of where they fall in the DOM tree. getElementsByTagName is certainly one of the more powerful methods in the entire DOM API.

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