The Element class
When you want to extract data from an Element the most important
methods are these:
|
Method |
Return type |
Purpose |
|
getName |
String |
The name of the element |
|
getText |
String |
The text content of the element |
|
getAttributes |
List (of Attributes) |
All attributes for the element |
|
getAttribute(String) |
Attribute |
A specific attribute for the element |
|
getChildren() |
List (of Elements) |
All children of the element |
|
getChildren(String) |
List (of Elements) |
All children with a specific name |
|
getChild(String) |
Element |
The one (or first) child with a specific name |
|
getParent |
Element |
The parent of the element |
Not all methods are shown here, but for our examples these are
the essential ones. The List's returned from three methods are
"live", and any modifications to them will directly influence the
contents of the document. To show you what the methods will return
I'll first use a very simple example--an element with an attribute
and no children:
|
<country code="DK">Denmark</country> |
|
method |
returns |
|
getName |
country |
|
getText |
Denmark |
|
getAttribute("code") |
DK |
|
getChildren() |
an empty List collection |
-Table 1-
Another element, "movie", with two children elements:
|
<movie>
<title>The Matrix</title>
<actor>Keanu Reeves</actor>
</movie> |
|
method |
returns |
|
getName |
movie |
|
getText |
three newline characters and some spaces |
|
getChild("title") |
the title Element |
|
getChildren() |
a List with the title and actor Element |
-Table 2-
If you're surprised about the result from getText then it's simply
the characters between the movie start- and end-tags
when we remove the title- and actor-tags and text.
The Attribute class
The Attribute class doesn't have any "children" so it's quite
simple. The most important "getters" for the Attribute
class are:
|
Method |
Return type |
Purpose |
|
getName |
String |
The name of the attribute |
|
getValue |
String |
The textual value of the attribute |
|
get<type>Value |
<type> |
Convenience methods to get the value in one of several formats:
<type> may be boolean, double, float, int, or long |
|
getParent |
Element |
The parent of the attribute |
- Table 3-
Listing the contents of an XML-file
As the first exercise we'll write a small Java program that lists
all the elements and attributes from a given XML-file.
It's run from the command line, and you must give the name of an
XML-file as the parameter. Starting with the root element the
"listElements" method lists the name, textual contents, all the
attributes and then the children elements using a recursive
call:
package hansen.playground;
import org.jdom.*;
import org.jdom.input.*;
import org.jdom.output.*;
import java.util.*;
/*
* Read an XML file and show all elements (text and attributes)
*/
public class BuildAndListDocument {
/*
* Assume filename as parameter
*/
public static void main(String[] args) {
BuildAndListDocument b = new BuildAndListDocument();
b.buildAndListDocument(args[0]);
}
public void buildAndListDocument(String filename) {
try {
SAXBuilder builder = new SAXBuilder();
Document doc = builder.build(filename);
listElements(doc.getRootElement());
} catch (JDOMException e) {
e.printStackTrace();
}
}
private void listElements(Element e) {
System.out.println("*Element, name:" + e.getName() +
", text:" + e.getText()) ;
//List all attributes
List as = e.getAttributes();
for (Iterator i = as.iterator();i.hasNext();) {
Attribute a = (Attribute)i.next();
System.out.println("*Attribute, name:" + a.getName() +
", value:" + a.getValue()) ;
}
//List all children
List c = e.getChildren();
for (Iterator i = c.iterator();i.hasNext();) {
Element n = (Element)i.next();
listElements(n);
}
}
}
If we use the movie-element from Table 2 we'll get this printed out:
*Element, name:movie, text:
*Element, name:title, text:The Matrix
*Element, name:actor, text:Keanu Reeves |
Important: The jdom-packages that are imported can be
downloaded from www.jdom.org.
To run the program you'll have to add jdom.jar and xerces.jar
(the Xerces parser) to your classpath.
New on the Java Boutique:
New Review:
Time Management Made Easy with the Quartz Enterprise Job Scheduler
Why not just use the Java timer API? This open source scheduling
API boasts simplicity, ease-of-integration, a well-rounded feature
set, and it's free!
New Applet:
Reverse Complement
Reverse Complement is a simple applet that converts DNA or RNA
sequences into three useful formats.
Elsewhere on internet.com:
WebDeveloper Java
Lots of Java information on webdeveloper.com
WDVL Java
Thorough Java resource at the Web Developer's Virtual Library.
ScriptSearch Java
Hundreds of free Java code files to download.
jGuru: Your View of the Java Universe
Customizable portal with online training, FAQs, regular news updates, and tutorials.
|