Using XmlSearch() In CFLoop Array (Thanks Scott Bennett!)

Posted December 27, 2007 at 8:32 AM by Ben Nadel

Tags: ColdFusion

Yesterday, in the comments on my post about using XML with ColdFusion 8's new array iteration using CFLoop, Scott Bennett posted an example of using an XmlSearch() as the value being passed to the Array attribute in the CFLoop tag. I don't know why exactly, but this just struck me as quite cool (cool enough to get its own ColdFusion 8 post). Here is an example of what he was talking about:

  • <!--- Create xml data. --->
  • <cfxml variable="xmlGirls">
  •  
  • <girls>
  •  
  • <brunette
  • name="Maura Tierney"
  • isactress="yes"
  • />
  •  
  • <blonde
  • name="Christina Cox"
  • isactress="yes"
  • />
  •  
  • <brunette
  • name="Sarah Vivenzio"
  • isactress="no"
  • />
  •  
  • <blonde
  • name="Jodie Foster"
  • isactress="yes"
  • />
  •  
  • <brunette
  • name="Ashley Thomas"
  • isactress="no"
  • />
  •  
  • </girls>
  •  
  • </cfxml>
  •  
  •  
  • <p>
  • <strong>Brunette Girls</strong>
  • </p>
  •  
  • <p>
  • <!---
  • Loop over all the returned xml nodes that are
  • found at the following XPath value.
  • --->
  • <cfloop
  • index="xmlGirl"
  • array="#XmlSearch( xmlGirls, '//brunette' )#">
  •  
  • #xmlGirl.XmlAttributes.name#
  •  
  • <!--- Check to see if this girl is an actress. --->
  • <cfif (
  • StructKeyExists( xmlGirl.XmlAttributes, "isactress" ) AND
  • xmlGirl.XmlAttributes.isactress
  • )>
  •  
  • [Actress]
  •  
  • </cfif>
  •  
  • <br />
  •  
  • </cfloop>
  • </p>

As you can see, for the Array attribute of the CFLoop tag, we are directly passing in the node set returned by the XPath search, XmlSearch( xmlGirls, "//brunette" ). Running the code, we output only the array consisting of the brunette child nodes:

Brunette Girls
Maura Tierney [Actress]
Sarah Vivenzio
Ashley Thomas

This just feels like a much more elegant solution than trying to use the xmlGirls.girls.brunette pseudo array. Also, I think part of why I like it is that it feels much more parallel to the equivalent XSL Transformation:

  • <xsl:for-each select="//brunette">
  •  
  • .....
  •  
  • </xsl:for-each>

I like the symmetry. As a trade-off, you can't refer to the array itself without an intermediary variable, but for these kind of one-offs, it is perfect.

Thanks Scott Bennett!


You Might Also Be Interested In:



Reader Comments

Feb 7, 2008 at 5:15 PM // reply »
10 Comments

Hi Ben,

I have been working on trying looping over data out of an XML file and choosing a particular node through XmlSearch.

XML File Structure:
<propertyList date="2008-01-25-10:02:00" >
<residential modTime="2008-01-25-10:02:01" status="current">
<uniqueID>HI5160</uniqueID>
<images>
<img id="m" file="HI5160_1.jpg"/>
<img id="a" file="HI5160_2.jpg"/>
<img id="b" file="HI5160_3.jpg"/>
<img id="c" file="HI5160_4.jpg"/>
<img id="d" file="HI5160_5.jpg"/>
<img id="e" file="HI5160_6.jpg"/>
<img id="f" file="HI5160_7.jpg"/>
<img id="g" file="HI5160_8.jpg"/>
<img id="h" file="HI5160_9.jpg"/>
<img id="i" file="HI5160_10.jpg"/>
<img id="j" file="HI5160_11.jpg"/>
<img id="k" file="HI5160_12.jpg"/>
</images>
</residential>
</PropertyList

The only way i can get the desired results is this way:

<CFSET propID = getlist.listing_id>

<!--- Loop over the info-main nodes. --->
<cfloop
index="intMainIndex"
from="1"
to="#ArrayLen( Listings.PropertyList.residential )#"
step="1">

