Examining the Structure of a DOM

In this section, you'll use the GUIfied DomEcho application created in the preceding section to visually examine a DOM. You'll see what nodes make up the DOM and how they are arranged. With the understanding you acquire, you'll be well prepared to construct and modify Document Object Model structures in the future.

Displaying a Simple Tree

We'll start by displaying a simple file so that you get an idea of basic DOM structure. Then we'll look at the structure that results when you include some advanced XML elements.

Figure 6-1 shows the tree you see when you run the DomEcho program on the first XML file you created, slideSample01.xml.

Recall that the first bit of text displayed for each node is the element type. After that comes the element name, if any, and then the element value. This view shows three element types: Document, Comment, and Element. There is only one node of Document type for the whole tree, the root node. The Comment node displays the value attribute, and the Element node displays the element name, slideshow.

Compare Figure 6-1 with the code in the AdapterNode's toString method to see whether the name or the value is being displayed for a particular node. If you need to make it more clear, modify the program to indicate which property is being displayed (for example, with N: name, V: value).

Here, you can see the Text nodes and Comment nodes, which are interspersed between slide elements. The empty Text nodes exist because there is no DTD to tell the parser that no text exists. (Generally, the vast majority of nodes in a DOM tree will be Element and Text nodes.)

Note: Important! Text nodes exist under element nodes in a DOM, and data is always stored in text nodes. Perhaps the most common error in DOM processing is to navigate to an element node and expect it to contain the data that is stored in that element. Not so! Even the simplest element node has a text node under it that contains the data. For example, given <size>12</size>, there is an element node (size), and a text node under it that contains the actual data (12).

Notably absent from this picture are the Attribute nodes. An inspection of the table in org.w3c.dom.Node shows that there is indeed an Attribute node type. But they are not included as children in the DOM hierarchy. They are instead obtained via the Node interface getAttributes method.

Note: The display of the text nodes is the reason for including the following lines in the AdapterNode's toString method. If you remove them, you'll see the funny characters (typically square blocks) that are generated by the newline characters that are in the text.

  String t = domNode.getNodeValue().trim();
  int x = t.indexOf("\n");
  if (x >= 0) t = t.substring(0, x);
  s += t;

Displaying a More Complex Tree

Here, you'll display the example XML file you created at the end of Chapter 5 to see what entity references, processing instructions, and CDATA sections look like in the DOM.

Figure 6-3 shows the result of running the DomEcho application on slideSample10.xml, which includes a DOCTYPE entry that identifies the document's DTD.

The DocType interface is actually an extension of w3c.org.dom.Node. It defines a getEntities method, which you use to obtain Entity nodes--the nodes that define entities such as the product entity, which has the value WonderWidgets. Like Attribute nodes, Entity nodes do not appear as children of DOM nodes.

Here, the processing instruction node is highlighted, showing that those nodes do appear in the tree. The name property contains the target specification, which identifies the application that the instruction is directed to. The value property contains the text of the instruction.

Note that empty text nodes are also shown here, even though the DTD specifies that a slideshow can contain slide elements only, never text. Logically, then, you might think that these nodes would not appear. (When this file was run through the SAX parser, those elements generated ignorableWhitespace events rather than character events.)

Moving down to the second slide element and opening the item element under it brings up the display shown in Figure 6-5.

Here, you can see that a text node containing the copyright text (rather than the entity reference that points to it) was inserted into the DOM.

For most applications, the insertion of the text is exactly what you want. In that way, when you're looking for the text under a node, you don't have to worry about any entity references it might contain. For other applications, though, you may need the ability to reconstruct the original XML. For example, an editor application would need to save the result of user modifications without throwing away entity references in the process.

Various DocumentBuilderFactory APIs give you control over the kind of DOM structure that is created. For example, add the following highlighted line to produce the DOM structure shown in Figure 6-6.

public static void main(String argv[])
{
  ...
  DocumentBuilderFactory factory = 
DocumentBuilderFactory.newInstance();
  factory.setExpandEntityReferences(false);
  ...

Here, the entity reference node is highlighted. Note that the entity reference contains multiple nodes under it. This example shows only comment and text nodes, but the entity could conceivably contain other element nodes.

Moving down to the last item element under the last slide brings up the display shown in Figure 6-7.

Here, the CDATA node is highlighted. Note that there are no nodes under it. Because a CDATA section is entirely uninterpreted, all its contents are contained in the node's value property.

Summary of Lexical Controls

Lexical information is the information you need to reconstruct the original syntax of an XML document. As discussed earlier, preserving lexical information is important in editing applications, where you want to save a document that is an accurate reflection of the original--complete with comments, entity references, and any CDATA sections it may have included at the outset.

Most applications, however, are concerned only with the content of the XML structures. They can afford to ignore comments, and they don't care whether data was coded in a CDATA section or as plain text, or whether it included an entity reference. For such applications, a minimum of lexical information is desirable, because it simplifies the number and kind of DOM nodes that the application must be prepared to examine.

The following DocumentBuilderFactory methods give you control over the lexical information you see in the DOM:

setCoalescing(): To convert CDATA nodes to Text nodes and append to an adjacent Text node (if any)

setExpandEntityReferences(): To expand entity reference nodes

setIgnoringComments(): To ignore comments

setIgnoringElementContentWhitespace(): To ignore whitespace that is not a significant part of element content

The default values for all these properties is false, which preserves all the lexical information necessary to reconstruct the incoming document in its original form. Setting them to true lets you construct the simplest possible DOM so that the application can focus on the data's semantic content without having to worry about lexical syntax details. Table 6-2 summarizes the effects of the settings.

Table 6-2 Configuring DocumentBuilderFactory
API	Preserve Lexical Info	Focus on Content
`setCoalescing()`	`false`	`true`
`setExpandEntityReferences()`	`false`	`true`
`setIgnoringComments()`	`false`	`true`
`setIgnoringElement ContentWhitespace()`	`false`	`true`

Finishing Up

At this point, you have seen most of the nodes you will ever encounter in a DOM tree. There are one or two more that we'll mention in the next section, but you now know what you need to know to create or modify a DOM structure.