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

ColdFusion Developer's Journal Special "Frameworks" Focus Issue: Model-Glue

Separating business logic from the presentation layer

After unzipping the Blueprint Application and configuring my ColdFusion instance to get the application running as-is, I poked around the code to see how it was laid out. It was pretty straightforward: create an object of the component we need to access, call a method in the object, and display the results. This is pretty standard in most applications. Model-Glue (M-G) can easily handle this kind of architecture even though it's not in an MVC pattern.

That's a great strength of Model-Glue. While it facilitates MVC, your application doesn't have to use this pattern to use M-G. Since the task presented to me was to alter the Blueprint Application to use Model-Glue, I decided at this point to keep as much of the original architecture as possible and not re-architect the application in an MVC pattern.

To get started, I downloaded Joe Rinehart's Model-Glue from www.model-glue.com. I put the Model-Glue folder in my webroot, and mapped /modelglue in the ColdFusion Administrator. In the download there's a directory called ModelGlueApplicationTemplate. This folder should be copied to a new location and renamed to match your new application. This folder contains default message-listeners, event-handlers, etc. that Model-Glue will use during runtime for this specific application.

Before I get into the Pet Market application, let me explain exactly what Model-Glue is and how it works. Developed by Joe Rinehart, Model-Glue was created as a framework to help developers separate business logic from the presentation layer. Model-Glue uses a simple XML schema so the developer can define event-handlers and message-listeners. A visual representation of how M-G works is shown in Figure 1.

When a request is placed, an event is passed to the framework via a URL or FORM variable. In Model-Glue, FORM and URL variables end up in one Event object. From your view, you access this object as viewState. In a controller, you access this object as Event. The framework automatically pushes this event object to each controller as an argument (arguments.event). Now, as I said above, I could easily use M-G and architect this application using MVC. Each controller attached to the message-listeners would simply have to accept the Event argument. Anyone who's read up on MVC knows that controllers should contain no interaction with the data persistence layer. Only the Model should interact with your data persistence. Figure 2 shows how Model-Glue fits into the MVC pattern.

In the case of the Pet Market Blueprint Application, we could either use the existing architecture and have Model-Glue act as an intermediary and just call the appropriate view templates that, in turn, access the Model directly, or rewrite the application so Model-Glue calls the controller and returns the data to the view as an MVC patterned architecture should. I think that a full re-architecture is outside the scope of this article and will first get the application running using M-G, and second, re-architect one template to use M-G in an MVC pattern as an example that better shows the power of M-G.

Now that you have a basic understanding of Model-Glue and our plan of attack for this application, let's delve into the Pet Market Blueprint Application and set it up to use Model-Glue.

Before we begin converting our application, we have to determine where to put our files. I generally like to have an assets directory where I keep all items consumed by the application. This doesn't include display templates (view), but does include things like images, components that belong to my application's Model, stylesheets, etc. Model-Glue will work with any directory structure. I just like to keep my directory layout consistent across my applications so it's easy to determine where the items I need are located. Notice that the assets folder only contains components related to our Model. I've learned to keep all controller components in a controller folder under the application root. Once again, this is personal preference and M-G doesn't require any specific directory structure. As a framework, it's very forgiving.

We also need a place to hold our view templates. When using Model-Glue, I usually create a folder in the application root called view. Under the view directory, we can create folders to hold the views specific to our separate modules. While reviewing the existing Blueprint Application code, it seemed like the application views broke into four distinct modules: Search, Products, Checkout, and static templates that would fall into a more general group. In the root of view we can store our general view templates. These templates would include files such as about.cfm, legal.cfm, and other templates that fall outside our application's general functionality. I then created a directory for each of the other modules above (Search, Product, and Checkout).

I now copy over the existing files in the Pet Market Blueprint Application into the appropriate folders. When I'm done, my directory structure looks like Figure 3.

