Home > Articles

This chapter is from the book

This chapter is from the book

Parents and Children

The node relationships of the DOM are a direct manifestation of the [parent]/[children] relationships of the Infoset. The Node interface provides a set of attributes and methods that correspond to these two Infoset properties.

interface Node {
  readonly attribute Node         parentNode;
  readonly attribute Node         firstChild;
  readonly attribute Node         lastChild;
  readonly attribute Node         previousSibling;
  readonly attribute Node         nextSibling;
  readonly attribute NodeList     childNodes;
  boolean                         hasChildNodes();
  readonly attribute Document     ownerDocument;
    :               :                  :
};

Figure 2.7 illustrates how these attributes relate to a given node in a document. Due to the Node interface's generality, some aspects of this interface may not be applicable for all node types. For example, the document information item does not have a [parent] property. For that reason, the Node.parentNode attribute will always evaluate to null for nodes of type Document. Similarly, since processing instruction information items do not have a [children] property, the Node.firstChild and Node.lastChild attribute of ProcessingInstruction nodes will always evaluate to null.

Figure 2.7Figure 2.7. The Node interface's [parent]/[children] properties


The Node interface was designed to make document traversal uniform and simple. For example, the following Java method performs a depth-first traversal of the given node:

void traverseTree (Node current) {
   myProcessNode(current);
   for (Node child = current.getFirstChild(); child != null;
        child = child.getNextSibling() )
      traverseTree(child);
}

This depth-first traversal corresponds exactly to the document-order of [children] properties in the Infoset. The following Java method performs the traversal in reverse-document-order:

void traverseTreeReverse(Node current) {
   for (Node child = current.getFirstChild(); child != null;
        child = child.getPreviousSibling() )
      traverseTreeReverse(child);
   myProcessNode(current);
}

Note that both of these examples use a sequential access pattern much like that imposed by a linked-list. It is also possible to use a more array-like random-access pattern using the NodeList interface.

The DOM defines the NodeList interface to provide random access to an ordered collection of nodes. The NodeList interface is defined as follows:

interface NodeList {
  Node item(in unsigned long index);
  readonly attribute unsigned long    length;
};

The [children] property of the current node can be accessed using the NodeList interface via the Node.childNodes attribute. The traverseTree method shown earlier can be rewritten as follows:

			
void traverseTree(Node current) {
   myprocessNode(current);
   NodeList children = current.getChildNodes ();
   for (int i = 0; i < children.getI.ength(); i++)
      traverseTree(children.item(i));
}

The traverseTreeReverse can also be rewritten using the Nodelist interface

void traverseTreeReverse(Node current) {
  NodeList children = current.getChildNodes();
  for (int i = children.getLength() - 1; i >= 0; i--)
     traverseTreeReverse(children.item(i));
  myProcessNode(current);
}

For these two examples, the difference is largely stylistic. However, if random access to the ith child node is desired, then the NodeList approach will likely be considerably faster.9

Independent of the [parent]/[children] relationship, DOM nodes always belong to a particular Document. As soon as a new node is created through one of the Document's factory methods, that node is automatically associated with the Document that created it. This association cannot be changed and is made explicit via the node's ownerDocument attribute.

void create(org.w3c.dom.Document doc) {
 Node n = doc.createElementNS ("http://books.org", "author");
 assert (n.ownerDocument == doc);
}

Note that the value of the Node.ownerDocument attribute cannot be changed and will be the same for all nodes within a document.

The Node interface also provides a set of methods for manipulating the DOM hierarchy. These methods enforce the type constraints of the [children] properties. For example, one can use these methods to add a Text node child to an Element node but not to a Document node. The definition of these manipulation methods is as follows:

interface Node {
  Node insertBefore(in Node newChild, in Node refChild)
  Node appendChild(in Node newChild)
  Node removeChild(in Node oldChild)
  Node replaceChild(in Node newChild, in Node oldChild)
  Node cloneNode(in boolean deep);
...
};

Both the Node.insertBefore and Node.appendChild methods are used to add nodes to the hierarchy.

Node.appendChild simply adds the new child to the end of the list of children, whereas Node.insertBefore allows you to specify where the new node should appear in the sequence of children. Both methods return the node that was inserted. For example, the following code adds a new artist element node to the end of period's children:

import org.w3c.dom.*;
void addNewArtist(Document doc, Node period) {
  Node newChild = doc.createElementNS(
     "http://www.art.org/schemas/art", "artist");
  Node insertedNode = period.appendChild(newChild);
  assert(newChild == insertedNode);
  assert(insertedNode == period.getLastChild());
}

The Node.insertBefore accepts an additional object reference as a parameter. This reference indicates the node that the insertion should precede. If this parameter is null, Node.insertBefore behaves exactly like Node.appendChild. Consider the following code that uses both insertion techniques:

