Ask Ben: Selecting XML Nodes That Have A Given Parent Node Using XPath

Posted May 5, 2009 at 10:44 AM

Tags: ColdFusion, Ask Ben

Let's say I have an XML file with the following data in it: [private information]. Right now, the way the component parses the XML file, it returns all instances of DUNS it finds. Is there any way to limit the tag that is searches through and only return say the DUNS from the BasicInfo parent tag? If so, can you provide an example on how that might be done? Thanks again!

When you search for nodes in a given XML document by name (ex. //name), it will return nodes anywhere in that XML document with the matching name. This is what you are experiencing. If you want to return only nodes within a given parent node, then you just have to be a little bit more specific in you XPath. There are two ways to do this:

  1. Specify the parent node in the node path.
  2. Specify the parent node in the target node predicate.

Before we get into those two options, let's first build ourselves a test ColdFusion XML document:

 Launch code in new window » Download code as text file »

  • <!--- Generate ColdFusion XML document. --->
  • <cfxml variable="xmlData">
  •  
  • <category>
  • <name>Bodybuilding Books</name>
  •  
  • <books>
  • <book>
  • <name>Muscle: Confessions Of An Unlikely Bodybuilder</name>
  • <author>Samuel Wilson Fussell</author>
  • </book>
  • <book>
  • <name>Gorilla Suit: My Adventures In Bodybuilding</name>
  • <author>Bob Paris</author>
  • </book>
  • </books>
  • </category>
  •  
  • </cfxml>

In this demo XML document, you can see that we have three "name" nodes: one for the Category and one for each Book node. Like you have experienced, if we searched for:

 Launch code in new window » Download code as text file »

  • <!--- Query for all names. --->
  • <cfset arrNameNodes = XmlSearch(
  • xmlData,
  • "//name"
  • ) />
  •  
  • <!--- Output resultant node set. --->
  • <cfdump
  • var="#arrNameNodes#"
  • label="//name"
  • />

... we'd get back all three:

 
 
 
 
 
 
XPath That Found Any Name Node Within The Given XML Document. 
 
 
 

But, if we want to only get back the Name nodes contained within the Book nodes, we have to use one of the two XPath options above. We can specify the parent node in the node search path:

 Launch code in new window » Download code as text file »

  • <!---
  • Query for all name nodes that are contained within a
  • book node.
  • --->
  • <cfset arrNameNodes = XmlSearch(
  • xmlData,
  • "//book/name"
  • ) />

This will search for Name nodes that are contained within book nodes:

 
 
 
 
 
 
XPath That Found Name Nodes Contained Within Book Nodes Within The Given XML Document. 
 
 
 

We can also search for all Name nodes and then specify in the predicate that it must have a Book parent node:

 Launch code in new window » Download code as text file »

  • <!---
  • Query for all name nodes that are children of
  • the parent node: book.
  • --->
  • <cfset arrNameNodes = XmlSearch(
  • xmlData,
  • "//name[ parent::book ]"
  • ) />

This will search for all Name nodes and then filter the node set based on the parent node of the given node. Running the above code gives us the same node set as above.

Either of these methods will return only the two Name nodes contained within the Book nodes. The former, however, is probably faster as you limit your search earlier on in the XPath; but, I have not done any performance testing on this.

Download Code Snippet ZIP File

Post Comment  |  Ask Ben  |  Other Searches  |  Print Page





Reader Comments

There are no comments posted for this web log entry.


Post Comment  |  Ask Ben

Recent Blog Comments
Mar 12, 2010 at 1:38 AM
Using jQuery's SlideUp() and SlideDown() Methods With Bottom-Positioned Elements
Very nice and useful tutorials for web designers, Thanks for posting. ... read »
Mar 11, 2010 at 11:14 PM
Using The Apple iPod Shuffle Without iTunes
Whoever coded this deserves a pat on the back. I really hated iTunes and this has worked great for me. Thanks! Oh, and thanks for answering the question about file renaming. I was just afraid I woul ... read »
Mar 11, 2010 at 9:29 PM
Tim Cracked The GMail - CFMailPart Puzzle!
I've been wrestling with the CFMAIL tag and CFMAILPARTS for several days now and have found issues with the CF implementation even in CF9! What I have learned so far is: 1. Using only one CFMAILPART ... read »
Mar 11, 2010 at 6:09 PM
Ask Ben: Building An AJAX, jQuery, And ColdFusion Powered Application
@Eric, Neat trick, I was able to get rid of most of the lines of whitespace following your advice. Some whitespace still remains. With a bit of playing around, I found that the remaining whitespa ... read »
Mar 11, 2010 at 4:56 PM
Ask Ben: Building An AJAX, jQuery, And ColdFusion Powered Application
I've struggled with returning JSON from ColdFusion CFCs for a while because I (mysteriously) get lots of white space/new lines that appear before the actual JSON result (check the response in Firebug ... read »
Mar 11, 2010 at 3:24 PM
Ask Ben: Using jQuery To Act On A Click Event Based On The Target Element
@TripeL, Awesome :) Glad it was helpful. ... read »
Mar 11, 2010 at 3:23 PM
Ask Ben: Using jQuery To Act On A Click Event Based On The Target Element
WOW...that's what I'm looking for. The code examples are very helpful. Thanks ... read »
Mar 11, 2010 at 1:20 PM
What Is The Best Time Of Day To Workout?
Well I am glad I stick to mid afternoon / evening work outs. Interesting find! ... read »