To configure our new Model-Glue application, we edit config/Modelglue.xml. The Modelglue.xml file is broken into three distinct sections: config, controllers, and event-handlers. <Config> contains our application specific configuration settings. <Controllers> defines the location of our controller files and the message-listeners attached to each controller. Every broadcast defined in our event-handler will have one message-listener defined pointing to a method in a controller (refer back to Figure 1). The last section, <event-handlers>, listens for events broadcast during our request. The first event-handler we'll intercept is the event passed from our user (via the URL or a form). Each event handler can then broadcast its own messages that our controller message-listeners "hear" and call methods in our controllers. These controller methods interact with the Model (data persistence) and apply business logic. They then set data into the Event object and set an optional result. If a result's been set, it's interpreted by our event-handler and then the next message is broadcast or another event is fired or the view is displayed. Model-Glue is awesome in that it lets not only several methods be applied during a single request, but that the results set via our controllers can be interpreted by the event handler and another event can be broadcast, or one of several views can be called. Allowing the developer to use this conditional logic is unlike many other frameworks, and is very powerful.

When using Model-Glue, all requests are processed using the index.cfm page by default much like other frameworks. When a request is made from within your application, whether it be from a form action or a URL, it will have the format index.cfm?event=event_name. (Note: the event may also be passed as a form variable.) Event is the default variable name; however, you may customize M-G to listen for any variable name.

I now searched the wrapper.cfm file for all form actions and href links. I needed to have the request call index.cfm with the new event that I defined for each event-handler in ModelGlue.xml (see Listing 1 for an example event-handler). There were also two forms that onChange called submit() and posted back to the current page. I added hidden form fields named event and specified the event that it should post to. Since M-G looks in the Event Object for the event being called and URL and FORM variables are both compiled into this object, this still let me get the desired result. Model-Glue lets you specify which scope takes precedence (statePrecedence) in the <config> section of ModelGlue.xml (FORM or URL) in case both the FORM and URL scopes contain the same variable name.

Since I moved all the templates around and created a new directory structure, I had to point each template to the new location of the wrapper.cfm file. This was easy using a site-wide search and replace. Once the application was able to <cfimport> the wrapper, the application was up and running great, using the Model-Glue framework.

As promised, I then created a search controller to show how Model-Glue processes requests using MVC. The first thing to do is to set up ModelGlue.xml to broadcast a message to be intercepted by a controller, in this case SearchController.cfm (see Listing 2). In the sample application structure we copied over from Model-Glue, there's a template Controller you can use as an example. It includes three required methods by default. The init() method is called as a constructor. OnRequestStart() is invoked when the request first starts processing, and onRequestEnd() is the last method called for that request. I added a function called getSearchResults() to call our product object method search() and then set the results into the Event (see Listing 3). These results are now available in our viewState (see Listing 4). To see the complete controller and ModelGlue.xml, visit www.cfpetmarket.com and download the full code archive for this project.

One more thing I'd like to mention is the built-in Model-Glue debugging feature (see Figure 5). In the <config> section of ModelGlue.xml, there's a debug setting. When set to true, M-G caches important debugging information as your request is processed. This debug information is displayed at the bottom of your request (before the ColdFusion debugging information if you have debugging turned on in CFAdmin) regardless of whether or not an Exception is thrown. It shows information such as the time a specific action, such as an event-handler or message-listener, took to complete. The debug also displays results set in your controllers. In my opinion, the best debugging feature is the built-in trace method. In my controller I can trace any variable of any type by using the format arguments.event.trace("trace_name", variable). This traced value will then display in the Model-Glue debugging output. What a great feature to have at your disposal.

To close out this brief case study, let me say that integrating the Pet Market Blueprint Application into the Model-Glue framework took a total of 30 minutes. It was very simple and while this application didn't use many of M-G's powerful features, it clearly demonstrates that Model-Glue can handle applications of any size or complexity. Just how complex? I'm presently the team lead overseeing what is described as the largest production implementation of Model-Glue, and Model-Glue easily handles the load, reduced the learning curve for new team members learning MVC and OOP, and enabled us to keep the application code tidy. Thanks, Joe!