import org.w3c.dom.*;
void addTwoPeriods(Document doc, Node art) {
  Node newChild1 = doc.createElementNS(
     "http://www.art.org/schemas/art", "period");
  art.appendChild(newChild1);
  Node newChild2 = doc.createElementNS(
     "http://www.art.org/schemas/art", "period");
  Node pos = period.getFirstChild().getNextSibling();
  Node insertedNode = art.insertBefore(newChild2, pos);
  assert(newChild2 == insertedNode);
  assert(insertedNode == period.getChildNodes().item(1));
}

Figure 2.8 shows the results of this code.

Figure 2.8Figure 2.8. Node.appendChild and Node.insertBefore


Whereas the DOM's Node.nodeType reinvents RTTI to distinguish node types, the DOM leverages the native programming system's notion of object identity. To this end, a given instance of Node can only appear once in a document hierarchy. When calling Node.insertBefore or Node.appendChild, if the node to be inserted already appears elsewhere in the DOM hierarchy, it will automatically be removed from its current location before being inserted to a new location. For example, consider the following Java code:

import org.w3c.dom.*;
void doubleIt(Document doc, Node parent) {
  Node child = doc.createElementNS("", "child");
  parent.appendChild(child);
  parent.insertBefore(child, parent.getFirstChild());
}

Because a given node object can only appear once in a document hierarchy, this code winds up inserting exactly one Element node at the beginning of the list of child nodes of parent. The work done by the call to Node.appendChild is undone by the call to Node.insertBefore that "reinserts" the same node.

In addition to inserting nodes into a list of child nodes, it is is also possible to remove or replace a node via Node.removeChild and Node.replaceChild methods respectively. Consider the following java code:

import org.w3c.dom.*;
void figureNine(Document doc, Node art) {
  Node newChild = doc.createElementNS(
     "http://www.art.org/schemas/art", "period");
  art.replaceChild(newChild, art.getFirstChild());
  art.removeChild(art.getLastChild());
}

The results of this code are shown in Figure 2.9. Note that the resources held by the node that is replaced or removed are not necessarily destroyed at removal-time.

Figure 2.9Figure 2.9. Node.replaceChild and Node.removeChild


It is interesting to note that the Node.replaceChild method simply combines insertion and removal in a single operation. For example, this Java method

import org.w3c.dom.*;
void swap(Node parent, Node oldChild, Node newChild) {
  parent.insertBefore(newChild, oldChild);
  parent.removeChild(oldChild);
}

could be replaced with

import org.w3c.dom.*;
void swap(Node parent, Node oldChild, Node newChild) {
  parent.replaceChild(newChild, oldChild);
}

The latter is obviously more convenient and maintainable.

Finally, the Node.cloneNode method provides a way to copy a node and optionally all of its ancestor nodes. The newly created clone node is not attached to any document hierarchy and does not have a parent until it is inserted using one of the methods described above. The new node will be a an exact copy of original node, plus if the deep parameter is true, Node.cloneNode will recursively copy all child nodes as well. If the node happens to be an Element node, Node.cloneNode will also copy all of the attribute information items associated with the element. The following example copies a period element and all of its children and attributes and then inserts it into the hiearchy:

import org.w3c.dom.*;
void cloneLastPeriod(Node art) {
  Node clone = art.getLastChild().cloneNode(true);
  art.appendChild(clone);
}

As shown in Figure 2.10, this simple method call can do a lot of work.

Figure 2.10Figure 2.10. Node.cloneNode


The various parent/child attributes of the Node interface are considered live in the face of updates. Additionally, the object returned by childNodes doesn't represent a static snapshot of the child nodes but rather a dynamic cursor over the current collection of children. Any changes to the underlying content is automatically visible in all outstanding NodeList references as shown here.

NodeList nl = period.getChildNodes();
// nl.getLength() == 3
Node newNode = doc.createElement("author");
period.appendChild(newNode);
// nl.getLength() == 4

Notice that after inserting a new author node under period, the changes are automatically visible to the outstanding NodeList reference, nl, without any additional intervention.

Because NodeLists are live, care needs to be taken when dealing with them in certain situations. For example, take a look at the following code that attempts to remove all nodes from a NodeList:

NodeList nl = node.getChildNodes();
for (int i = 0; i < nl.getLength(); i++) {
   node.removeChild(nl.item(i));
}

This code doesn't work as expected because the NodeList is live. If there were 5 nodes in the list, it's only going to remove nodes 1, 3, and 5. Every time a node is removed, the NodeList's length changes along with each node index. To handle this type of operation properly, it's better to delete from the front of the list until the list is empty.

NodeList nl = node.getChildNodes();
while (nl.getLength() > 0) {
   node.removeChild(nl.item(0));
}

Of course, this code could have also been written using Node.firstChild.

The parentNode value is also dynamic in the face of node manipulation. For example, upon creation via createElementNS, a new element's parentNode attribute will be null. However, once it has been inserted into a document's hierarchy, the element's parentNode attribute will be adjusted accordingly.

Node n = doc.createElementNS("http://books.org", "author");
// n.parentNode == null
doc.appendChild(n); // insert the node
// n.parentNode == doc

All nodes except for Document, DocumentFragment, Attr, Entity, and Notation nodes will have a non-null parent node when they exist within the hierarchy.

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