You will be redirected in 30 seconds or close now.

ColdFusion Authors: Yakov Fain, Jeremy Geelan, Maureen O'Gara, Nancy Y. Nee, Tad Anderson

Related Topics: ColdFusion

ColdFusion: Article

Building Generic Maintenance Interfaces

Sparing yourself an awful lot of tedious work

When the March 2006 issue of CFDJ arrived, I had just begun working on the maintenance interfaces for the support tables of a new system. There are many of these tables, and implementing the associated maintenance routines looked set to consume a lot of time.

I had just finished implementing DAOs for the first of the support forms when I came across Nic Tunney's article on ObjectBreeze. ObjectBreeze was going to save me a lot of time on implementation - and spare me an awful lot of tedious work building DAOs for each table.

ObjectBreeze saved me so much time it got me to thinking… Would it be possible to implement the user interfaces generically, in the same way that ObjectBreeze implements our data model? And if we have a consistent, generic interface to access a data model, can we leverage that interface in the view and controller tiers too? The controller tier seems simple enough - for a simple maintenance form it merely needs to actuate the CRUD methods of the DAO. As far as the view tier goes, if it knew what the data model looked like, it shouldn't be difficult. The potential benefits would be enormous - I could concentrate my time on the difficult tasks of aggregating data and implementing business logic without worrying about data access or user interfaces.

Building the Basics
For this article we're going to put together a fictitious system for a hypothetical racing club. This club needs to track the drivers, teams, and cars that enter club races in various classes. Figure 1 details our data model. We have tables for each object - drivers, cars, teams, and classes. A car belongs to a single team, races in a single class, and is driven by a single driver. Drivers can drive any number of cars in different classes for different teams. Teams can own any number of cars, and classes can contain any number of cars.

Let's start with the drivers. They're one of the simplest objects because they don't contain any references to other objects (tables). The club is interested in tracking a driver's first and last name and his nationality. First we'll set up our controller (drivers.cfm). This will be the only file that the browser requests when manipulating a driver object. Our controller is essentially a switch statement that interprets a form parameter called controlMethod. Our controller supports the standard CRUD operations - create (add), read (edit), update, and delete operations, plus a list operation. Each operation involves a database operation and a user interface to render the results. The list operation will retrieve all of the drivers and display them in a grid, and the edit operation retrieves one driver and outs his details in a form for editing. Create is similar to edit except that it creates a new driver record. Update applies the results of a create or edit operation and delete removes a driver's data from the database. ObjectBreeze is used to handle the data model.

Each method that has to present data to the user also contains a call to the custom tag responsible for building the view. There's a tag for displaying lists (grid) and for editing a single record (detail). Since these templates are going to be generic, I've put them in a directory called genericUI. A CFMODULE call is used to invoke the generic code.

The Views
The maintenance for the drivers' table is a typical table maintenance application - a list of items and a detail form for editing an individual item. The generic grid template will display our list of items with controls to enable adding and deleting records, and a control to select an item for editing. To do this we have to tell the grid control which fields we want displayed, what the captions for those fields should be, and the data to be displayed. Using that information it's a pretty simple matter of looping over the list of captions to create the grid header. A two-dimensional loop displays the requested fields for each row of data.

The detail form is similar to the grid. For each field in the data model, we generate a table row containing a label and a textbox to edit the corresponding field. Arguments to our custom tag are similar to the grid except that we're passing a single data object.

See Listing 1 for the code we've built so far.

So how does it work? Not bad for a first stab. We've got a grid containing a list of drivers. We've got links for adding, editing, and deleting drivers. It definitely isn't perfect - there are a couple shortcomings we'll want to address. The first of these shortcomings is that the controller template is specific to the drivers' table. Before we can really reuse our code we'll want to build a generic controller template.

The Controller
Fortunately the task of converting the controller template is fairly simple. We want to call the controller as a custom tag, so instead of looking at form variables for our parameters we're going to be looking at attributes. We'll also have to tell the controller what fields we want displayed, and what their associated captions are. We'll also pass the form scope into the controller. Then we modify our custom tag calls to use these attributes instead of our hard-coded field lists. Our generic controller gets a new name - genericmasterdetail.cfm - and it moves into the genericUI folder.

