Interesting Behavior When Swapping Live Nodes In A ColdFusion XML Document

Posted December 1, 2008 at 8:54 AM

Tags: ColdFusion

Last week, I posted a few times about ordering nodes in an XML document using XSLT and ColdFusion. Then, over Thanksgiving, Simon Free suggested that I try swapping the XML nodes directly in the "live" XML document object. Messing with an actual XML document in ColdFusion can be a bit tricky because XML nodes have document owners, which means you can't just go around, willy-nilly, creating XML nodes and putting them places. However, if you have two existing nodes in the same ColdFusion XML document, then things might get a little more interesting.

To test this out, I set up a simple demo that would swap two sibling nodes:

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

  • <!--- Create a ColdFusion XML document. --->
  • <cfxml variable="xmlData">
  •  
  • <toes>
  • <toe id="1" isticklish="yes" />
  • <toe id="2" isticklish="yes" />
  • <toe id="3" isticklish="no" />
  • <toe id="4" isticklish="no" />
  • <toe id="5" isticklish="yes" />
  • </toes>
  •  
  • </cfxml>
  •  
  •  
  • <!--- Store the 3rd node in a temp variable. --->
  • <cfset xmlTemp = xmlData.toes.toe[ 3 ] />
  •  
  • <!--- Set the 3rd node to point to the 2nd node. --->
  • <cfset xmlData.toes.toe[ 3 ] = xmlData.toes.toe[ 2 ] />
  •  
  • <!---
  • Now, store the old 3rd node pointer back into the
  • 2nd node. This should effectively swap nodes 2 and 3.
  • --->
  • <cfset xmlData.toes.toe[ 2 ] = xmlTemp />
  •  
  • <!--- Dump out new ColdFusion XML structure. --->
  • <cfdump
  • var="#xmlData#"
  • label="xmlData After Swap."
  • />

Here, you can see we are using one of the first swaps you ever learn in computer science - swapping two items using a temporary intermediary variable. When I run the above code, I get the following output:

 
 
 
 
 
 
XML Node Set After Swapping Two Sibling Nodes. 
 
 
 

As you can see, there is no more node "2". There are now only 4 toe child nodes. Very odd. And, what's even odder is that there was no error thrown or anything. Although, when I did try to use ColdFusion's ArraySwap(), it did error saying that I could not use the method on a node list. This feels like a situation that should have thrown an error.

I wasn't sure which part of the code was actually doing the dirty work here, so I tried to separate out the code that would remove the node. My hunch was that it was setting nodes 3 to 2. So, I broke that out:

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

  • <!--- Create a ColdFusion XML document. --->
  • <cfxml variable="xmlData">
  •  
  • <toes>
  • <toe id="1" isticklish="yes" />
  • <toe id="2" isticklish="yes" />
  • <toe id="3" isticklish="no" />
  • <toe id="4" isticklish="no" />
  • <toe id="5" isticklish="yes" />
  • </toes>
  •  
  • </cfxml>
  •  
  •  
  • <!--- Set the 3rd node to point to the 2nd node. --->
  • <cfset xmlData.toes.toe[ 3 ] = xmlData.toes.toe[ 2 ] />
  •  
  • <!--- Dump out new ColdFusion XML structure. --->
  • <cfdump
  • var="#xmlData#"
  • label="xmlData After Overwrite."
  • />

As you can see, setting one node equal to a sibling node is what removed one of the nodes form the XML document:

 
 
 
 
 
 
XML Nodes After Swapping Two Sibling Nodes. 
 
 
 

The node that is missing still exists but is no longer part of the document. In a further test, I ran an XmlSearch() call on the missing node to get it's parent:

XmlSearch( xmlMissingNode, ".." )

This returns an empty array. The missing node has no parent; it was truly removed from the document.

I guess the moral of this story is that while ColdFusion XML documents do allow for some array and struct access, they simply cannot be treated like true arrays and structs all the time. It looks like XSLT is the only way to go about sorting XML nodes.

Download Code Snippet ZIP File

Post Comment  |  Ask Ben  |  Other Searches  |  Print Page





Reader Comments

Dec 1, 2008 at 6:27 PM // reply »
64 Comments

