|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).
SYS-CON Events announced today that Soha will exhibit at SYS-CON's DevOps Summit New York, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY. Soha delivers enterprise-grade application security, on any device, as agile as the cloud. This turnkey, cloud-based service enables customers to solve secure application access and delivery challenges that traditional or virtualized network solutions cannot solve because they are too expensive, inflexible and operational...
Apr. 19, 2015 03:45 AM EDT Reads: 1,446
Chef and Canonical announced a partnership to integrate and distribute Chef with Ubuntu. Canonical is integrating the Chef automation platform with Canonical's Machine-As-A-Service (MAAS), enabling users to automate the provisioning, configuration and deployment of bare metal compute resources in the data center. Canonical is packaging Chef 12 server in upcoming distributions of its Ubuntu open source operating system and will provide commercial support for Chef within its user base.
Apr. 19, 2015 02:45 AM EDT Reads: 1,724
SYS-CON Events announced today that Site24x7, the cloud infrastructure monitoring service, 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. Site24x7 is a cloud infrastructure monitoring service that helps monitor the uptime and performance of websites, online applications, servers, mobile websites and custom APIs. The monitoring is done from 50+ locations across the world and from various wireless carr...
Apr. 19, 2015 02:30 AM EDT Reads: 1,820
SYS-CON Events announced today that B2Cloud, a provider of enterprise resource planning software, 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. B2cloud develops the software you need. They have the ideal tools to help you work with your clients. B2Cloud’s main solutions include AGIS – ERP, CLOHC, AGIS – Invoice, and IZUM
Apr. 19, 2015 02:00 AM EDT Reads: 3,144
SYS-CON Events announced today that Tufin, the market-leading provider of Security Policy Orchestration Solutions, 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. As the market leader of Security Policy Orchestration, Tufin automates and accelerates network configuration changes while maintaining security and compliance. Tufin's award-winning Orchestration Suite™ gives IT organizations the power and a...
Apr. 19, 2015 01:45 AM EDT Reads: 3,303
The 5th International DevOps Summit, co-located with 17th International Cloud Expo – being held November 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA – announces that its Call for Papers is open. Born out of proven success in agile development, cloud computing, and process automation, DevOps is a macro trend you cannot afford to miss. From showcase success stories from early adopters and web-scale businesses, DevOps is expanding to organizations of all sizes, including the...
Apr. 19, 2015 01:45 AM EDT Reads: 2,023
SYS-CON Events announced today that kintone has been named “Bronze Sponsor” of 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, and the 17th International Cloud Expo®, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. kintone promotes cloud-based workgroup productivity, transparency and profitability with a seamless collaboration space, build your own business applic...
Apr. 19, 2015 01:00 AM EDT Reads: 1,499
SYS-CON Events announced today that Cloudian, Inc., the leading provider of hybrid cloud storage solutions, 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. Cloudian, Inc., is a Foster City, California - based software company specializing in cloud storage software. The main product is Cloudian, an Amazon S3-compliant cloud object storage platform, the bedrock of cloud computing systems, that enables c...
Apr. 19, 2015 01:00 AM EDT Reads: 2,381
SYS-CON Events announced today that Cisco, the worldwide leader in IT that transforms how people connect, communicate and collaborate, has been named “Gold Sponsor” of 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. Cisco makes amazing things happen by connecting the unconnected. Cisco has shaped the future of the Internet by becoming the worldwide leader in transforming how people connect, communicate and collaborat...
Apr. 18, 2015 11:15 PM EDT Reads: 5,605
SYS-CON Events announced today that Open Data Centers (ODC), a carrier-neutral colocation provider, will exhibit at SYS-CON's 16th International Cloud Expo®, which will take place June 9-11, 2015, at the Javits Center in New York City, NY. Open Data Centers is a carrier-neutral data center operator in New Jersey and New York City offering alternative connectivity options for carriers, service providers and enterprise customers.
Apr. 18, 2015 09:30 PM EDT Reads: 2,501
SYS-CON Events announced today that Akana, formerly SOA Software, has been named “Bronze Sponsor” of SYS-CON's 16th International Cloud Expo® New York, which will take place June 9-11, 2015, at the Javits Center in New York City, NY. Akana’s comprehensive suite of API Management, API Security, Integrated SOA Governance, and Cloud Integration solutions helps businesses accelerate digital transformation by securely extending their reach across multiple channels – mobile, cloud and Internet of Thi...
Apr. 18, 2015 07:45 PM EDT Reads: 1,798
SYS-CON Events announced today that StorPool Storage 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. StorPool is distributed storage software that allows service providers, enterprises and other cloud builders to run data storage on standard x86 servers, instead of using expensive and inefficient storage arrays (SAN).
Apr. 18, 2015 06:00 PM EDT Reads: 1,972
While DevOps most critically and famously fosters collaboration, communication, and integration through cultural change, culture is more of an output than an input. In order to actively drive cultural evolution, organizations must make substantial organizational and process changes, and adopt new technologies, to encourage a DevOps culture. Moderated by Andi Mann, panelists will discuss how to balance these three pillars of DevOps, where to focus attention (and resources), where organizations m...
Apr. 18, 2015 05:00 PM EDT Reads: 1,695
How do you securely enable access to your applications in AWS without exposing any attack surfaces? The answer is usually very complicated because application environments morph over time in response to growing requirements from your employee base, your partners and your customers. In his session at 16th Cloud Expo, Haseeb Budhani, CEO and Co-founder of Soha, will share five common approaches that DevOps teams follow to secure access to applications deployed in AWS, Azure, etc., and the frict...
Apr. 18, 2015 04:30 PM EDT Reads: 1,403
of cloud, colocation, managed services and disaster recovery solutions, 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. TierPoint, LLC, is a leading national provider of information technology and data center services, including cloud, colocation, disaster recovery and managed IT services, with corporate headquarters in St. Louis, MO. TierPoint was formed through the strategic combination of some of t...
Apr. 18, 2015 04:00 PM EDT Reads: 1,337
There's a real buzz about microservices and containers in the application development and DevOps communities, and of course these are topics we've been talking about a great deal lately here at XebiaLabs too. Microservices and containers offer many attractive features, not least the potential for enhanced flexibility, and a robust architecture based on best-fit services. What we at XebiaLabs are really interested in is how organizations can effectively deliver microservices-based apps to bett...
Apr. 18, 2015 03:00 PM EDT Reads: 1,950
SYS-CON Events announced today that Vicom Computer Services, Inc., a provider of technology and service solutions, 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. They are located at booth #427. Vicom Computer Services, Inc. is a progressive leader in the technology industry for over 30 years. Headquartered in the NY Metropolitan area. Vicom provides products and services based on today’s requirements...
Apr. 18, 2015 02:00 PM EDT Reads: 1,384
Today, the demand for new applications is growing at an unprecedented rate throughout lines of business and across industries. Customer expectations for mobile and e-commerce capabilities are transforming software development speed and quality into a competitive differentiator for even the most unlikely businesses. For existing software development shops, the proliferation of platforms, increasing need for total global uptime, and accelerating pace of industry disruption by fast-paced startups h...
Apr. 18, 2015 01:30 PM EDT Reads: 1,211
SYS-CON Events announced today that MangoApps 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., and the 17th International Cloud Expo®, which will take place on November 3–5, 2015, at the Santa Clara Convention Center in Santa Clara, CA. MangoApps provides private all-in-one social intranets allowing workers to securely collaborate from anywhere in the world and from any device. Social, mobile, and eas...
Apr. 18, 2015 01:15 PM EDT Reads: 3,547
Change becomes the central principle of today’s enterprises, and thus business agility becomes the most important characteristic our organizations must exhibit. Agile Architecture lays out a best practice approach for achieving this agility – and thus drives and coordinates the other revolutions, as both digital and DevOps are about being able to deal with change better as well.
Apr. 18, 2015 12:45 PM EDT Reads: 1,331