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




Learning ColdFusion 9 - ColdFusion 9 tutorials, samples, examples, demos

Reader Comments

There are no comments posted for this web log entry.


Post Comment  |  Ask Ben

Recent Blog Comments
Mar 11, 2010 at 9:14 AM
Making SOAP Web Service Requests With ColdFusion And CFHTTP
Just need to add - we still did have to get the external service to clean up their WSDL and flatten it as per the article I posted before ... read »
Mar 11, 2010 at 9:00 AM
Making SOAP Web Service Requests With ColdFusion And CFHTTP
I finally got to the bottom of my problem - the fact was that the WSDL was full of complex types that Axis didn't like - I should have been able to receive it as a struct but that just didn't work so ... read »
Mar 11, 2010 at 8:55 AM
Making SOAP Web Service Requests With ColdFusion And CFHTTP
@Dmitry, No problem my man. You should be able to just parse the SOAP response into XML and be able to access all the nodes that way. The only thing you have to be careful of is the namespaces whic ... read »
Mar 11, 2010 at 8:49 AM
Making SOAP Web Service Requests With ColdFusion And CFHTTP
cfhttp response is located in it's FileContent property ???? You can't imagine how many times I had to work with cfinvoke and it's complex responses and their weird classes deserialization because I ... read »
Mar 11, 2010 at 8:43 AM
Ask Ben: Building An AJAX, jQuery, And ColdFusion Powered Application
@Nathan, Not saying this is the correct way to do this, but I've handled this in many different ways depending on how "secure" the function needs to be. In a case like yours (users needs to be l ... read »
Mar 11, 2010 at 7:57 AM
FLEX On jQuery: Turning HTML Links Into Standard UI Elements
@Peter, Yeah, that's how I build to - we have AJAX and jQuery where is enhances a given page... but we don't require it to tie the entire application together (it's still very much a request-respon ... read »
Mar 11, 2010 at 5:38 AM
Delaying ColdFusion Session Persistence Until User Logs In
Hmmm, I didn't get any email notification here - I definitely selected all the checkboxes (they're still ticked). ... read »
Mar 11, 2010 at 5:05 AM
Ask Ben: Selecting XML Attributes Given Other XML Attributes
Seems like I'm missing something. If I take this code and put it in a .cfm file and try to run it I get this error: Detail Premature end of file. ErrNumber 0 ExceptionMessage Premature end of f ... read »