You just need to watch your pointers, Ben.

Modify your node assignment line thus:

{code}
<cfset xmlData.toes.toe[3] = duplicate(xmlData.toes.toe[2])>
{code}

--
Adam


Dec 1, 2008 at 6:45 PM // reply »
40 Comments

Yep Duplicate() will fix the direct assignment within the XML document :)


Dec 2, 2008 at 8:02 AM // reply »
7,572 Comments

@Adam, Justin,

Ahhh, thanks. Yes, that does seem to fix the problem. Granted, it does discard a node in the XML document, but as long as no one has an existing reference to it, there shouldn't be a problem.

I wonder if this will help me with my sorting issue. I've got some ideas.


Dec 2, 2008 at 10:09 AM // reply »
7,572 Comments

@Adam, Justin,

Thanks guys! Your tip enabled me to solve my XML sub-tree sorting problem. In fact, I was able to solve this way more satisfactorily than I could with XSLT:

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

Rock on!


Jun 12, 2009 at 5:34 AM // reply »
1 Comments

Hi All,

Recently I had to do something similar to swap nodes and came accross this post.

I've implemented something to do a node swap using arrayswap().
Here's the code and hope it helps.

<cfset variables.oldPos = 2>
<cfset variables.newPos = 4>

<cfset variables.xml = '<Items>
<item id="1">Text 1</item>
<item id="2">Text 2</item>
<item id="3">Text 3</item>
<item id="4">Text 4</item>
<item id="5">Text 5</item>
</Items>'>
<cfset variables.xml = xmlParse(variables.xml)>
<cfdump var="#variables.xml#">
<cfset ArraySwap(variables.xml.xmlRoot.xmlChildren,oldPos,newPos)>
<cfdump var="#variables.xml#">


Jun 15, 2009 at 9:05 AM // reply »
7,572 Comments

@Gun,

Interesting. I'll have to try that out. I don't think I tried ArraySwap() on the actual childNodes before.


Post Comment  |  Ask Ben

Recent Blog Comments
Mar 21, 2010 at 7:40 PM
Is Simulating User-Input Events With jQuery Ever A Good Idea?
A couple of things. One you embed the initial state of of more-info in the CSS. IMHO, that behavior should be in jQuery: moreInfo.hide(); It shows that the behavior your toggling and closing is mor ... read »
Mar 21, 2010 at 3:59 PM
Exploring ColdFusion Component Runtime Class Properties And Serialization
@Elliott, according to Ben's experiment, serializeJSON() doesn't access the private data by default - it doesn't even access the getHair() method - so trying to clone a Girl.cfc via serializeJSON/des ... read »
Mar 21, 2010 at 3:49 PM
Ask Ben: Javascript String Replace Method
I'm confused a bit by what you are asking, but if had this sentence: The color, red, is in the style statement; style: red;. and wanted to remove all or change all of the commas, colons, and semi-c ... read »
Mar 21, 2010 at 3:13 PM
Ask Ben: Javascript String Replace Method
I am trying to make a java program to count the number of times that these punctuation marks occur in a body of text: , : ; . ! - ' " ? / \ I am using this piece to ferret out the commas: numcommas ... read »
Mar 21, 2010 at 11:13 AM
A New Wrist Pain
@chiropractor suwanee, Spoken like someone trying to sell something. Other than for minor, temporary relief from some back pain, chiropractic treatment is nothing but placebo effect and quackery. ... read »
Mar 21, 2010 at 6:32 AM
ColdFusion CFPOP - My First Look
Apologies... The field name in the db for C. is "BounceCode" It stores the code / message which is returned in the email. Sorry for the confusion. ... read »
Mar 21, 2010 at 6:29 AM
ColdFusion CFPOP - My First Look
@Jose Galdamez, Hi Ben and Jose 1st of all.. big thanks to Jose for his Skype chat a few weeks back. Your time was much appreciated. I have come up with a rather unelegant solution to my problem a ... read »
Mar 21, 2010 at 3:42 AM
A New Wrist Pain
Chiropractic treatment is one of the best methods for treating numerous health problems naturally. After years of experience being a chiropractor, I have found that it is a powerful way to solve many ... read »