Welcome!

Industrial IoT Authors: Elizabeth White, Stackify Blog, Yeshim Deniz, SmartBear Blog, Liz McMillan

Related Topics: Industrial IoT

Industrial IoT: Article

Visiting the DOM

Extending the Visitor Pattern

It is well known that traversing the XML DOM is a sometimes difficult and often tedious task. Executing code based on data retrieved from the DOM is even more complex. This article will demonstrate one way to abstract much of the logic from this repetitive task. The implementation of patterns is a technique that is often used to help simplify and intellectually manage projects, and the Visitor Pattern is appropriate and useful to help solve this problem. Reflection also plays a key role, and is used to determine the executed code based on the DOM node names at runtime.

XML has proven itself to be useful for storing the data for many types of applications (www.oasis-open.org). However, when you get down to it, XML is just a highly structured text file. Applications that use XML as their input format must process the XML file in order to get the data from it. Currently, there are two primary APIs that applications can use to traverse an XML file: DOM and SAX.

Document Object Model
The Document Object Model (DOM) provides the most obvious way of accessing data in an XML file. An XML document is essentially a tree: the root element of the XML document is the root node of the tree, and child elements in the XML document are the children of the root node. The DOM API provides an application with a tree data-structure that directly mirrors the XML file. The DOM API provides the ability to traverse the tree from one node to the next: parent-to-child, child-to-sibling, child-to-parent, etc.

Application developers use the API to write code that traverses the tree and performs processing on the tree's nodes (e.g., extract some piece of data). The trouble with the DOM API is twofold. First (and obviously), application developers must write the code that traverses the tree. However, this is often an unnecessary re-invention of the wheel. Many applications traverse the tree in a standard depth-first approach. It is unfortunate that the developer must spend time writing the actual tree-walking code, when it has been written before by countless developers.

The second drawback of the DOM API is the integration of the tree-walking code with the node-processing code. One of the hallmarks of good software design is the separation of concerns. This means the developer tries to separate the logical pieces of the code into separate methods/functions/modules. The unfortunate design of the DOM API requires that the complex code that walks the XML tree must be interspersed with the, quite possibly, complex code to process individual nodes.

The following code fragment illustrates the complexity of processing XML nodes using the DOM API. In this example we traverse an XML tree grabbing all the "color" elements and swapping the black and white ones.


demoChildNodes = document.getElementsByTagName("color");
for (int i = 0;i < demoChildNodes.getLength(); i++) {
if(demoChildNodes.item(i).getFirstChild().toString().equals("black"))
      demoChildNodes.item(i).getFirstChild().setNodeValue("white");

   if(demoChildNodes.item(i).getFirstChild().toString().equals("white"))
      demoChildNodes.item(i).getFirstChild().setNodeValue("black");
}

Simple API for XML (SAX)
The Simple API for XML (SAX), first published in 1998, was developed as an event-based API for processing XML. Hot on the heels of the XML specification itself, it was well received by the development community.

SAX works by processing the XML one node at a time, creating a streaming process opposed to a static one. Event handlers are added to an XML document much in the same way they are added to a user interface. Such events are triggered as the application processes the document. Using this technique creates a very fast processing method, with a much smaller memory profile. This makes SAX appropriate for tasks such as searching a document for a specific node, or making small change to the entire document such as search and replace.

The down side is the lack of directional control, the document can only be process red in a "top to bottom" direction. Tasks like reordering nodes and cross-referencing are not practical. Also, while the specific syntax for simple documents (or simple processing tasks) is not overwhelming, SAX does not scale well for more complicated solutions. Listing 1 is a short example (the code for this article is online at www.sys-con.com/xml/sourcec.cfm).

The other drawback to SAX is the granularity of the event handlers. SAX is "coarse-grained" in the sense that large structural XML components invoke the same handler. For example, all "element" nodes would invoke the startElement() method. Many applications require a "finer-grained" event handler. For example, invoke a specific method when an "employee" element is reached.

Visitor Pattern
The problem of separating data-structure traversal from data-structure analysis/process is well-known. One standard technique of ensuring a separation of these components is the Visitor Pattern. One way of understanding the Visitor Pattern is that it allows operations to be added to a class (the pattern is an object-oriented one) without having to actually change the class. However, in the context of tree-walking, the Visitor Pattern is best understood as providing the capability of applying an endless number of node processors to a tree without having to change the definition of the node itself: it separates the node-processing code from the node definition.

For example, assume we have a tree data structure encapsulated in a tree class. This class defines a root node class that has links to its child nodes. Using the Visitor Pattern, we can define a MyVisitor class that has a method visitNode() that performs some kind of processing at each node in the tree. However, the Visitor Pattern allows us to focus the method on the node-processing code itself, and not the tree-traversal code. Once these two classes are defined, we could "apply" our visitor to our tree with the code: my Tree.accept(my Visitor); This would start a depth-first traversal of the tree and at each Node the My Visitor.visitNode()method would be called, allowing us to apply processing to each node.

In the future, if we want to update the processing, we would only need to modify the MyVisitor class. The tree and node classes would remain untouched. If we want to perform a different kind of processing on the tree, we would simply define a MyOther Visitor class with a visitNode() method and then apply our new visitor to the tree with: myTree. accept(my Other Visitor). Once again, the existing tree and node classes are untouched.

Visiting the DOM
We have developed a prototype DOM visitor in Java that supports the Visitor Pattern. The implementation is quite straightforward. A visitoradapter class encapsulates the tree-walking code and provides for standard depth-first traversal. Obviously, this class can be overridden to provide for more complex tree traversals.

