Home > Articles > Web Services > XML

  • Print
  • + Share This
This chapter is from the book

ResultSet to XML

RStoXML is a class that will return a JDOM representation of a database ResultSet upon the invocation of the build() method. Before this method is used, properties of the returned JDOM document can be specified. Some of the properties available include changing the default element names from the record column names and declaring columns to be created as attributes instead of elements. Another important property available is the maximum number of records that will be converted into the JDOM representation. The use of this property will be demonstrated in the next chapter when a paging report is created.

This class is a starting point for the creation of a more versatile production-oriented object. The capability to filter which columns of the ResultSet get included in the JDOM creation can easily be added with another HashMap, some more property setting methods, and some additional logic in the build() method.

What It Does

RStoXML.java at its simplest will create a JDOM document from a ResultSet object. At its default setting, RStoXML will create sibling Element nodes for each field of data found in a record. These nodes will be placed together as children of an Element node, each of which represents a record. This causes the record elements to be children of the root node, and all data containing elements to be grandchildren.

For example, the default XML structure returned from RStoXML is shown following Table 11.1, which contains two sample records.

Table 11.1. Two Records from the ReportClientData Table

RCD_index RCD_lname RCD_fname RCD_dob RCD_clinic RCD_color
1 Nowitz Kerry 1970-08-29 1 yellow
2 Muller Todd 1981-02-08 2 green

Using all the defaults of RStoXML, the sample records found in Table 11.1 would result in a JDOM representation of the XML document shown in Listing 11.2.

Listing 11.2 Default JDOM Document Returned from RStoXML


RStoXML is not limited to outputting Elements to represent the structure of the ResultSet. Methods such as setAsAttribute() and setAllAttribute() exist to set one or all columns of data to attributes of the RECORD element. For example, if setAllAttribute() were invoked before the JDOM representation were built through the build() method, the JDOM structure as represented in Listing 11.3 would result.

Listing 11.3 JDOM Document Returned from RStoXML

  <RECORD RCD_index="1" RCD_lname="Nowitz" RCD_fname="Kerry"
          RCD_dob="1970-08-29" RCD_clinic="1" RCD_color="yellow" />
  <RECORD RCD_index="2" RCD_lname="Muller" RCD_fname="Todd"
          RCD_dob="1981-02-08" RCD_clinic="2" RCD_color="green" />

Nor is RStoXML limited to the default column names that exist in the database table definition. Sometimes these names can be very long, depending upon the database schema. As a result, methods such as setName() permit the setting of the attribute or element name with which a ResultSet data column will be labeled.

The source code to this class follows in Listing 11.4. It will not be explained because it is straightforward Java. Save and compile this file as webapps\xmlbook\WEB-INF\classes\xmlbook\chapter11.

Listing 11.4 RStoXML.java

package xmlbook.chapter11;

import java.io.*;
import java.sql.*;
import java.text.*;
import java.util.*;
import org.jdom.*;

public class RStoXML {

    private SQLException exception;

    private ResultSet rs;
    private int intColCount;
    private ResultSetMetaData rsmd;

    //key is original column name keyed to replacement name
    private Map newNames = new HashMap();
    //key is original db column, true or false
    private Map attribs = new HashMap();
    int maxRows = Integer.MAX_VALUE;        // default to all
    private String rootName = "ROOT";
    private String rowName = "RECORD";

     public RStoXML(ResultSet rs) {
     this.rs = rs;
     try {
        rsmd = rs.getMetaData();
        intColCount = rsmd.getColumnCount();

      catch (SQLException e) {
        // Hold the exception until build() is called
        exception = e;

    public RStoXML(ResultSet rs, String rootName, String rowName)  {


    public Document build() throws JDOMException {
      if (exception != null) {
        throw new JDOMException("Database problem", exception);
      try {

        Element root = new Element(rootName);
        Document doc = new Document(root);

        int rowCount = 0;

        // get column names for the record set
        String[] columnName = new String[intColCount];
        for (int index = 0; index < intColCount; index++) {
          columnName[index] = rsmd.getColumnName(index+1);

        // build the org.jdom.Document out of the result set
        String name;
        String value;
        Element record;
        Element child;

        while (rs.next() && (rowCount++ < maxRows)) {
            record = new Element(rowName);
            for (int col = 1; col <= intColCount; col++) {
                if (newNames.isEmpty() ||
                    (newNames.get(columnName[col-1].toLowerCase()) == null))
                    name = columnName[col-1];
                    name = lookupName(columnName[col-1]);
                value = rs.getString(col);
                if ( attribs.containsKey(columnName[col-1].toLowerCase())) {
                    //if the value of the column is in attribs
                    //and notnull create attribute
                    record.setAttribute(name, value);
                else {
                    //other wise create child element
                    child = new Element(name);
                    if (!rs.wasNull())

            return doc;
            catch (SQLException e) {
                throw new JDOMException("Database problem", e) ;
    //origName is column name in db, if name exists in the newNames hashmap
    //return it, else returned passed in name.
   private String lookupName(String origName) {
                  String name = (String) newNames.get(origName.toLowerCase());
                  if (name != null) {
                    return name;
                  else {
                    return origName;

    public void setRootName(String rootName) {
      this.rootName = rootName;

    public void setRowName(String rowName) {
      this.rowName = rowName;

    public void setMaxRows(int maxRows) {
      this.maxRows = maxRows;

    public void setAsAttribute(String columnName, String attribName) {
      String name = columnName.toLowerCase();
      attribs.put(name, "t");
      newNames.put(name, attribName);

    public void setAllAttribute() throws JDOMException{
            int intColCount = rsmd.getColumnCount();
            for (int index = 0; index < intColCount; index++) {
                attribs.put(rsmd.getColumnName(index+1).toLowerCase(), "t");
        } catch (SQLException e) {
        throw new JDOMException("Database problem", e);
    public void setName(String columnName, String name){
        newNames.put(columnName.toLowerCase(), name);
   //set a database column name to a specific element name
   public void setAsName(String columnName, String elemName) {
      String name = columnName.toLowerCase();
      newNames.put(name, elemName);

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020