Home > Articles > Web Services > XML

  • Print
  • + Share This
Like this article? We recommend

The XML Data Adapter

Now that we’ve seen how XSLT can take us from XML to HTML, it’s time to discuss how XSLT can take us from one XML dialect to another. XML-to-XML transformations are useful when you need data in a slightly different format and don’t want to rewrite software to cope with change. In the vocabulary of design patterns, we can use XSLT to build an XML Data Adapter.

To put the problem into context, let’s jump a bit into the future, where your success in establishing a web presence for ZwiftBooks has increased company visibility. Now EuroBooks, a European book distributor, has entered into an agreement with ZwiftBooks for rapid book delivery to Europe. EuroBooks sends ZwiftBooks an XML order, and ZwiftBooks responds expeditiously by getting the books on the next flight to the appropriate European city.

This arrangement has been wildly successful. Software has been developed to process incoming XML from EuroBooks. A problem has arisen, however. Another distribution company, AsiaBooks, is interested in setting up a similar arrangement, but they’re adamant about using a different XML format for their orders.

Figure 3 shows the EuroBooks and AsiaBooks XML. Notice that there are two significant differences:

  • In the EuroBooks XML, isbn is an attribute; in the AsiaBooks XML, isbn is an element.
  • The top-level element name for EuroBooks is request, while for AsiaBooks it’s order.
Figure 3

Figure 3 EuroBooks vs. AsiaBooks XML orders.

The ZwiftBooks programming staff claims that they’ll have to rewrite their code to handle the new data format, and complain that with two different data formats they’ll have to maintain two separate software versions, which will require additional staff. AsiaBooks is a big potential customer for ZwiftBooks, and they want to plug into the ZwiftBooks order system immediately. The programming staff requires at least several weeks to get things up and running. As the XML guru, you’ve been called in to help. What to do?

XSLT to the Rescue

Your solution to the problem of handling multiple XML data formats is four letters: XSLT. Rather than have the programming staff write new code to handle the new format, an XSLT transform adapter can be used to change AsiaBooks XML into EuroBooks XML, so that the existing software can be used to process the AsiaBooks order. This approach can be used to work with different customers (and can also be used to help manage data-format version control within an organization). Rather than having to support different implementations that depend on different data formats, an XML adapter can transform one data version to another. This approach can be especially useful in an agile development environment, where refactoring over several iterations is considered the norm.

To see how to set up such a transform let’s start with some XSLT that simply copies its XML input to output. Once we see how a complete copy is done, we can then focus on the parts we want to give special treatment—in our case, turning the isbn attribute into an element and changing the name of the request element to order.

The easiest way to copy something with XSLT is to use the <xsl:copy> element, which tells the XSLT engine to make a copy of whatever is in context. Listing 3 shows a simple style sheet that makes a pure copy of its input.

Listing 3 XSLT that copies input to output.

 1. <?xml version="1.0" ?>
 2. <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
 3.
 4. <xsl:template match="node() | @*">
 5.  <xsl:copy>
 6.   <xsl:apply-templates select="node() | @* "/>
 7.  </xsl:copy>
 8. </xsl:template>
 9.
10. </xsl:stylesheet>

Now the details:

  • Line 4: Begins our rule that says to match "node ( ) | @* " (which we can read "as any node or attribute"). In XPath, nodes mean any element, CDATA section, comment, or processing instruction—but not attributes. Attributes are special; that’s why we need to say node or attribute in our match expression.
  • Lines 5–7: Tells the XSLT processor what to do when it finds a node or an attribute: Copy it (in XSLT parlance, <xsl:copy>). But so that the process doesn’t stop here, we need to add line 6.
  • Line 6: Tells the XSLT processor to keep going, applying all the template rules (we only have one) to any nodes or attributes it finds as it moves down the XML tree.

Adding More Specific Rules

The XSLT with one template rule will give us as output the same XML we feed in as input. This will serve as the basis for our task at hand; namely, to change an element name and then to convert an attribute to an element.

Changing an Element Name

To change the element name from request to order, we need a special rule that matches for the element request when as we travel down the document tree. When we get a match, we simply insert a new element into the output, using <xsl:element name="order">, which will generate an order element. To keep the XSLT processor traveling down the tree, we need to insert <xsl:apply-templates/> as the value of xsl:element. Thus, our new rule becomes the following:

<xsl:template match="request">

 <xsl:element name="order">
  <xsl:apply-templates/>
 </xsl:element>

</xsl:template>

Converting from Attribute to Element

To change an attribute to an element, we need a rule that matches the attribute of interest and creates an element of the same name. The following template rule will do this for us:

<xsl:template match="@isbn">

<xsl:element name="isbn">
  <xsl:value-of select=".">
 </xsl:value-of></xsl:element>

</xsl:template>

As the XSLT processor travels down the tree, it considers our match (match="@isbn") for every node in the tree. When our rule kicks in, an isbn element is generated with a value of ".", which, in the context of the tree, refers to the value of the isbn attribute. Thus, if the processor finds isbn="123456789", it will insert the following into the output document:

<isbn>123456789</isbn>

Putting it all together, we get the style sheet in Listing 4.

Listing 4 XSLT for transforming AsiaBooks XML into EuroBooks XML format.

<?xml version="1.0" encoding="UTF-8"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

 <xsl:output method="xml" version="1.0" encoding="UTF-8" indent="yes"/>

 <xsl:template match="node() | @*">
  <xsl:copy>
   <xsl:apply-templates select="node() | @* "/>
  </xsl:copy>
 </xsl:template>

 <xsl:template match="request">
  <xsl:element name="order">
   <xsl:apply-templates/>
  </xsl:element>
 </xsl:template>

 <xsl:template match="@isbn">
  <xsl:element name="isbn">
   <xsl:value-of select=".">
  </xsl:value-of></xsl:element>
 </xsl:template>

</xsl:stylesheet>

The XSLT in Listing 4 contains three rules packaged together, which provides an opportunity to explain the rule-matching that occurs in multi-template XSLT. As the XSLT processor moves from node to node down the XML document tree, it checks at each "node stop" to see whether any of the rules in its template set match. If a template rule matches, content of that template is output. But if several rules apply, the more specific rule is applied. In our example, two rules apply as we travel the tree and come to the request element node. These are the two matching template rules:

match="node() | @*"
match="request"

Since request is a specific node name, whereas node() refers to any node in the entire tree, the rule for template overrides the rule for node(); therefore, instead of copying the request element, a new element, order, is created. Similarly, for the attribute isbn, the rule that uses match="@isbn" specifically names the attribute it seeks, while match="@*" is more general. Thus, instead of copying the attribute, a new element isbn is created and output.

  • + 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.

Overview


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.

Surveys

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.

Newsletters

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.

Security


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

Children


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

Marketing


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.

Choice/Opt-out


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.

Links


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