Welcome!

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

Data Table Gateways

Working on a collection of records

In my previous article I wrote about Data Access Objects. Data Access Objects, or DAOs for short, are a way to separate your insert, select, delete, and update queries from other business logic. This lets you switch from one data storage mechanism to another easily. Whenever people talk about DAOs they also talk about Data Gateways.

I've also heard them called Table Gateways or more commonly gateway objects. The two often go together and are similar in concept. Data Access Objects are designed to work on a single record, whereas Table Gateways are designed to work on a collection of records.

MyFriends' RSSCategories
In the article on DAOs, I took a component from my RSS Aggregator project, MyFriends, and changed its implementation to use a Data Access object. You can download the aggregator code from the software pod on my blog at www.jeffryhouser.com. For this article, I thought I'd take the same data, RSSCategories, and create a gateway component.

When you enter RSS feeds into the system, they can be categorized in any way you like, and the category information is stored in the RSSCategory table. The table has two columns, a primary key, CategoryID, and a category name column called reasonably enough Category. When creating the DAO, I took an existing component and modified it to use the DAO pattern. Currently, the system doesn't have a gateway component yet, so in this case we'll start from scratch.

Generic Properties & Methods
When creating a Gateway object there are often generic properties and methods that I use. You can encapsulate these into a GenericGateway component. All future gateways will inherit from the gateway.

Here are the generic properties:

  • DSN: When you're accessing a database from ColdFusion, you need to know the name of the datasource. This property holds that.
  • ColumnList: The columnlist property will contain the name of the database columns that you want to retrieve from the database. I usually default this to '*'.
  • MaxRows: How many rows do you want to return? In most cases, you want to return all of the rows, so I default the maxrows property to -1.
  • OrderList: The orderlist property contains a list of all the fields that you're going to order the query results by. The order list is going to be dependent on the columns in the query. I default this to a blank string.
  • Criteria: This is usually a set of properties that you use to define the selection criteria from the query. Perhaps you only want users whose names begin with the letter A. Maybe you only want products whose price is less than $5. I don't implement generic methods in the GenericGateway for these, since they're often specific to the query you want to run.
Here are the generic methods:
  • Getters and Setters: The getters and setters are inherited from the Base Component. I use Hal Helm's generic getter and setter methods, available from his Web site at http://halhelms.com/webresources/BaseComponent.cfc.
  • Init: The init method is one that will define the generic properties of the component such as the DSN, ColumnList, MaxRows, and OrderList.
  • Exceute: The execute method is one that will piece together the query from the various property information, run it, and return the query.
  • Criteria methods: In some cases, the criteria can be more complex than you would set with a simple getter or setter. Perhaps you want to use a range of numbers in your query. Maybe you want to test for equality and similarity using wildcards. Sometimes these are implemented better with their own criteria setting method from inside the sub-component. In most cases, I don't have any additional criteria setting methods. You can use your judgment.
Next I'll show the implementation of the GenericGateway object and then the implementation of an RSSCategories gateway.

The Generic Gateway Object
You can take a look at the code in the Generic Gateway object in Listing 1. It starts out with the cfcomponent tag. Act surprised. The component extends the BaseComponent. The pseudo-constructor code initializes four generic properties: dsn, columnlist, maxrows, and orderlist. There's a single method named init. The init method accepts the four separate arguments, one for each property. If that property is defined, it overrides the default. This is a pretty generic component. I leave the implementation of the execute method for the specific components that inherit from the generic gateway.

Writing the RSSCategoryGateway Object
The RSSCategoryGateway.cfc can be seen in Listing 2. The component extends the GenericGateway, thus inheriting all its methods and properties. It adds two instance variables to the mix, CategoryID and Category. In this case, I'm not changing any of the default values, or I would override them as part of the pseudo-constructor.

There's one new method in this gateway, the execute method. Of course, this component inherits all the methods from the genericGateway, and its parent is the BaseComponent. The execute method, you'll remember, will piece together the query, run it, and return the results. That's exactly what this one does.