More Stories By Nic Tunney

Nicholas Tunney is a Macromedia Certified ColdFusion developer, and has been programming ColdFusion for over 7 years. He is currently Senior Software Architect for AboutWeb, a consulting firm located in Rockville, Maryland. To learn more about using objects in ColdFusion, visit Nic's Blog at http://www.nictunney.com.

Comments (0)

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.

@ThingsExpo Stories
BnkToTheFuture.com is the largest online investment platform for investing in FinTech, Bitcoin and Blockchain companies. We believe the future of finance looks very different from the past and we aim to invest and provide trading opportunities for qualifying investors that want to build a portfolio in the sector in compliance with international financial regulations.
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
Imagine if you will, a retail floor so densely packed with sensors that they can pick up the movements of insects scurrying across a store aisle. Or a component of a piece of factory equipment so well-instrumented that its digital twin provides resolution down to the micrometer.
In his keynote at 18th Cloud Expo, Andrew Keys, Co-Founder of ConsenSys Enterprise, provided an overview of the evolution of the Internet and the Database and the future of their combination – the Blockchain. Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settle...
Product connectivity goes hand and hand these days with increased use of personal data. New IoT devices are becoming more personalized than ever before. In his session at 22nd Cloud Expo | DXWorld Expo, Nicolas Fierro, CEO of MIMIR Blockchain Solutions, will discuss how in order to protect your data and privacy, IoT applications need to embrace Blockchain technology for a new level of product security never before seen - or needed.
Leading companies, from the Global Fortune 500 to the smallest companies, are adopting hybrid cloud as the path to business advantage. Hybrid cloud depends on cloud services and on-premises infrastructure working in unison. Successful implementations require new levels of data mobility, enabled by an automated and seamless flow across on-premises and cloud resources. In his general session at 21st Cloud Expo, Greg Tevis, an IBM Storage Software Technical Strategist and Customer Solution Architec...
Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, discussed some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he covered some of the best practices for structured team migration an...
No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
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 ...
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
"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...
When shopping for a new data processing platform for IoT solutions, many development teams want to be able to test-drive options before making a choice. Yet when evaluating an IoT solution, it’s simply not feasible to do so at scale with physical devices. Building a sensor simulator is the next best choice; however, generating a realistic simulation at very high TPS with ease of configurability is a formidable challenge. When dealing with multiple application or transport protocols, you would be...
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
We are given a desktop platform with Java 8 or Java 9 installed and seek to find a way to deploy high-performance Java applications that use Java 3D and/or Jogl without having to run an installer. We are subject to the constraint that the applications be signed and deployed so that they can be run in a trusted environment (i.e., outside of the sandbox). Further, we seek to do this in a way that does not depend on bundling a JRE with our applications, as this makes downloads and installations rat...
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.
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.
In this strange new world where more and more power is drawn from business technology, companies are effectively straddling two paths on the road to innovation and transformation into digital enterprises. The first path is the heritage trail – with “legacy” technology forming the background. Here, extant technologies are transformed by core IT teams to provide more API-driven approaches. Legacy systems can restrict companies that are transitioning into digital enterprises. To truly become a lead...
Digital Transformation (DX) is not a "one-size-fits all" strategy. Each organization needs to develop its own unique, long-term DX plan. It must do so by realizing that we now live in a data-driven age, and that technologies such as Cloud Computing, Big Data, the IoT, Cognitive Computing, and Blockchain are only tools. In her general session at 21st Cloud Expo, Rebecca Wanta explained how the strategy must focus on DX and include a commitment from top management to create great IT jobs, monitor ...
"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...
The IoT Will Grow: In what might be the most obvious prediction of the decade, the IoT will continue to expand next year, with more and more devices coming online every single day. What isn’t so obvious about this prediction: where that growth will occur. The retail, healthcare, and industrial/supply chain industries will likely see the greatest growth. Forrester Research has predicted the IoT will become “the backbone” of customer value as it continues to grow. It is no surprise that retail is ...