|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 cloud promises new levels of agility and cost-savings for Big Data, data warehousing and analytics. But it’s challenging to understand all the options – from IaaS and PaaS to newer services like HaaS (Hadoop as a Service) and BDaaS (Big Data as a Service). In her session at @BigDataExpo at @ThingsExpo, Hannah Smalltree, a director at Cazena, provided an educational overview of emerging “as-a-service” options for Big Data in the cloud. This is critical background for IT and data professionals...
Dec. 3, 2016 11:00 PM EST Reads: 4,131
"Once customers get a year into their IoT deployments, they start to realize that they may have been shortsighted in the ways they built out their deployment and the key thing I see a lot of people looking at is - how can I take equipment data, pull it back in an IoT solution and show it in a dashboard," stated Dave McCarthy, Director of Products at Bsquare Corporation, in this SYS-CON.tv interview at @ThingsExpo, held November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA.
Dec. 3, 2016 11:00 PM EST Reads: 949
Fact is, enterprises have significant legacy voice infrastructure that’s costly to replace with pure IP solutions. How can we bring this analog infrastructure into our shiny new cloud applications? There are proven methods to bind both legacy voice applications and traditional PSTN audio into cloud-based applications and services at a carrier scale. Some of the most successful implementations leverage WebRTC, WebSockets, SIP and other open source technologies. In his session at @ThingsExpo, Da...
Dec. 3, 2016 09:30 PM EST Reads: 1,599
As data explodes in quantity, importance and from new sources, the need for managing and protecting data residing across physical, virtual, and cloud environments grow with it. Managing data includes protecting it, indexing and classifying it for true, long-term management, compliance and E-Discovery. Commvault can ensure this with a single pane of glass solution – whether in a private cloud, a Service Provider delivered public cloud or a hybrid cloud environment – across the heterogeneous enter...
Dec. 3, 2016 06:15 PM EST Reads: 1,513
"IoT is going to be a huge industry with a lot of value for end users, for industries, for consumers, for manufacturers. How can we use cloud to effectively manage IoT applications," stated Ian Khan, Innovation & Marketing Manager at Solgeniakhela, in this SYS-CON.tv interview at @ThingsExpo, held November 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA.
Dec. 3, 2016 05:30 PM EST Reads: 4,045
Today we can collect lots and lots of performance data. We build beautiful dashboards and even have fancy query languages to access and transform the data. Still performance data is a secret language only a couple of people understand. The more business becomes digital the more stakeholders are interested in this data including how it relates to business. Some of these people have never used a monitoring tool before. They have a question on their mind like “How is my application doing” but no id...
Dec. 3, 2016 05:15 PM EST Reads: 2,138
@GonzalezCarmen has been ranked the Number One Influencer and @ThingsExpo has been named the Number One Brand in the “M2M 2016: Top 100 Influencers and Brands” by Onalytica. Onalytica analyzed tweets over the last 6 months mentioning the keywords M2M OR “Machine to Machine.” They then identified the top 100 most influential brands and individuals leading the discussion on Twitter.
Dec. 3, 2016 05:15 PM EST Reads: 2,001
Information technology is an industry that has always experienced change, and the dramatic change sweeping across the industry today could not be truthfully described as the first time we've seen such widespread change impacting customer investments. However, the rate of the change, and the potential outcomes from today's digital transformation has the distinct potential to separate the industry into two camps: Organizations that see the change coming, embrace it, and successful leverage it; and...
Dec. 3, 2016 03:15 PM EST Reads: 3,224
Extracting business value from Internet of Things (IoT) data doesn’t happen overnight. There are several requirements that must be satisfied, including IoT device enablement, data analysis, real-time detection of complex events and automated orchestration of actions. Unfortunately, too many companies fall short in achieving their business goals by implementing incomplete solutions or not focusing on tangible use cases. In his general session at @ThingsExpo, Dave McCarthy, Director of Products...
Dec. 3, 2016 02:45 PM EST Reads: 529
The Internet of Things (IoT) promises to simplify and streamline our lives by automating routine tasks that distract us from our goals. This promise is based on the ubiquitous deployment of smart, connected devices that link everything from industrial control systems to automobiles to refrigerators. Unfortunately, comparatively few of the devices currently deployed have been developed with an eye toward security, and as the DDoS attacks of late October 2016 have demonstrated, this oversight can ...
Dec. 3, 2016 02:45 PM EST Reads: 715
Machine Learning helps make complex systems more efficient. By applying advanced Machine Learning techniques such as Cognitive Fingerprinting, wind project operators can utilize these tools to learn from collected data, detect regular patterns, and optimize their own operations. In his session at 18th Cloud Expo, Stuart Gillen, Director of Business Development at SparkCognition, discussed how research has demonstrated the value of Machine Learning in delivering next generation analytics to impr...
Dec. 3, 2016 02:15 PM EST Reads: 6,957
More and more brands have jumped on the IoT bandwagon. We have an excess of wearables – activity trackers, smartwatches, smart glasses and sneakers, and more that track seemingly endless datapoints. However, most consumers have no idea what “IoT” means. Creating more wearables that track data shouldn't be the aim of brands; delivering meaningful, tangible relevance to their users should be. We're in a period in which the IoT pendulum is still swinging. Initially, it swung toward "smart for smar...
Dec. 3, 2016 02:00 PM EST Reads: 483
20th Cloud Expo, taking place June 6-8, 2017, at the Javits Center in New York City, NY, will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud strategy.
Dec. 3, 2016 01:30 PM EST Reads: 2,131
Businesses and business units of all sizes can benefit from cloud computing, but many don't want the cost, performance and security concerns of public cloud nor the complexity of building their own private clouds. Today, some cloud vendors are using artificial intelligence (AI) to simplify cloud deployment and management. In his session at 20th Cloud Expo, Ajay Gulati, Co-founder and CEO of ZeroStack, will discuss how AI can simplify cloud operations. He will cover the following topics: why clou...
Dec. 3, 2016 01:15 PM EST Reads: 634
"ReadyTalk is an audio and web video conferencing provider. We've really come to embrace WebRTC as the platform for our future of technology," explained Dan Cunningham, CTO of ReadyTalk, in this SYS-CON.tv interview at WebRTC Summit at 19th Cloud Expo, held November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA.
Dec. 3, 2016 01:00 PM EST Reads: 331
Internet of @ThingsExpo, taking place June 6-8, 2017 at the Javits Center in New York City, New York, is co-located with the 20th International Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. @ThingsExpo New York Call for Papers is now open.
Dec. 3, 2016 01:00 PM EST Reads: 1,876
Successful digital transformation requires new organizational competencies and capabilities. Research tells us that the biggest impediment to successful transformation is human; consequently, the biggest enabler is a properly skilled and empowered workforce. In the digital age, new individual and collective competencies are required. In his session at 19th Cloud Expo, Bob Newhouse, CEO and founder of Agilitiv, drew together recent research and lessons learned from emerging and established compa...
Dec. 3, 2016 12:45 PM EST Reads: 741
Data is the fuel that drives the machine learning algorithmic engines and ultimately provides the business value. In his session at Cloud Expo, Ed Featherston, a director and senior enterprise architect at Collaborative Consulting, discussed the key considerations around quality, volume, timeliness, and pedigree that must be dealt with in order to properly fuel that engine.
Dec. 3, 2016 12:45 PM EST Reads: 1,956
Everyone knows that truly innovative companies learn as they go along, pushing boundaries in response to market changes and demands. What's more of a mystery is how to balance innovation on a fresh platform built from scratch with the legacy tech stack, product suite and customers that continue to serve as the business' foundation. In his General Session at 19th Cloud Expo, Michael Chambliss, Head of Engineering at ReadyTalk, discussed why and how ReadyTalk diverted from healthy revenue and mor...
Dec. 3, 2016 12:15 PM EST Reads: 1,512
We are always online. We access our data, our finances, work, and various services on the Internet. But we live in a congested world of information in which the roads were built two decades ago. The quest for better, faster Internet routing has been around for a decade, but nobody solved this problem. We’ve seen band-aid approaches like CDNs that attack a niche's slice of static content part of the Internet, but that’s it. It does not address the dynamic services-based Internet of today. It does...
Dec. 3, 2016 11:30 AM EST Reads: 857