The page that the browser invokes now becomes very simple - just a call to genericmasterdetail with the proper parameters. When we test our new drivers.cfm page in the browser, everything looks and functions exactly as before. Now we're ready to really leverage what we've built. The classes and team tables are both simple tables, similar in structure to the drivers' table. We make copies of the drivers.cfm file, change the parameters we pass to genericmasterdetail, and presto - fully functional maintenance forms for drivers, teams, and classes. I've done a little preprocessing to make things a bit neater. For example, I've included logic in classes.cfm to instruct our generic user interface to display only the class name during the list operation and all three fields during add or edit operations. See Listing 2 for the updated code.

Object Composition
The objects we've worked with so far are very simple in that all of the data they require is in one table. Usually, we're not that lucky; we often need data from multiple tables. ObjectBreeze supports models like these through composite objects. ObjectBreeze gives us a nice set of features for working with composite objects - we use the containsOne() or containsMany() methods to register the relationships between our tables with ObjectBreeze and it takes care of our database interactions for us.

Introducing composition into our generic user interfaces poses two problems. The first is how to tell the controller code to create a compound data object for us. The second is how to deal with this data in the user interface.

The second question is actually the easier of the two to answer. If we have a "contains one" relationship, such as the one between a team and a car, we can use a list box control to update that relationship. If we have a "contains many" relationship, we can use a cross-select to select the related items. Of course we'll have to know the relationship between the parent and children to know how to handle each item, but we have to describe that relationship to the controller to get the data objects configured properly in the first place.

XML to the Rescue
XML is the perfect choice for describing data to our generic user interfaces. It also makes it easy to enhance our code without making changes to the way it gets called. We're going to work with the racecars table for our first example. Cars are driven by a driver, entered in a class, and owned by a team. That is to say that there is a "contains one" relationship between our racecars object and the team, classes, and drivers objects.

The XML document that describes the racecars' object to genericmasterdetail is in Listing 3. The document describes the data model (datamodel element and children), the grid view (grid element), and the detail view (detail element). We'll feed this document into our genericmasterdetail custom tag and from there into the grid and detail custom tags. These tags have changed in several different ways. First, the arguments have changed. The form scope still gets passed into genericmasterdetail, grid, and detail but the configuration document has replaced the other arguments. All the references to the old arguments were updated to look at the configuration document instead. A new custom tag - uiformelements - has been created to handle the display of the individual form elements. Finally, two helper functions have been created to help us manage composite data access objects.

Listing 3 contains the racecars' XML document and the helper functions configureDAO() and getProperty().

All of these upgrades buy us a lot of functionality. We've moved quite a ways beyond simple forms. We can now add, update, and delete records in a wide variety of formats with just a few lines of XML.

More Stories By Craig Drabik

Craig Drabik is a senior programmer with the State University of New York at Buffalo. He is a Macromedia certified ColdFusion developer who has been working in ColdFusion since version 4.51.

Comments (2) View Comments

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.

Most Recent Comments
Ron Phillips 06/12/06 03:12:20 PM EDT

Well, the download works fine. Very nice!

I'm a little concerned about using a modified version of objectbreeze -- is Nick going to change it in the next release, or what's the status?


Craig Drabik 06/08/06 04:47:21 PM EDT

You can download a complete archive of all the code, and working examples for each segment, as well as the completed framework at http://www.acsu.buffalo.edu/~cjdrabik/racecars_sample.zip

Thanks for reading!

