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++) {


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.

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.


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

    @ThingsExpo Stories
    Predicting the future has never been more challenging - not because of the lack of data but because of the flood of ungoverned and risk laden information. Microsoft states that 2.5 exabytes of data are created every day. Expectations and reliance on data are being pushed to the limits, as demands around hybrid options continue to grow.
    Poor data quality and analytics drive down business value. In fact, Gartner estimated that the average financial impact of poor data quality on organizations is $9.7 million per year. But bad data is much more than a cost center. By eroding trust in information, analytics and the business decisions based on these, it is a serious impediment to digital transformation.
    Business professionals no longer wonder if they'll migrate to the cloud; it's now a matter of when. The cloud environment has proved to be a major force in transitioning to an agile business model that enables quick decisions and fast implementation that solidify customer relationships. And when the cloud is combined with the power of cognitive computing, it drives innovation and transformation that achieves astounding competitive advantage.
    Digital Transformation: Preparing Cloud & IoT Security for the Age of Artificial Intelligence. As automation and artificial intelligence (AI) power solution development and delivery, many businesses need to build backend cloud capabilities. Well-poised organizations, marketing smart devices with AI and BlockChain capabilities prepare to refine compliance and regulatory capabilities in 2018. Volumes of health, financial, technical and privacy data, along with tightening compliance requirements by...
    As IoT continues to increase momentum, so does the associated risk. Secure Device Lifecycle Management (DLM) is ranked as one of the most important technology areas of IoT. Driving this trend is the realization that secure support for IoT devices provides companies the ability to deliver high-quality, reliable, secure offerings faster, create new revenue streams, and reduce support costs, all while building a competitive advantage in their markets. In this session, we will use customer use cases...
    Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settlement products to hedge funds and investment banks. After, he co-founded a revenue cycle management company where he learned about Bitcoin and eventually Ethereal. Andrew's role at ConsenSys Enterprise is a mul...
    DXWorldEXPO LLC announced today that "Miami Blockchain Event by FinTechEXPO" has announced that its Call for Papers is now open. The two-day event will present 20 top Blockchain experts. All speaking inquiries which covers the following information can be submitted by email to [email protected] Financial enterprises in New York City, London, Singapore, and other world financial capitals are embracing a new generation of smart, automated FinTech that eliminates many cumbersome, slow, and expe...
    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.
    The best way to leverage your Cloud Expo presence as a sponsor and exhibitor is to plan your news announcements around our events. The press covering Cloud Expo and @ThingsExpo will have access to these releases and will amplify your news announcements. More than two dozen Cloud companies either set deals at our shows or have announced their mergers and acquisitions at Cloud Expo. Product announcements during our show provide your company with the most reach through our targeted audiences.
    DevOpsSummit New York 2018, colocated with CloudEXPO | DXWorldEXPO New York 2018 will be held November 11-13, 2018, in New York City. Digital Transformation (DX) is a major focus with the introduction of DXWorldEXPO within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of bus...
    With 10 simultaneous tracks, keynotes, general sessions and targeted breakout classes, @CloudEXPO and DXWorldEXPO are two of the most important technology events of the year. Since its launch over eight years ago, @CloudEXPO and DXWorldEXPO have presented a rock star faculty as well as showcased hundreds of sponsors and exhibitors! In this blog post, we provide 7 tips on how, as part of our world-class faculty, you can deliver one of the most popular sessions at our events. But before reading...
    Cloud Expo | DXWorld Expo have announced the conference tracks for Cloud Expo 2018. Cloud Expo will be held June 5-7, 2018, at the Javits Center in New York City, and November 6-8, 2018, at the Santa Clara Convention Center, Santa Clara, CA. Digital Transformation (DX) is a major focus with the introduction of DX Expo within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive ov...
    DXWordEXPO New York 2018, colocated with CloudEXPO 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.
    DXWorldEXPO LLC announced today that ICOHOLDER named "Media Sponsor" of Miami Blockchain Event by FinTechEXPO. ICOHOLDER give you detailed information and help the community to invest in the trusty projects. Miami Blockchain Event by FinTechEXPO has opened its Call for Papers. The two-day event will present 20 top Blockchain experts. All speaking inquiries which covers the following information can be submitted by email to [email protected] Miami Blockchain Event by FinTechEXPO also offers s...
    Dion Hinchcliffe is an internationally recognized digital expert, bestselling book author, frequent keynote speaker, analyst, futurist, and transformation expert based in Washington, DC. He is currently Chief Strategy Officer at the industry-leading digital strategy and online community solutions firm, 7Summits.
    Digital Transformation and Disruption, Amazon Style - What You Can Learn. Chris Kocher is a co-founder of Grey Heron, a management and strategic marketing consulting firm. He has 25+ years in both strategic and hands-on operating experience helping executives and investors build revenues and shareholder value. He has consulted with over 130 companies on innovating with new business models, product strategies and monetization. Chris has held management positions at HP and Symantec in addition to ...
    Cloud-enabled transformation has evolved from cost saving measure to business innovation strategy -- one that combines the cloud with cognitive capabilities to drive market disruption. Learn how you can achieve the insight and agility you need to gain a competitive advantage. Industry-acclaimed CTO and cloud expert, Shankar Kalyana presents. Only the most exceptional IBMers are appointed with the rare distinction of IBM Fellow, the highest technical honor in the company. Shankar has also receive...
    Enterprises have taken advantage of IoT to achieve important revenue and cost advantages. What is less apparent is how incumbent enterprises operating at scale have, following success with IoT, built analytic, operations management and software development capabilities - ranging from autonomous vehicles to manageable robotics installations. They have embraced these capabilities as if they were Silicon Valley startups.
    The standardization of container runtimes and images has sparked the creation of an almost overwhelming number of new open source projects that build on and otherwise work with these specifications. Of course, there's Kubernetes, which orchestrates and manages collections of containers. It was one of the first and best-known examples of projects that make containers truly useful for production use. However, more recently, the container ecosystem has truly exploded. A service mesh like Istio addr...
    With tough new regulations coming to Europe on data privacy in May 2018, Calligo will explain why in reality the effect is global and transforms how you consider critical data. EU GDPR fundamentally rewrites the rules for cloud, Big Data and IoT. In his session at 21st Cloud Expo, Adam Ryan, Vice President and General Manager EMEA at Calligo, examined the regulations and provided insight on how it affects technology, challenges the established rules and will usher in new levels of diligence arou...