Sorting ColdFusion Arrays With Sortable Interfaces

Posted November 7, 2006 at 8:01 AM

Tags: ColdFusion

Richard over on CF-Talk asked about sorting arrays using a deep attribute. As far as I know, there is nothing built into ColdFusion that does this kind of thing automatically. I know that ColdFusion's StructSort() method allows the user to provide a path to the sub element on which the sorting is based, but there doesn't seem to be anything like this for Arrays.

This got me thinking; I am pretty sure I remember something about a "Sortable" interface that exists in other languages. This sounded like something that would be helpful for this situation. After a bit of experimentation, here is what I came up with. You need to have an abstract class "AbstractSortable". This defines the following comparative methods:

AbstractSortable::LT()
AbstractSortable::LTE()
AbstractSortable::EQ()
AbstractSortable::GTE()
AbstractSortable::GT()

It also has some other methods:

AbstractSortable::Init()
AbstractSortable::SetTarget()
AbstractSortable::SortArray()

The comparative methods are used during the sorting algorithm defined in the SortArray() method (which in our case is going to be a bubble sort).

One you have all that set up, you need a concrete class the overrides at least one of the comparative methods. Each comparative method that is overridden must take an object reference to which we will be comparing the concrete class's target object. Each method must return a boolean. For every "True" returned, the two items in comparison will be swapped.

Now that I have given a brief explanation, let's take a look at some code. Here is the abstract sortable class:

AbstractSortable.cfc ColdFusion Component

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

And, here is the sortable girl class which is a concrete instantiation of the AbstractSortable.cfc:

SortableGirl.cfc ColdFusion Component

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

Notice that the SortableGirl.cfc component extends the AbstractSortable.cfc component. This means that the SortableGirl.cfc has all the methods of the AbstractSortable.cfc but overrides only the ones it defines. In our case, we are overriding the GT() method. This means that we intend to sort something in an ASCending manner. But, look at how we compare the two items; we are comparing the "Birthday" properties of the given objects. This is where you do the custom sorting. I use Birthday, but this could just have easily been something crazy like:

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

The point is, you can do any sort of comparison on the two objects you want so long as you return TRUE or FALSE.

Ok, now let's take a look at the sorting in action. I have set up an array of girls and given them random Birthdays:

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

Dumping out the arrGirls array we get:

Notice that the girls are arranged in their original list sort, having nothing to do with their birthdays. Now, let's create an instance of the SortableGirl.cfc ColdFusion Component and use it to sort the array:

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

Once we instantiation the SortableGirl.cfc (which extends AbstractSortable.cfc) we call the method SortArray(). We pass in the array that we want to sort and the method we want to use for sorting (GT()). This will perform the Bubble Sort defined in the AbstractSortable.cfc and will give us the following:

Now, all the girls are sorted in an ASCending order based on their birthdays. To sort in a DESCending order, all you would have to do is override the LT() method and run the sort again. The only down side to this is that you have to create a class that defines the way you want to sort. But, if your sort is going to be highly customized, this minor overhead is going to be worth the usability of it.

Download Code Snippet ZIP File

Post Comment  |  Ask Ben  |  Other Searches  |  Print Page

• Add To Del.icio.us
• Add To Digg
• Add to Spurl.net
• Add to Wists
• Add to Simpy
• Add to Newsvine
• Add to BlinkList
• Add to Furl
• Add to reddit
• Add to FARK
• Add to BlogMarks
• Add to Yahoo! My Web
• Add to smarking
• Add to Ma.gnolia
• Add to Segnalo

Reader Comments

Ben, just wanted to let you know, a year later, I found this very useful. Thanks!

@Rob,

As always, I'm glad that I could help. Feel free to drop a line anytime you get stuck on something.

I like what you did but I think there is a bit less code version:

<cfscript>
//before
myStruct = structNew();

myStruct.Contractor = ArrayNew(1);
myStruct.City = ArrayNew(1);
myStruct.miles = ArrayNew(1);

contractorList = 'a,b,c,d,e,f,g,h,i';
cityList = 'Maui,Oahu,Sydney,Los Angeles,Istanbul,Bodrum,Paris,London,Budapest';
milesList = '213,12,1500,701,2300,2100,1800,1900,2150';
for (i=1; i<10; i++) {
myStruct.Contractor[i] = ListGetAt(contractorList,i);
myStruct.City[i] = ListGetAt(cityList,i);
myStruct.miles[i] = ListGetAt(milesList,i);
}
</cfscript>
<cfdump var="#myStruct#">

<cfscript>
//after
session.myStruct = structNew();

for (j=1; j<= #arrayLen(myStruct.miles)#; j++) {
for (k=1; k<= #arrayLen(myStruct.miles)#; k++) {
if(myStruct.miles[j] lt myStruct.miles[k]) {
ArraySwap(myStruct.miles,k,j);
ArraySwap(myStruct.Contractor,k,j);
ArraySwap(myStruct.City,k,j);
}
}
}
session.myStruct = myStruct;
</cfscript>

<cfdump var="#session.myStruct#">

@Falconseye,

I like what you're doing, but I am not sure that it is all that much less code. Once you get the base sorter component out of the way, the CFC that I define for the actual Girl array is rather short - practically just one argument and a return statement of a boolean condition. Plus, it's reusable. If you're only going to use your solution once, that's cool, but wrapping it up in a CFC allows the solution to be used in multiple places without any duplication.

Thanks Ben, This solution is exactly what I've been looking for. The approach is perfect.

@Patrick,

Awesome! What kind of stuff were you sorting (just out of curiosity)?

@Ben

I'm sorting air traffic data in fairly large quantities. I'm currently receiving the data as JSON and displaying it in an ExtJS Grid Panel. The only problem is allowing the ExtJS Grid Panel to do the sorting on the client side is naturally very slow when its a couple thousand records. I'm looking to make sorting capability appen on the server-side. I'm also looking to implement paging as well to limit the number of records returned to the client at a time. I haven't implemented it yet, but I believe your solution will do the trick.

Thanks again for posting this.

@Patrick,

Anytime. Good luck!

Post Comment  |  Ask Ben

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:	Formatting: <strong>bold</strong> <em>italic<em>
	Remember my information
	Subscribe to entry *
	Send me a copy of this comment (as part of the comment thread)

 

* If you subscribe, any new posts to this thread will be sent to your email address.