The other major component of the prototype is the alteration of the NodeImpl class and the Node interface inside org.w3c.dom, which provides for the implementation of a DOM Node. The only change necessary is the addition of an accept() method that takes a Visitor class as a parameter and invokes the appropriate visitXXX() method in the Visitor class (where XXX is the name of the element). The accept() method uses reflection to determine which method to call in the visitor. Using reflection, the visitor Pattern provides the kind of "fine-grained" visitation that most applications require.

Another benefit of the Visitor Pattern is that it combines useful features of both DOM and SAX. The Visitor Pattern is "event-driven" to the extent the specific methods are called when specific nodes are reached in the tree. Furthermore, within a specific visit method, one can use the DOM API to traverse the tree in nonlinear ways, overcoming a significant limitation of SAX.

Hopefully, you have already begun to see the ease of using the Visitor Pattern as it applies to the XML DOM. Using this Pattern the developer can define numerous DOM analyzers and processors and apply them to a DOM tree. All of the tree-walking code can be handled automatically through the adapter class.

For example, Listing 2 encodes games in a chess library.

Using a Visitor Pattern, one can intuitively visit the nodes in the XML tree and apply processing to selected elements (see Listing 3).

If other kinds of processing need to be done, then the developer must only declare a new visitor class (extending VisitorAdapter) and provide appropriate visitXXX() methods.

Summary
Extending the DOM API to support the Visitor Pattern means that XML application developers are freed from writing tree-traversal code and can focus their efforts on the processing of each XML element. Another benefit is that if several operations are required to use the same XML data, the development workload can be easily divided among several programmers. The processing workload can be split among several processors or threads as well.

Extending the Java/Xerces DOM implementation is straight-forward and we urge Sun to consider incorporating our changes into a future release of the API.

References

  • Gamma, Erich; Helm, Richard; Johnson, Ralph; Vlissides, John. (1995) Design Patterns: Elements of Reusable Object-Oriented Software. Addison-Wesley Professional.
  • Comments (0)

    Share your thoughts on this story.

    Add your comment
    You must be signed in to add a comment. Sign-in | Register

    In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


    IoT & Smart Cities Stories
    "Space Monkey by Vivent Smart Home is a product that is a distributed cloud-based edge storage network. Vivent Smart Home, our parent company, is a smart home provider that places a lot of hard drives across homes in North America," explained JT Olds, Director of Engineering, and Brandon Crowfeather, Product Manager, at Vivint Smart Home, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
    In an era of historic innovation fueled by unprecedented access to data and technology, the low cost and risk of entering new markets has leveled the playing field for business. Today, any ambitious innovator can easily introduce a new application or product that can reinvent business models and transform the client experience. In their Day 2 Keynote at 19th Cloud Expo, Mercer Rowe, IBM Vice President of Strategic Alliances, and Raejeanne Skillern, Intel Vice President of Data Center Group and G...
    The current age of digital transformation means that IT organizations must adapt their toolset to cover all digital experiences, beyond just the end users’. Today’s businesses can no longer focus solely on the digital interactions they manage with employees or customers; they must now contend with non-traditional factors. Whether it's the power of brand to make or break a company, the need to monitor across all locations 24/7, or the ability to proactively resolve issues, companies must adapt to...
    DXWorldEXPO LLC announced today that ICC-USA, a computer systems integrator and server manufacturing company focused on developing products and product appliances, will exhibit at the 22nd International CloudEXPO | DXWorldEXPO. DXWordEXPO New York 2018, colocated with CloudEXPO New York 2018 will be held November 11-13, 2018, in New York City. ICC is a computer systems integrator and server manufacturing company focused on developing products and product appliances to meet a wide range of ...
    René Bostic is the Technical VP of the IBM Cloud Unit in North America. Enjoying her career with IBM during the modern millennial technological era, she is an expert in cloud computing, DevOps and emerging cloud technologies such as Blockchain. Her strengths and core competencies include a proven record of accomplishments in consensus building at all levels to assess, plan, and implement enterprise and cloud computing solutions. René is a member of the Society of Women Engineers (SWE) and a m...
    DXWorldEXPO | CloudEXPO are the world's most influential, independent events where Cloud Computing was coined and where technology buyers and vendors meet to experience and discuss the big picture of Digital Transformation and all of the strategies, tactics, and tools they need to realize their goals. Sponsors of DXWorldEXPO | CloudEXPO benefit from unmatched branding, profile building and lead generation opportunities.
    Founded in 2000, Chetu Inc. is a global provider of customized software development solutions and IT staff augmentation services for software technology providers. By providing clients with unparalleled niche technology expertise and industry experience, Chetu has become the premiere long-term, back-end software development partner for start-ups, SMBs, and Fortune 500 companies. Chetu is headquartered in Plantation, Florida, with thirteen offices throughout the U.S. and abroad.
    SYS-CON Events announced today that DatacenterDynamics has been named “Media Sponsor” of SYS-CON's 18th International Cloud Expo, which will take place on June 7–9, 2016, at the Javits Center in New York City, NY. DatacenterDynamics is a brand of DCD Group, a global B2B media and publishing company that develops products to help senior professionals in the world's most ICT dependent organizations make risk-based infrastructure and capacity decisions.
    CloudEXPO New York 2018, colocated with DXWorldEXPO New York 2018 will be held November 11-13, 2018, in New York City and will bring together Cloud Computing, FinTech and Blockchain, Digital Transformation, Big Data, Internet of Things, DevOps, AI, Machine Learning and WebRTC to one location.
    @DevOpsSummit at Cloud Expo, taking place November 12-13 in New York City, NY, is co-located with 22nd international CloudEXPO | first international DXWorldEXPO and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time t...