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
Announcing Poland #DigitalTransformation Pavilion
Digital Transformation is much more than a buzzword. The radical shift to digital mechanisms for almost every process is evident across all industries and verticals. This is often especially true in financial services, where the legacy environment is many times unable to keep up with the rapidly shifting demands of the consumer. The constant pressure to provide complete, omnichannel delivery of customer-facing solutions to meet both regulatory and customer demands is putting enormous pressure on...
DXWorldEXPO LLC announced today that All in Mobile, a mobile app development company from Poland, will exhibit at the 22nd International CloudEXPO | DXWorldEXPO. All In Mobile is a mobile app development company from Poland. Since 2014, they maintain passion for developing mobile applications for enterprises and startups worldwide.
CloudEXPO | DXWorldEXPO are the world's most influential, independent events where Cloud Computing was coined and where technology buyers and vendors meet to experience and discuss the big picture of Digital Transformation and all of the strategies, tactics, and tools they need to realize their goals. Sponsors of DXWorldEXPO | CloudEXPO benefit from unmatched branding, profile building and lead generation opportunities.
The best way to leverage your CloudEXPO | DXWorldEXPO presence as a sponsor and exhibitor is to plan your news announcements around our events. The press covering CloudEXPO | DXWorldEXPO will have access to these releases and will amplify your news announcements. More than two dozen Cloud companies either set deals at our shows or have announced their mergers and acquisitions at CloudEXPO. Product announcements during our show provide your company with the most reach through our targeted audienc...
@DevOpsSummit at Cloud Expo, taking place November 12-13 in New York City, NY, is co-located with 22nd international CloudEXPO | first international DXWorldEXPO and will feature technical sessions from a rock star conference faculty and the leading industry players in the world.
Everything run by electricity will eventually be connected to the Internet. Get ahead of the Internet of Things revolution. In his session at @ThingsExpo, Akvelon expert and IoT industry leader Sergey Grebnov provided an educational dive into the world of managing your home, workplace and all the devices they contain with the power of machine-based AI and intelligent Bot services for a completely streamlined experience.
DXWorldEXPO | CloudEXPO are the world's most influential, independent events where Cloud Computing was coined and where technology buyers and vendors meet to experience and discuss the big picture of Digital Transformation and all of the strategies, tactics, and tools they need to realize their goals. Sponsors of DXWorldEXPO | CloudEXPO benefit from unmatched branding, profile building and lead generation opportunities.
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 ...
In his keynote at 19th Cloud Expo, Sheng Liang, co-founder and CEO of Rancher Labs, discussed the technological advances and new business opportunities created by the rapid adoption of containers. With the success of Amazon Web Services (AWS) and various open source technologies used to build private clouds, cloud computing has become an essential component of IT strategy. However, users continue to face challenges in implementing clouds, as older technologies evolve and newer ones like Docker c...
"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.
JETRO showcased Japan Digital Transformation Pavilion at SYS-CON's 21st International Cloud Expo® at the Santa Clara Convention Center in Santa Clara, CA. The Japan External Trade Organization (JETRO) is a non-profit organization that provides business support services to companies expanding to Japan. With the support of JETRO's dedicated staff, clients can incorporate their business; receive visa, immigration, and HR support; find dedicated office space; identify local government subsidies; get...
Dion Hinchcliffe is an internationally recognized digital expert, bestselling book author, frequent keynote speaker, analyst, futurist, and transformation expert based in Washington, DC. He is currently Chief Strategy Officer at the industry-leading digital strategy and online community solutions firm, 7Summits.
Bill Schmarzo, author of "Big Data: Understanding How Data Powers Big Business" and "Big Data MBA: Driving Business Strategies with Data Science," is responsible for setting the strategy and defining the Big Data service offerings and capabilities for EMC Global Services Big Data Practice. As the CTO for the Big Data Practice, he is responsible for working with organizations to help them identify where and how to start their big data journeys. He's written several white papers, is an avid blogge...
In past @ThingsExpo presentations, Joseph di Paolantonio has explored how various Internet of Things (IoT) and data management and analytics (DMA) solution spaces will come together as sensor analytics ecosystems. This year, in his session at @ThingsExpo, Joseph di Paolantonio from DataArchon, added the numerous Transportation areas, from autonomous vehicles to “Uber for containers.” While IoT data in any one area of Transportation will have a huge impact in that area, combining sensor analytic...
Bill Schmarzo, author of "Big Data: Understanding How Data Powers Big Business" and "Big Data MBA: Driving Business Strategies with Data Science," is responsible for setting the strategy and defining the Big Data service offerings and capabilities for EMC Global Services Big Data Practice. As the CTO for the Big Data Practice, he is responsible for working with organizations to help them identify where and how to start their big data journeys. He's written several white papers, is an avid blogge...
Charles Araujo is an industry analyst, internationally recognized authority on the Digital Enterprise and author of The Quantum Age of IT: Why Everything You Know About IT is About to Change. As Principal Analyst with Intellyx, he writes, speaks and advises organizations on how to navigate through this time of disruption. He is also the founder of The Institute for Digital Transformation and a sought after keynote speaker. He has been a regular contributor to both InformationWeek and CIO Insight...
Michael Maximilien, better known as max or Dr. Max, is a computer scientist with IBM. At IBM Research Triangle Park, he was a principal engineer for the worldwide industry point-of-sale standard: JavaPOS. At IBM Research, some highlights include pioneering research on semantic Web services, mashups, and cloud computing, and platform-as-a-service. He joined the IBM Cloud Labs in 2014 and works closely with Pivotal Inc., to help make the Cloud Found the best PaaS.
It is of utmost importance for the future success of WebRTC to ensure that interoperability is operational between web browsers and any WebRTC-compliant client. To be guaranteed as operational and effective, interoperability must be tested extensively by establishing WebRTC data and media connections between different web browsers running on different devices and operating systems. In his session at WebRTC Summit at @ThingsExpo, Dr. Alex Gouaillard, CEO and Founder of CoSMo Software, presented ...
I think DevOps is now a rambunctious teenager - it's starting to get a mind of its own, wanting to get its own things but it still needs some adult supervision," explained Thomas Hooker, VP of marketing at CollabNet, in this SYS-CON.tv interview at DevOps Summit at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.