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

Posted December 27, 2007 at 8:32 AM

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:

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

  • <!--- 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:

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

  • <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!

Download Code Snippet ZIP File

Post Comment  |  Ask Ben  |  Permalink  |  Print Page


You Might Also Be Interested In:



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

Reader Comments

Feb 7, 2008 at 5:15 PM // reply »
8 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 »
6,516 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 »
8 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 »
6,516 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 Comment  |  Ask Ben

Recent Blog Comments
Nov 20, 2009 at 11:32 PM
Five Months Without Hungarian Notation And I'm Loving It
I've used headless camel case for years for not only ColdFusion variables, but also SQL tables and fields... pretty much everything involving code. I also subscribe to the "don't abbreviate and clea ... read »
Nov 20, 2009 at 11:00 PM
Five Months Without Hungarian Notation And I'm Loving It
@Marcel, Yeah, I always err on the side of longer but more readable variable names. As for the camel casing of CF methods and the headless camel casing of custom items, I get around this by always ... read »
Nov 20, 2009 at 10:56 PM
Five Months Without Hungarian Notation And I'm Loving It
I use the following and love it: my.namespace.MyComponents.functionMethodsOrUDF() CONSTANT_VALUES_OR_PROPERTIES One thing I always try is to CamelCaseBuiltInColdFusionFunctions() so others can tell ... read »
Nov 20, 2009 at 5:38 PM
Learning ColdFusion 8: CFImage Part I - Reading And Writing Images
Hi Ben, Great article. I've been looking around to see if ColdFusion image engine can programatically create the following "wrap around" effect: http://www.creativepro.com/article/photoshop-s-she ... read »
Nov 20, 2009 at 5:35 PM
Maintaining ColdFusion Sessions Across SMS Text Message Requests Without Cookies
@Dave: I talked to Gert he suggested: <cfhttp method="get" url="http://{some cf website}" result="stuff" addtoken="yes" /> Note the addition of cfhttp attribute addtoken. That should persist y ... read »
Nov 20, 2009 at 5:23 PM
Maintaining ColdFusion Sessions Across SMS Text Message Requests Without Cookies
@Todd, Ahh, gotcha, yeah that makes sense. ... read »
Nov 20, 2009 at 5:17 PM
Maintaining ColdFusion Sessions Across SMS Text Message Requests Without Cookies
Ben, sorry if I didn't make this clear. You can make it work like that if you want, just put <cfset session.foo = 1> (and <cfset application.foo = 1>) in your OnRequestStart() and it reve ... read »