Home > Articles > Open Source > Ajax & JavaScript

Using JavaScript with XSLT Style Sheets

📄 Contents

  1. Extending the Basic Style Sheet
  2. Define the Functionality
  3. Summary
Learn to use XSLT style sheets to transform XML data from one from one structure to another.
Like this article? We recommend

Like this article? We recommend









Most XML developers are familiar with the use of XSLT style sheets to transform their XML data from one from one structure to another. For example, the following XML






<?xml version="1.0"?>
<personnel>
	<employee>
		<fullname>Karen Smith</fullname>
		<phone>352-555-1234</phone>
	</employee>
	<employee>
		<fullname>John Drew</fullname>
		<phone>329-555-8827</phone>
	</employee>
</personnel>

can be easily translated to

<html>
<head>
<title>Phone List</title></head>
<body>
<h1>Employee List</h1>
<ul>
  <li>Karen Smith (352-555-1234)</li>
  <li>John Drew (329-555-8827)</li>
  <li>Frank McCartney (983-555-8273)</li>
</ul>
</body>
</html>

with the appropriate style sheet, such as

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

<xsl:template match="/">
<html>
<head><title>Phone List</title></head>
<body>
<h1>Employee List</h1>
	<ul>
	<xsl:apply-templates/>
	</ul>
</body>
</html>
</xsl:template>

<xsl:template match="employee">
  <li>
    <xsl:value-of select="fullname"/> 
    (<xsl:value-of select="phone"/>)
  </li>
</xsl:template>
 
</xsl:stylesheet>

The templates and XPath functions used by them allow for fairly complex and sophisticated transformations, but even they are sometimes not enough.

For this reason, the XSLT Recommendation provides a way for XSLT implementers to extend, or add functionality to their applications. For example, the Xalan-Java 2 XSLT processor from the Apache project has a redirect extension that allows developers to indicate that subsequent content should be sent to a new file, allowing an application to split an XML file into, say, different pages for each subject.

The recommendation doesn't stop there, however. It also allows implementers to define a way for developers to add their own functionality using external applications in languages such as Java, C++, or (as in the case of this article) JavaScript.

These extensions take the form of extension functions, which are used in a way similar to XPath functions; and extension elements, which provide even more functionality.

The Plan

Suppose you have an XML file that contains commerce information, and you want to transform it into a summary of orders. Unfortunately, the XML file doesn't actually contain any customer information. Instead, it contains a customer identifier that refers back to a database.

This article will chronicle the building of a style sheet that uses extension functions and elements to allow calculations and a call to an external function that would, in a production application, return the customer information.

(You can also download the source file and style sheet here, along with a command line script to execute the transformation.)

Source and Result Files

Let's start with a look at where we're starting out, and where we're going. The original XML file contains just the basics, as shown in Listing 1.

Listing 1—The Source Document

<?xml version="1.0"?>
<orders> 
  <order orderid="23" custid="969982">
    <product itemid="ATL322">
      <quantity>1</quantity>
      <price>280</price>
    </product>
    <product itemid="ORE948">
      <quantity>3</quantity>
      <price>49</price>
    </product>
  </order>
  <order orderid="24" custid="39488">
    <product itemid="ZPI88">
      <quantity>200</quantity>
      <price>1.72</price>
    </product>
  </order>
</orders>

The end result is a Web page that shows each order, including the extended price for each item and the customer information, as shown in Listing 2 and Figure 1.

Listing 2—The Final Result

<html>
<head><title>Order Summaries</title></head>
<body>
  <h1>Order Summaries</h1> 
  <p><b>Customer Information: </b>Darling Clementine, Inc., 
228 Range Road, Oklahoma City, OK 73101
  <br /><b>Order number: </b>23</p>

  <table border="1" width="50%">
    <tr>
      <th>Product Number</th>
      <th>Quantity</th>
      <th>Unit Price</th>
      <th>Extended Price</th>
    </tr>
    <tr>
      <td>ATL322</td><td>1</td><td>280</td><td>280</td>
    </tr>
    <tr>
      <td>ORE948</td><td>3</td><td>49</td><td>147</td>
    </tr>
    <tr>
      <td align="right" colspan="3">Order Total: </td>
      <td>427</td>
    </tr>
  </table>
  <br>
  <hr>
  <br>
  
  <p><b>Customer Information: </b>Into the Wind, LLC, 849 
Research Way, Suite 399, Miami Beach, FL 33109
  <br /><b>Order number: </b>24</p>

  <table border="1" width="50%">
    <tr>
      <th>Product Number</th>
      <th>Quantity</th>
      <th>Unit Price</th>
      <th>Extended Price</th>
    </tr>
    <tr>
      <td>ZPI88</td><td>200</td><td>1.72</td><td>344</td>
    </tr>
    <tr>
      <td align="right" colspan="3">Order Total: </td> 
      <td>344</td>
    </tr>
  </table>
  <br>
  <hr>
  <br>

</body>
</html>

Figure 1 The final result.

The extended prices and order total will come from extension functions, and the customer information will be provided by an extension elements. We'll also use extension elements to "zero out" the totals between orders.

Extending the Basic Style Sheet