@ThingsExpo Stories
DX World EXPO, LLC, a Lighthouse Point, Florida-based startup trade show producer and the creator of "DXWorldEXPO® - Digital Transformation Conference & Expo" has announced its executive management team. The team is headed by Levent Selamoglu, who has been named CEO. "Now is the time for a truly global DX event, to bring together the leading minds from the technology world in a conversation about Digital Transformation," he said in making the announcement.
"Space Monkey by Vivent Smart Home is a product that is a distributed cloud-based edge storage network. Vivent Smart Home, our parent company, is a smart home provider that places a lot of hard drives across homes in North America," explained JT Olds, Director of Engineering, and Brandon Crowfeather, Product Manager, at Vivint Smart Home, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that Conference Guru has been named “Media Sponsor” of the 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. A valuable conference experience generates new contacts, sales leads, potential strategic partners and potential investors; helps gather competitive intelligence and even provides inspiration for new products and services. Conference Guru works with conference organizers to pass great deals to gre...
The Internet of Things will challenge the status quo of how IT and development organizations operate. Or will it? Certainly the fog layer of IoT requires special insights about data ontology, security and transactional integrity. But the developmental challenges are the same: People, Process and Platform. In his session at @ThingsExpo, Craig Sproule, CEO of Metavine, demonstrated how to move beyond today's coding paradigm and shared the must-have mindsets for removing complexity from the develop...
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, led attendees through the exciting evolution of the cloud. He looked at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering m...
"Evatronix provides design services to companies that need to integrate the IoT technology in their products but they don't necessarily have the expertise, knowledge and design team to do so," explained Adam Morawiec, VP of Business Development at Evatronix, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
Large industrial manufacturing organizations are adopting the agile principles of cloud software companies. The industrial manufacturing development process has not scaled over time. Now that design CAD teams are geographically distributed, centralizing their work is key. With large multi-gigabyte projects, outdated tools have stifled industrial team agility, time-to-market milestones, and impacted P&L stakeholders.
"Akvelon is a software development company and we also provide consultancy services to folks who are looking to scale or accelerate their engineering roadmaps," explained Jeremiah Mothersell, Marketing Manager at Akvelon, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
"IBM is really all in on blockchain. We take a look at sort of the history of blockchain ledger technologies. It started out with bitcoin, Ethereum, and IBM evaluated these particular blockchain technologies and found they were anonymous and permissionless and that many companies were looking for permissioned blockchain," stated René Bostic, Technical VP of the IBM Cloud Unit in North America, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Conventi...
In his session at 21st Cloud Expo, Carl J. Levine, Senior Technical Evangelist for NS1, will objectively discuss how DNS is used to solve Digital Transformation challenges in large SaaS applications, CDNs, AdTech platforms, and other demanding use cases. Carl J. Levine is the Senior Technical Evangelist for NS1. A veteran of the Internet Infrastructure space, he has over a decade of experience with startups, networking protocols and Internet infrastructure, combined with the unique ability to it...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
"Cloud Academy is an enterprise training platform for the cloud, specifically public clouds. We offer guided learning experiences on AWS, Azure, Google Cloud and all the surrounding methodologies and technologies that you need to know and your teams need to know in order to leverage the full benefits of the cloud," explained Alex Brower, VP of Marketing at Cloud Academy, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clar...
Gemini is Yahoo’s native and search advertising platform. To ensure the quality of a complex distributed system that spans multiple products and components and across various desktop websites and mobile app and web experiences – both Yahoo owned and operated and third-party syndication (supply), with complex interaction with more than a billion users and numerous advertisers globally (demand) – it becomes imperative to automate a set of end-to-end tests 24x7 to detect bugs and regression. In th...
"MobiDev is a software development company and we do complex, custom software development for everybody from entrepreneurs to large enterprises," explained Alan Winters, U.S. Head of Business Development at MobiDev, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
Coca-Cola’s Google powered digital signage system lays the groundwork for a more valuable connection between Coke and its customers. Digital signs pair software with high-resolution displays so that a message can be changed instantly based on what the operator wants to communicate or sell. In their Day 3 Keynote at 21st Cloud Expo, Greg Chambers, Global Group Director, Digital Innovation, Coca-Cola, and Vidya Nagarajan, a Senior Product Manager at Google, discussed how from store operations and ...
"There's plenty of bandwidth out there but it's never in the right place. So what Cedexis does is uses data to work out the best pathways to get data from the origin to the person who wants to get it," explained Simon Jones, Evangelist and Head of Marketing at Cedexis, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that CrowdReviews.com has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5–7, 2018, at the Javits Center in New York City, NY. CrowdReviews.com is a transparent online platform for determining which products and services are the best based on the opinion of the crowd. The crowd consists of Internet users that have experienced products and services first-hand and have an interest in letting other potential buye...
SYS-CON Events announced today that Telecom Reseller has been named “Media Sponsor” of SYS-CON's 22nd International Cloud Expo, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Telecom Reseller reports on Unified Communications, UCaaS, BPaaS for enterprise and SMBs. They report extensively on both customer premises based solutions such as IP-PBX as well as cloud based and hosted platforms.