|By Shari Jones||
|August 17, 2001 12:00 AM EDT||
This second of a two-part series on JDOM examines in greater detail what it takes to use JDOM to perform some common tasks. In particular, I'll illustrate how to create JDOM documents, read JDOM documents from various sources (including SAX and DOM), output to various sources, and how to use JDOM with XSLT.
The overview of JDOM discussed in Part 1 (XML-J, Vol. 2, issue 7) revealed that JDOM bridges the gap between inconsistencies in DOM parser APIs via adapters. It also takes SAX and DOM to the next level in terms of ease of use, by compensating for the weaknesses of these APIs when it comes to XML document manipulation.
Part 1 explored the JDOM API and the packages and classes that are most significant for developing in JDOM. The main components of a JDOM document that were defined in Part 1 are critical prerequisites for understanding this article.
Creating a JDOM Document
JDOM documents can be created in two ways - from scratch or from some other input source, such as an XML document, a series of SAX events, or a DOM document. First, we'll discuss how to create a JDOM document in memory from scratch, and then, in the next section, we'll address how to output that document in various different formats.
After we create a JDOM document and show how to output its content, we will demonstrate how to input an existing XML document, a series of SAX events, or a DOM document, and convert it into a JDOM document, which is the second option for creating a JDOM document.
Creating a JDOM Document in Memory
Let's begin by creating a JDOM document in memory, from scratch. Since JDOM was written with the Java developer in mind (keeping as close to Java standards as possible), creating a new JDOM document in memory is straightforward for Java developers.
To create a JDOM document in memory using the core JDOM classes, Document and Element from the org.jdom package, use the following code:
Document doc = new Document( new
.setText("Hello World!") );
This creates, in memory, a bare bones JDOM document and stores it in the variable doc. That's all there is to it. Next, we'll look at outputting this document to the screen, so we can see what it looks like in XML.
Outputting JDOM Documents
After creating a JDOM document, it can be output using one of three primary ways:
1. org.jdom.output.DOMOutputter: As a DOM document
2. org.jdom.output.SAXOutputter: As a sequence of SAX events
3. org.jdom.output.XMLOutputter: As an XML document to a file or an output stream
As part of the org.jdom.output package, XMLOutputter outputs a JDOM document to an output stream, such as the screen, or to a file. Alternatively, the SAXOutputter or DOMOutputter classes, also of the org.jdom.output package, can be used to output the JDOM document as a series of SAX events or as a DOM document, respectively.
In Listing 1, we illustrate output using XMLOutputter to output to the standard output stream, System.out, which by default is the screen when running in a DOS/UNIX command window.
When a JDOM document is output as an XML document, it's output as one or two long lines of XML code unless you specify otherwise. This is fine if it's being sent to another application or system for processing, and is actually the most compact. However, it makes it very difficult to read and see the structure.
To format the XML output to improve readability - by humans, not computers - we can specify a couple of parameters when creating the XMLOutputter. The first parameter defines the level of indentation - usually as a sequence of spaces - and the second is a Boolean value that, if set to true, causes new lines to be added to the output.
Here's an example:
outputter = new XMLOutputter(" ",
We use this approach in our HelloWorld example shown later in the article.
Note that since XMLOutputter contains methods to output a JDOM document to a java.io.OutputStream as well as to a java.io.Writer, you can use the same approach whether outputting to a file, an output stream (such as across a network), to the screen, or to any other form of Writer or OutputStream.
Other output methods in XMLOutputter allow you to output just parts of the JDOM document such as CDATA sections, comments, elements, entities, and processing instructions. We talked about each of these components in Part 1.
The JDOM document created as described in the last example will be output to the screen. The code required is in Listing 1.
To compile this file, first ensure that you have set up your Java environment correctly for use with JDOM. Your CLASSPATH must include the xerces.jar file found in the lib subdirectory of your JDOM distribution. The xerces.jar file should be followed in the CLASSPATH by the jdom.jar file from the build subdirectory of your JDOM distribution.
Next, to compile the HelloWorld.java file, type the following code:
After the HelloWorld.java file compiles, run the HelloWorld application using:
This produces the following output:
<?xml version="1.0" encoding="UTF-8"?> <root-element>Hello World!</root-element>
The root-element tag is from the code defined in the HelloWorld.java file, specifically from the line that instantiates a new Element. Here is the code that defines the name of the new Element.
The text "Hello World!" also was defined in the code in the HelloWorld.java file and by the call to the setText method. The following code defines the text for the root element:
new Element("root-element").setText("Hello World!")
As you can see, using JDOM, it's possible to produce perfectly valid XML output with little prior knowledge of XML. This was one of the original goals of JDOM.
Outputting Using DOMOutputter
We just saw how to output a JDOM document as an XML file. Using DOMOutputter, we can output a JDOM document as a DOM document. This is useful when interfacing with another application or system that expects a DOM document as its input.
The following lines of code show how to create and use DOMOutputter to output a JDOM document, doc.
DOMOutputter outputter = new DOMOutputter(); outputter.output( doc );
In addition to outputting JDOM documents, DOMOutputter also provides methods that allow you to output JDOM elements and attributes. See the JDOM API documentation for details.
Outputting Using SAXOutputter
We just saw how to output a JDOM document as an XML file and as a DOM document. The final way to output a JDOM document is as a sequence of SAX events. This is useful for interfacing with applications or components that handle a series of SAX events.
When constructing a SAXOutputter, you must specify a SAX content handler (actually an org.xml.sax.ContentHandler) as a minimum. You then have the option of specifying a SAX error handler (org.xml.sax.ErrorHandler), DTD handler (org.xml.sax.DTDHandler), and entity handler (org.xml.sax.EntityHandler) after you have created the SAXOutputter object.
The following lines of code show how to create and use SAXOutputter to output a JDOM document, doc.
SAXOutputter outputter = new SAXOutputter( contentHandler ); outputter.output( doc );
After creating a SAXOutputter object, you need to invoke the output() method to pass the JDOM document object you want to output to the outputter.
Inputting to JDOM Documents
Earlier in this article we saw how to create a JDOM document from scratch. Another way of creating a JDOM document is to read an XML document or input stream (using a SAX parser), or input a DOM document. Again, we will use an output stream to output the JDOM document.
To input an XML file, input stream, or DOM document as a JDOM document, use the SAXBuilder or DOMBuilder classes, respectively, from the org.jdom.input package.
Inputting Using SAXBuilder
Perhaps the most common means of building a JDOM document is to use SAXBuilder. SAXBuilder uses a SAX parser to parse an XML input file or input stream. Building a JDOM document using SAXBuilder is a two-step process.
In step one, you need to create a new instance of a SAXBuilder object. Next, invoke one of the build methods for reading the XML input and building a JDOM document object.
Four different constructors are available for creating a new SAXBuilder object, the primary one using the default SAX parser as determined by JAXP. Validation is turned off. It can be enabled and disabled after the construction of a SAXBuilder object by using the setValidation() method.
The other three constructors allow more control over whether or not validation is enabled or disabled and in choosing an alternate SAX parser.
After creating a SAXBuilder object, other methods are available that allow us to initialize it with a custom DTD handler, Entity resolver, XML filter, and error handler.
Once we have instantiated a new SAXBuilder object, we can use it to build a JDOM document. There are seven different publicly accessible build methods available.
The main differences between the seven build methods lie in where the XML input is to come from. It can come from a variety of sources, including one specified by a java.io.File, java.io.InputStream, java.io.Reader, a URI specified as a java.lang.String, or a java.net.URL.
SAX parsers tend to be the first choice over DOM parsers because of their speed when reading in XML and generating a JDOM document. If you prefer not to use the default SAX parser with SAXBuilder, you can always substitute a third-party SAX parser.
Simply pass the name of the SAX Driver class to the SAXBuilder constructor when creating the builder. Make sure that the classes required by the alternate parser are available in your CLASSPATH. SAXBuilder will then use the specified SAX parser to build a JDOM document.
Inputting Using DOMBuilder
An alternative to the SAXBuilder is the DOMBuilder. The DOMBuilder class is intended to allow us to build a JDOM document from a preexisting DOM document. It uses basically the same steps as when using SAXBuilder.
First, create a new instance of a DOMBuilder object. Next, invoke one of the build methods to read the XML input and build a JDOM document object.
To create a new DOMBuilder object, four different constructors are available. The default constructor creates a new DOMBuilder using the default DOM parser - as specified by the default JAXP parser, or a JDOM default if not. Validation is turned off.
The default constructor with no validation suffices for most purposes, but the other three constructors allow for greater control when selecting a DOM parser. They also allow you to enable or disable validation.
After creating a DOMBuilder object, use one of the DOMBuilder.build methods to build a JDOM document from an existing DOM document object. This build method is just like the SAXBuilder.build methods except that it takes an org.w3c.dom.Document object as a single argument for its input.
In addition, DOMBuilder contains a build method that allows you to construct a JDOM element object directly from a DOM element (org.w3c.dom.Element) object. The DOMBuilder class is intended primarily as a way of generating a JDOM document from a preexisting DOM document.
The DOMBuilder class contains three additional DOMBuilder.build methods, each of these taking a single argument - either a java.io.File, java.io.InputStream, or a java.net.URL - and building a JDOM document from a file, input stream, or URL, respectively. These other methods are provided as a means of cross-checking the SAXBuilder.build methods, which is the recommended parser for XML parsing.
Generating a JDOM document using a DOM parser is slow, hence the SAX parser recommendation. The only possible exception to not using a SAX parser (via the SAXBuilder class) is if you are trying to validate the correct operation of the SAXBuilder class.
Working Together: JDOM and XSLT
One of the more common questions posted to the JDOM-interest discussion list centers on using JDOM with XSLT. There are several ways to do this. Below we look at one such way using a couple of classes from the JDOM-contrib repository.
Now that we have seen how to create, input, and output a JDOM document object, let's see how to feed it into an XSLT processor to transform one JDOM document into another.
XSLT Transformations Using JDOMResult and JDOMSource
The example described later assumes that you have downloaded and installed the JDOM-contrib files from the JDOM Web site. Refer to Part 1 of this series for details on downloading and installing JDOM. The JDOM-contrib files contain two classes intended to make using JDOM with XSLT quite straightforward. These are JDOMResult and JDOMSource. You can access these, provided the JDOM-contrib.jar file is (or its classes are) in your CLASSPATH.
In addition to the JDOM-contrib files, this example also makes use of classes from the Java API for XML Processing (JAXP) 1.1.
In Listing 2 there's a transform method - in the class XSLTDemo - that takes a JDOM document and the name of an XSLT file, then using JDOMResult and JDOMSource, transforms it according to the instructions in the given XSLT file. The transform method then returns the resulting JDOM document.
I thank Laurent Bihanic for this example, and the contribution of JDOMSource and JDOMResult to the JDOM-contrib repository.
Family Matters: Working with Children
One of the useful features of JDOM is that it allows developers to add and remove elements with a single line of code in its simplest form. For example, developers can create a child element from one line of code instead of requiring a factory method to create it for them after requesting it. However, more business logic may need to be added for greater functionality.
Once you have a JDOM document, you'll want to traverse it and possibly manipulate certain elements. JDOM makes manipulation of child elements as easy as manipulating a Java 2 List. To obtain a list of child Elements belonging to a given element, use one of the getChildren methods:
List children = element.getChildren();
List children = element.getChildren
( name );
List children = element.getChildren
( name, namespace );
These methods return a list of child elements belonging to the Element, element. If no children exist, the returned list will be empty.
Any changes to the returned list object will automatically be reflected in the underlying JDOM document. Since each of these methods return a Java 2 List object, then adding, removing, and reordering children are performed using native Java 2 List operations.
For example, to create a new child Element and add it as the second child to a list, use something like the following:
Element newChild =
.setText("new child element");
children.add( 1, newChild );
Note that since the first item in a list is numbered 0, then the second item has an index of 1. Hence, the above code adds the newChild element as the second child in the list, children.
Similarly, to remove the first element (index 0) from the list, use the following:
children.remove( 0 );
The change is automatically reflected in the associated JDOM document, and the first child will be removed from the document.
As another JDOM code safety check, JDOM validates the document structure, making sure you don't have duplicate nodes above and below a child, which would result in an infinite loop. In other words, JDOM overrides the add and remove methods and makes sure there's only one parent for each child element and that that same child does not exist in a conflicting position on the tree.
This two-part series on JDOM examined in detail how this open-source Java API simplifies XML document manipulation when compared with the previous alternatives. It also describes how JDOM interacts with existing APIs for document manipulation, such as SAX and DOM. JDOM's tight, Java-centric design makes XML document creation, manipulation, transformation, and parsing a no-brainer for Java developers.
In these articles, we explored the purpose that JDOM serves in filling in the gaps where SAX and DOM fail in XML document manipulation. We also explored the JDOM API in depth, then in Part 2 we demonstrated how to use the API to perform common tasks such as inputting and outputting JDOM documents, as well as how to use JDOM with XSLT.
JDOM recently was accepted as a Java Specification Request (JSR-102) by the Java Community Process (JCP). As such, expect to hear a great deal more about JDOM in the future as it continues to be embraced by the Java community.
Special thanks to Steven Gould for sharing his expertise in JDOM and working so diligently with me on this series.
1. JDOM: www.jdom.org
2. JDOM discussion lists: www.jdom.org/involved/lists.html
3. Java API for XML Processing (JAXP): http://java.sun.com/xml/xml_jaxp.html
4. The Collections API for JDK 1.1: www.java.sun.com/products/javabeans/infobus/
5. For an alternative way of using JDOM with XSLT, see "Using JDOM and XSLT: How to Find the Right Input for Your Processor," IBM developerWorks, March 2001, by Brett McLaughlin (www-106.ibm.com/developerworks/xml/library/x-tipjdom.html).
The basic integration architecture, as defined by ESBs, hasn’t changed for more than a decade. Most cloud integration providers still rely on an ESB architecture and their proprietary connectors. As a result, enterprise integration projects suffer from constraints of availability and reliability of these connectors that are not re-usable across other integration vendors. However, the rapid adoption of APIs and almost ubiquitous availability of APIs amongst most SaaS and Cloud applications are rapidly redefining traditional integration approaches and their reliance on proprietary connectors. ...
Jul. 2, 2015 03:18 PM EDT Reads: 697
The Internet of Things is not only adding billions of sensors and billions of terabytes to the Internet. It is also forcing a fundamental change in the way we envision Information Technology. For the first time, more data is being created by devices at the edge of the Internet rather than from centralized systems. What does this mean for today's IT professional? In this Power Panel at @ThingsExpo, moderated by Conference Chair Roger Strukhoff, panelists addressed this very serious issue of profound change in the industry.
Jul. 2, 2015 02:30 PM EDT Reads: 1,229
Internet of Things is moving from being a hype to a reality. Experts estimate that internet connected cars will grow to 152 million, while over 100 million internet connected wireless light bulbs and lamps will be operational by 2020. These and many other intriguing statistics highlight the importance of Internet powered devices and how market penetration is going to multiply many times over in the next few years.
Jul. 2, 2015 02:15 PM EDT Reads: 2,226
Today air travel is a minefield of delays, hassles and customer disappointment. Airlines struggle to revitalize the experience. GE and M2Mi will demonstrate practical examples of how IoT solutions are helping airlines bring back personalization, reduce trip time and improve reliability. In their session at @ThingsExpo, Shyam Varan Nath, Principal Architect with GE, and Dr. Sarah Cooper, M2Mi’s VP Business Development and Engineering, will explore the IoT cloud-based platform technologies driving this change including privacy controls, data transparency and integration of real time context wi...
Jul. 2, 2015 02:00 PM EDT Reads: 1,085
Internet of Things (IoT) will be a hybrid ecosystem of diverse devices and sensors collaborating with operational and enterprise systems to create the next big application. In their session at @ThingsExpo, Bramh Gupta, founder and CEO of robomq.io, and Fred Yatzeck, principal architect leading product development at robomq.io, discussed how choosing the right middleware and integration strategy from the get-go will enable IoT solution developers to adapt and grow with the industry, while at the same time reduce Time to Market (TTM) by using plug and play capabilities offered by a robust IoT ...
Jul. 2, 2015 12:00 PM EDT Reads: 2,055
"We have a tagline - "Power in the API Economy." What that means is everything that is built in applications and connected applications is done through APIs," explained Roberto Medrano, Executive Vice President at Akana, in this SYS-CON.tv interview at 16th Cloud Expo, held June 9-11, 2015, at the Javits Center in New York City.
Jul. 2, 2015 11:15 AM EDT Reads: 1,084
Explosive growth in connected devices. Enormous amounts of data for collection and analysis. Critical use of data for split-second decision making and actionable information. All three are factors in making the Internet of Things a reality. Yet, any one factor would have an IT organization pondering its infrastructure strategy. How should your organization enhance its IT framework to enable an Internet of Things implementation? In his session at @ThingsExpo, James Kirkland, Red Hat's Chief Architect for the Internet of Things and Intelligent Systems, described how to revolutionize your archit...
Jul. 2, 2015 09:30 AM EDT Reads: 876
WebRTC converts the entire network into a ubiquitous communications cloud thereby connecting anytime, anywhere through any point. In his session at WebRTC Summit,, Mark Castleman, EIR at Bell Labs and Head of Future X Labs, will discuss how the transformational nature of communications is achieved through the democratizing force of WebRTC. WebRTC is doing for voice what HTML did for web content.
Jul. 2, 2015 09:24 AM EDT Reads: 671
It is one thing to build single industrial IoT applications, but what will it take to build the Smart Cities and truly society-changing applications of the future? The technology won’t be the problem, it will be the number of parties that need to work together and be aligned in their motivation to succeed. In his session at @ThingsExpo, Jason Mondanaro, Director, Product Management at Metanga, discussed how you can plan to cooperate, partner, and form lasting all-star teams to change the world and it starts with business models and monetization strategies.
Jul. 2, 2015 08:00 AM EDT Reads: 2,328
To many people, IoT is a buzzword whose value is not understood. Many people think IoT is all about wearables and home automation. In his session at @ThingsExpo, Mike Kavis, Vice President & Principal Cloud Architect at Cloud Technology Partners, discussed some incredible game-changing use cases and how they are transforming industries like agriculture, manufacturing, health care, and smart cities. He will discuss cool technologies like smart dust, robotics, smart labels, and much more. Prepare to be blown away with a glimpse of the future.
Jul. 2, 2015 07:30 AM EDT Reads: 950
SYS-CON Events announced today that BMC will exhibit at SYS-CON's 16th International Cloud Expo®, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY. BMC delivers software solutions that help IT transform digital enterprises for the ultimate competitive business advantage. BMC has worked with thousands of leading companies to create and deliver powerful IT management services. From mainframe to cloud to mobile, BMC pairs high-speed digital innovation with robust IT industrialization – allowing customers to provide amazing user experiences with optimized IT per...
Jun. 29, 2015 12:15 PM EDT Reads: 2,751
There will be 150 billion connected devices by 2020. New digital businesses have already disrupted value chains across every industry. APIs are at the center of the digital business. You need to understand what assets you have that can be exposed digitally, what their digital value chain is, and how to create an effective business model around that value chain to compete in this economy. No enterprise can be complacent and not engage in the digital economy. Learn how to be the disruptor and not the disruptee.
Jun. 29, 2015 11:00 AM EDT Reads: 2,222
The Internet of Things is not only adding billions of sensors and billions of terabytes to the Internet. It is also forcing a fundamental change in the way we envision Information Technology. For the first time, more data is being created by devices at the edge of the Internet rather than from centralized systems. What does this mean for today's IT professional? In this Power Panel at @ThingsExpo, moderated by Conference Chair Roger Strukhoff, panelists will addresses this very serious issue of profound change in the industry.
Jun. 29, 2015 09:45 AM EDT Reads: 2,576
Business as usual for IT is evolving into a "Make or Buy" decision on a service-by-service conversation with input from the LOBs. How does your organization move forward with cloud? In his general session at 16th Cloud Expo, Paul Maravei, Regional Sales Manager, Hybrid Cloud and Managed Services at Cisco, discusses how Cisco and its partners offer a market-leading portfolio and ecosystem of cloud infrastructure and application services that allow you to uniquely and securely combine cloud business applications and services across multiple cloud delivery models.
Jun. 28, 2015 11:00 AM EDT Reads: 2,290
In his General Session at 16th Cloud Expo, David Shacochis, host of The Hybrid IT Files podcast and Vice President at CenturyLink, investigated three key trends of the “gigabit economy" though the story of a Fortune 500 communications company in transformation. Narrating how multi-modal hybrid IT, service automation, and agile delivery all intersect, he will cover the role of storytelling and empathy in achieving strategic alignment between the enterprise and its information technology.
Jun. 27, 2015 10:00 AM EDT Reads: 2,302
Buzzword alert: Microservices and IoT at a DevOps conference? What could possibly go wrong? In this Power Panel at DevOps Summit, moderated by Jason Bloomberg, the leading expert on architecting agility for the enterprise and president of Intellyx, panelists peeled away the buzz and discuss the important architectural principles behind implementing IoT solutions for the enterprise. As remote IoT devices and sensors become increasingly intelligent, they become part of our distributed cloud environment, and we must architect and code accordingly. At the very least, you'll have no problem fillin...
Jun. 26, 2015 12:00 PM EDT Reads: 2,292
Growth hacking is common for startups to make unheard-of progress in building their business. Career Hacks can help Geek Girls and those who support them (yes, that's you too, Dad!) to excel in this typically male-dominated world. Get ready to learn the facts: Is there a bias against women in the tech / developer communities? Why are women 50% of the workforce, but hold only 24% of the STEM or IT positions? Some beginnings of what to do about it! In her Opening Keynote at 16th Cloud Expo, Sandy Carter, IBM General Manager Cloud Ecosystem and Developers, and a Social Business Evangelist, d...
Jun. 26, 2015 10:00 AM EDT Reads: 2,167
Converging digital disruptions is creating a major sea change - Cisco calls this the Internet of Everything (IoE). IoE is the network connection of People, Process, Data and Things, fueled by Cloud, Mobile, Social, Analytics and Security, and it represents a $19Trillion value-at-stake over the next 10 years. In her keynote at @ThingsExpo, Manjula Talreja, VP of Cisco Consulting Services, discussed IoE and the enormous opportunities it provides to public and private firms alike. She will share what businesses must do to thrive in the IoE economy, citing examples from several industry sectors.
Jun. 25, 2015 02:00 PM EDT Reads: 2,083
In his keynote at 16th Cloud Expo, Rodney Rogers, CEO of Virtustream, discussed the evolution of the company from inception to its recent acquisition by EMC – including personal insights, lessons learned (and some WTF moments) along the way. Learn how Virtustream’s unique approach of combining the economics and elasticity of the consumer cloud model with proper performance, application automation and security into a platform became a breakout success with enterprise customers and a natural fit for the EMC Federation.
Jun. 25, 2015 01:30 PM EDT Reads: 2,222
SYS-CON Events announced today that the "Second Containers & Microservices Conference" will take place November 3-5, 2015, at the Santa Clara Convention Center, Santa Clara, CA, and the “Third Containers & Microservices Conference” will take place June 7-9, 2016, at Javits Center in New York City. Containers and microservices have become topics of intense interest throughout the cloud developer and enterprise IT communities.
Jun. 22, 2015 02:15 PM EDT Reads: 2,894