The method vars the query name so it stays local to the method. Then it has a cfquery tag. The query selects the columnlist from the table. Since this isn't intended to be generic, I didn't use the tablename as a variable. Then I enter the where conditions. I don't know if there will be any conditions or not, so I use an SQL trick, where 0=0; 0 is always equal to 0, so this condition will always be true no matter what data is returned from the query. Using this as the first condition the query lets me use, which remains true of all future conditions, since there will always be a prior condition. The code checks to see if the CategoryID is zero. If it is, do nothing. If it's not, filter the output based on the CategoryID value. I set up CategoryID to test equality, although it could easily do a greater than or less than, or something else completely depending on the data you're trying to retrieve. Next it checks the Category instance variable. If it's an empty string, do nothing. Otherwise, add in the Category check clause. I added a wildcard to the category field.

If there are no criteria, a finished query may be as simple as:

Select *
From RSSCAtegories
Where 0=0

If both criteria are used together, the query may turn out something like:

Select *
From RSSCAtegories
Where 0=0
    And RSSCAtegories.CategoryID = 1
    And RSSCAtegories.Category like 'A%'

This may seem like a lot of overhead when using a table with just a two fields. But, with larger tables, or more complicated queries, the benefits can be seen more easily. You might use this component when creating a system for editing the categories, but another gateway when creating reports based on categories and RSSFeeds in those categories.

Using the Gateway
I can show you a simple example of how we can use the component RSSCategoryGateway component. First we need to create an instance and run the init method:

variables.RSSCategories = CreateObject("component","#request.ComponentLoc#.RSSCategoryGateway");
variables.RSSCategories.init('*','category',-1, request.DSN);

This was put inside a CFSCript block. The init method just resets the defaults in this case with the exception of the DSN. A blank DSN won't do us any good. This piece of code will run the simple query, with no filters:

ResultsNoFilter = variables.RSSCategories.execute();

You can dump ResultsNoFilter to see all entries in the RSSCategories table. Let's add a filter:

variables.RSSCategories.set('category','A');
ResultsCategoryFilter = variables.RSSCategories.execute();

You can easily dump the results to see all the categories that start with the letter A. This is a simple concept that has a lot of power especially when dealing with complicated queries.

Final Thoughts
As with DAO objects, I feel that Gateways implementations in ColdFusion are severely lacking in documentation. Everyone talks about why to use them; no one talks about how to implement them. I hope this article helped give you a head start on using gateways. It's easy for me to think of variations of this implementation that can achieve the same level of encapsulation and reuse, and still meet the definition of a gateway.

I'm now entering my third year of writing this column. Sometimes it's hard to figure out what to write about in a beginner's column that hasn't been done ad nauseam. I'd love to get some feedback from readers on what they want me to discuss in the coming year. To contact me, just go to my blog at www.jeffryhouser.com and fill out the contact form.

And one last plug, for those who are dying to hear the sound of my voice, I'm the co-host of a Flex-related podcast at www.theflexshow.com. Give a listen if you're interested in Flex!

More Stories By Jeffry Houser

Jeffry is a technical entrepreneur with over 10 years of making the web work for you. Lately Jeffry has been cooped up in his cave building the first in a line of easy to use interface components for Flex Developers at www.flextras.com . He has a Computer Science degree from the days before business met the Internet and owns DotComIt, an Adobe Solutions Partner specializing in Rich Internet Applications. Jeffry is an Adobe Community Expert and produces The Flex Show, a podcast that includes expert interviews and screencast tutorials. Jeffry is also co-manager of the Hartford CT Adobe User Group, author of three ColdFusion books and over 30 articles, and has spoken at various events all over the US. In his spare time he is a musician, old school adventure game aficionado, and recording engineer. He also owns a Wii. You can read his blog at www.jeffryhouser.com, check out his podcast at www.theflexshow.com or check out his company at www.dot-com-it.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
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.