<!--- Get a short hand for the current info-main node. --->
<cfset xmlInfoMain = Listings.PropertyList[ "residential" ][ intMainIndex ] />
<cfif xmlInfoMain.uniqueID.XmlText EQ propID>
uniqueID = [<cfoutput>#xmlInfoMain.uniqueID.XmlText#</cfoutput>]<br />

<!--- Get the image-list children. --->
<cfset arrImageList = xmlInfoMain[ "images" ] />

<!--- Loop over the image list. --->
<cfloop
index="intImageListIndex"
from="1"
to="#ArrayLen( arrImageList )#"
step="1">

<!--- Get a short hand for the current image-list node. --->
<cfset xmlImageList = arrImageList[ intImageListIndex ] />

<!--- Loop over image nodes. --->
<cfloop
index="intImageIndex"
from="1"
to="#ArrayLen( xmlImageList.img )#"
step="1">

. . . . img[ file = [<cfoutput>#xmlImageList.img[ intImageIndex ].XmlAttributes.file#</cfoutput>] [<cfoutput>#xmlImageList.img[ intImageIndex ].XmlAttributes.id#</cfoutput>]<br />
</cfloop>

</cfloop>
</cfif>
</cfloop>

I'm sure there is a quicker way to do this using XmlSearch.

I have successfully grabbed the record out of the XML i need via this code:

<cfset arrResNodes = XmlSearch(Listings,"//residential[ uniqueID[ text() = '#propID#' ]]/") />

The only problem is i cannot loop over the results of XmlSearch?? Could you point me in the right direction? I can dump the output, just not loop over the img nodes.

Thanks,

Leigh


Feb 8, 2008 at 7:17 AM // reply »
11,238 Comments

@Leigh,

I think you are really close here. To get directly at the array of IMG nodes, you can use this XPath:

//residential[ uniqueID[ text() = 'HI5160' ] ]//img/

where I put in the hard-coded ID for testing. Once you have that array, you just loop over it the same way you are already looping over the image nodes array.


Feb 27, 2008 at 2:40 AM // reply »
10 Comments

Hi Ben,

After your excellent advice which worked like a treat with images, i need your advice on the following:

I have 1 main xml file another xml file with updates only.

I need to append or copy over the main xml with the update data.

I was using the XmlSearch theory: //residential[ uniqueID[ text() = 'HI5160' ] ]

and then trying to append the main file:

<cfset ArrayAppend(mydoc.PropertyList.residential.XmlChildren, XmlElemNew(myupdate,myupdate.PropertyList.residential))>

I would then write the new xml file.

Any further help with this would be appreciated.

Can i use XmlSearch within 1 file and append another file at the same time?

Thanks, Leigh


Feb 27, 2008 at 7:15 AM // reply »
11,238 Comments

@Leigh,

You can't just copy a node from one tree to another. You have to import it first. Check out this UDF that I mad to do that:

http://www.bennadel.com/index.cfm?dax=blog:701.view


Mar 7, 2008 at 2:32 PM // reply »
3 Comments

CF8 allows you to do the

<cfloop index="x" array="#myarray#">
#x# -
</cfloop>


Post A Comment

Comment Etiquette: Please do not post spam. Please keep the comments on-topic. Please do not post unrelated questions or large chunks of code. And, above all, please be nice to each other - we're trying to have a good conversation here.

Please review the following issues:

Author Name:


Author Email:

Author Website:

Comment:

Supported HTML tags for formatting: <strong>bold</strong>   <em>italic</em>   <code>code</code>







  • Help Wanted - Find Your Next ColdFusion Job
Ben Nadel's Company - Epicenter Consulting Recent Blog Comments
May 21, 2013 at 11:51 AM
Ask Ben: Parsing Very Large XML Documents In ColdFusion
Looking at my first ever XML document that I have to parse and put into MS SQL 2000 with CF8. I get it to list the desired Field name, many times over, and have a long list of this field name displa ... read »
May 21, 2013 at 9:25 AM
Turning Off and On Identity Column in SQL Server
you are awesome..i am lucky to get this blog between such a garbage one....Thanks, Prashant ... read »
May 20, 2013 at 4:38 PM
Using A Dynamic Column Name With ValueList() In ColdFusion
@Dana, Your confusion is well founded, since this is a very confusing features. In fact, it ONLY works if you use array notation. Meaning, that this: arrayToList( query[ "columnName" ] ) ... read »
May 20, 2013 at 4:34 PM
Using A Dynamic Column Name With ValueList() In ColdFusion
I was thinking chicken and the egg, I wouldn't have expected it to work in the valuelist going in I guess. Maybe I just need a beer, long day :) ... read »
May 20, 2013 at 4:29 PM
Using A Dynamic Column Name With ValueList() In ColdFusion
@Dana, That's if you're trying to reference a specific row. In this case, we're trying to reference the entire query column as one cohesive value. So, you are correct that if you wanted to output a ... read »
May 20, 2013 at 4:24 PM
Using A Dynamic Column Name With ValueList() In ColdFusion
I thought when you used array notation to reference queries you always had to have the row or it would throw a similar error as well? ... read »
May 20, 2013 at 11:45 AM
Using jQuery's Animate() Step Callback Function To Create Custom Animations
This is really useful. I found out that you don't actually have to use a dummy css property (surprisingly). To animate a property in a linear-gradient for instance I did this this.css('someLinearGra ... read »
May 20, 2013 at 10:51 AM
Using A Dynamic Column Name With ValueList() In ColdFusion
@Josh, Oh snap! You're totally right! I'm not sure I've ever tried that. I did know that you can call a number of other array-methods on ColdFusion query columns: http://www.bennadel.com/blog/167 ... read »
InVision App - Prototyping Made Beautiful With Prototyping Tools