We'll start by putting together the basic style sheet, with placeholders for the extensions. The overall format is laid out in Listing 3.

Listing 3—The Basic Style Sheet

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

 <xsl:template match="/">

   <html>
   <head><title>Order Summaries</title></head>
   <body>

     <h1>Order Summaries</h1>

     <xsl:apply-templates/>

   </body>
   </html>

 </xsl:template>

 <xsl:template match="order">
   <p><b>Customer Information: </b>(CUSTOMER INFORMATION)
   <br /><b>Order number: </b><xsl:value-of select="@orderid"/></p>

   <table width="50%" border="1">
     <tr>
       <th>Product Number</th>
       <th>Quantity</th>
       <th>Unit Price</th>
       <th>Extended Price</th>
     </tr>
     <xsl:apply-templates select="product"/>
     <tr>
       <td colspan="3" align="right">Order Total: </td>
       <td>(ORDER TOTAL)</td>
     </tr>
   </table>
   <br /><hr /><br />

 </xsl:template>

 <xsl:template match="product">
  <tr>
    <td><xsl:value-of select="@itemid"/></td>
    <td><xsl:value-of select="quantity"/></td>
    <td><xsl:value-of select="price"/></td>
    <td>(EXTENDED PRICE)</td>
  </tr>
 </xsl:template>
 
</xsl:stylesheet>

All of this is just standard XSLT. The placeholders are shown in bold.

Adding an Extension Function

Now let's add in the extensions to see how they're used. Later, we'll define the functionality that goes behind them.

We'll start with the extension function. XPath has a number of built-in functions, such as round() and concat(). These functions can take XPath expressions as arguments, and because they themselves are XPath expressions, we output them using the value-of element. For example, we could round off prices to the nearest dollar using the round() function:

...
 <xsl:template match="product">
  <tr>
    <td><xsl:value-of select="@itemid"/></td>
    <td><xsl:value-of select="quantity"/></td>
    <td><xsl:value-of select="round(price)"/></td>
    <td>(EXTENDED PRICE)</td>
  </tr>
 </xsl:template>
...

In this same way, we can add a new function, which we'll define later, as shown in Listing 4.

Listing 4—Adding an Extension Function

<?xml version="1.0"?> 
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
        xmlns:totalSys="TotalSystem"
        version="1.0">
...
 <xsl:template match="order">
   <p><b>Customer Information: </b>(CUSTOMER INFORMATION)
   <br /><b>Order number: </b><xsl:value-of select="@orderid"/></p>

   <table width="50%" border="1">
     <tr>
       <th>Product Number</th>
       <th>Quantity</th>
       <th>Unit Price</th>
       <th>Extended Price</th>
     </tr>
     <xsl:apply-templates select="product"/>
     <tr>
       <td colspan="3" align="right">Order Total: </td>
       <td><xsl:value-of select="totalSys:totalCost()"/></td>
     </tr>
   </table>
   <br /><hr /><br />

 </xsl:template>

 <xsl:template match="product">
  <tr>
    <td><xsl:value-of select="@itemid"/></td>
    <td><xsl:value-of select="quantity"/></td>
    <td><xsl:value-of select="price"/></td>
    <td><xsl:value-of 
         select="totalSys:getExtPrice(number(quantity), 
                        number(price))"/></td>
  </tr>
 </xsl:template>
...

Here, we defined two functions: totalCost(), which takes no arguments; and getExtPrice(), which takes as arguments the quantity and price children. (The getExtPrice() function also updates the running total value, representing the total cost of the order.) XPath normally converts elements to text values, but eventually we'll want to perform arithmetic on them, so we'll use XPath's built-in number() function to change their type before passing them to the script.

Both functions have a namespace prefix, totalSys, to tell the processor that we're not dealing with built-in functions. The namespace itself doesn't matter, as long as it's unique.

Ultimately, the processor will output the values returned by these functions just as if it were one of the built-in functions.

Adding an Extension Element

The purpose of an extension element is a bit different from that of a function. Although an extension element can return a value for output, elements are usually used more to cause something to be done.

For example, we have two things that we want done: We want to retrieve the customer information from the database, and we want to reset the order total for each order. The elements are added in Listing 5.

Listing 5—Adding Extension Elements

...
 <xsl:template match="order">
   <p><b>Customer Information: </b><totalSys:customerInfo/>
   <br /><b>Order number: </b><xsl:value-of select="@orderid"/></p>

   <table width="50%" border="1">
     <tr>
       <th>Product Number</th>
       <th>Quantity</th>
       <th>Unit Price</th>
       <th>Extended Price</th>
     </tr>
     <totalSys:resetTotal resetTo="0"/>
     <xsl:apply-templates select="product"/>
     <tr>
       <td colspan="3" align="right">Order Total: </td>
       <td><xsl:value-of select="totalSys:totalCost()"/></td>
     </tr>
   </table>
   <br /><hr /><br />

 </xsl:template>
...

In the first case, we're simply going to return customer information. In the second, we're using a custom attribute to pass information to the script. This element won't actually output any information, but it will reset the running total for each order.

Now, all we need is a way to tell the processor what it's supposed to do when it encounters these extensions.

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