Using EXSLT To Extend XSLT With Custom Functions In ColdFusion
Posted November 11, 2009 at 10:26 AM
The other day, I answered a question for a reader about filtering XML nodes against a value list using the XPath function, contains(). In the question, the reader mentioned the EXSLT library; I had not heard of this, so when researching the solution, I looked it up at www.exslt.org. As it turns out, there's a whole mechanism and existing library for extending the functionality of XSLT and XPath. And, what's more awesome is that the XSLT engine that ColdFusion uses (Xalan) supports this extensioning.
One of the XSLT extensions offered in the EXSLT library is the "func:function" node. This node allow programmers to define their own XSLT-based custom functions that can be called within their XML transformations. As a launch pad for experimentation with this stuff, I figured I would readdress my previous blog post, but this time, try to solve the problem using EXSLT and a custom function.
If you don't remember from my previous post, the reader needed to filter an XML node by checking its attribute value against a list of target values. To solve this the first time, I hacked the contains() function to work as a list function (mostly); but, using EXSLT, I wanted to try and create an actual list function, list-find(), that would return true if a given value could be found in a given list. Here's what I came up with:
Launch code in new window » Download code as text file »
- <!--- Create our XML data source. --->
- <cfxml variable="girls">
-
- <girls>
- <girl type="cute">
- <name>Sarah</name>
- </girl>
- <girl type="athletic">
- <name>Tricia</name>
- </girl>
- <girl type="hot">
- <name>Katie</name>
- </girl>
- <girl type="cute">
- <name>Libby</name>
- </girl>
- </girls>
-
- </cfxml>
-
-
- <!--- Create the XSL tranformation. --->
- <cfsavecontent variable="xslt">
-
- <!--- Document type declaration. --->
- <?xml version="1.0" encoding="ISO-8859-1"?>
-
- <!---
- When defining the Transform, you must add the namespace
- for the EXSL (XSL Extensions) functionality so that they
- can be properly resolved.
-
- NOTE: I am also adding my own name space, "ben", for use
- in the function name and information attributes.
- --->
- <xsl:transform
- version="1.0"
- xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
- xmlns:ben="http://www.bennadel.com/xslt"
- xmlns:func="http://exslt.org/functions"
- xmlns:str="http://exslt.org/strings"
- extension-element-prefixes="func str ben">
-
- <!---
- The list-find() function allows us to search the
- given list for the given value. By default, the
- delimiters is the comma, but you can override with
- an optional argument.
- --->
- <func:function
- name="ben:list-find"
- ben:return-type="boolean"
- ben:hint="I take a delimited list and a value and return true or false as to whether that value is a list item in the given list.">
-
- <!--- Define arguments. --->
- <xsl:param
- name="list"
- ben:type="string"
- ben:required="true"
- ben:hint="I am the delimited list of values that is being searched."
- />
-
- <xsl:param
- name="value"
- ben:type="string"
- ben:required="true"
- ben:hint="I am the value for which we are searching in the above list."
- />
-
- <xsl:param
- name="delimiters"
- select="','"
- ben:type="string"
- ben:required="false"
- ben:hint="I am the collection of delimiters used to deliniate the list values. I can be one or more characters (each character is used as a valid delimiter). I am defaulted to the comma."
- />
-
- <!---
- Using the EXSLT extension string library, split
- the list based on the given delimiters. This will
- return a node set of "token" nodes.
-
- Ex: str:tokenize( 'a,b,c', ',' )
- ...
- <token>a</token>
- <token>b</token>
- <token>c</token>
- --->
- <xsl:variable
- name="tokens"
- select="str:tokenize( $list, $delimiters )"
- />
-
- <!---
- Return a boolean-ized version of a query for token
- nodes who's text() value is equal to the list item
- value we are searching.
-
- Boolean() will return TRUE if the resultant node
- set returned from the select is non-empty.
- --->
- <func:result
- select="boolean( $tokens/text() = $value )"
- />
-
- </func:function>
-
-
- <!--- Match the root girls node. --->
- <xsl:template match="/girls">
-
- <girls>
-
- <!---
- Copy each GIRL node if the TYPE attribute
- is contained within the given list: hot or
- athletic.
-
- NOTE: We are using a custom function as defined
- by the EXSLT func library.
- --->
- <xsl:copy-of
- select="./girl[ ben:list-find( 'athletic,hot', @type ) ]"
- />
-
- </girls>
-
- </xsl:template>
-
- </xsl:transform>
-
- </cfsavecontent>
-
-
- <!--- Transform the document. --->
- <cfset hotGirls = xmlParse(
- xmlTransform( girls, trim( xslt ) )
- ) />
-
- <!--- Output the new result. --->
- <cfdump
- var="#hotGirls#"
- label="Hot Girls"
- />
As you can see, my function "ben:list-find" takes 2 to 3 parameters - the list, the value in question, and an optional set of delimiters. Since this function is not part of the inherent XPath functionality, it needs to be name-spaced. Using the "ben" name space, I not only defined the function tag, I also defined many informational attributes that described the role of the function and its parameters (ala the attributes available in ColdFusion's CFFunction and CFargument tags). You know my style - the more insight, the better.
Running the above code, we get the following XML document:
| | | | | |
| |  | | ||
| | | |
As you can see, only the girl nodes who's @type attribute was in the list "athletic,hot" were returned in the resulting XML document. This is clearly a much better solution than my contains() approach.
The EXSLT library looks very interesting. What looks even more interesting, though, is that it appears that EXSLT itself has an extension mechanism in which new functions can be written in Javascript! Of course, this requires some additional Java libraries such as Rhino.jar; but, how wild would that be? Writing Javascript functions that could be leveraged in XSLT? But, that's for a whole other blog post.
Download Code Snippet ZIP File
Post Comment | Ask Ben | Permalink | Other Searches | Print Page
Newer Post
Track Document-Level Clicks With jQuery MouseDown Events
Older Post
Tracking Google AdSense Clicks With jQuery And ColdFusion
Reader Comments
Nice post Ben, that is a handy feature
@Shuns,
Yeah, it seems like a cool thing.
