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:

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.

IoT & Smart Cities Stories
Whenever a new technology hits the high points of hype, everyone starts talking about it like it will solve all their business problems. Blockchain is one of those technologies. According to Gartner's latest report on the hype cycle of emerging technologies, blockchain has just passed the peak of their hype cycle curve. If you read the news articles about it, one would think it has taken over the technology world. No disruptive technology is without its challenges and potential impediments t...
Nicolas Fierro is CEO of MIMIR Blockchain Solutions. He is a programmer, technologist, and operations dev who has worked with Ethereum and blockchain since 2014. His knowledge in blockchain dates to when he performed dev ops services to the Ethereum Foundation as one the privileged few developers to work with the original core team in Switzerland.
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 settlement products to hedge funds and investment banks. After, he co-founded a revenue cycle management company where he learned about Bitcoin and eventually Ethereal. Andrew's role at ConsenSys Enterprise is a mul...
René Bostic is the Technical VP of the IBM Cloud Unit in North America. Enjoying her career with IBM during the modern millennial technological era, she is an expert in cloud computing, DevOps and emerging cloud technologies such as Blockchain. Her strengths and core competencies include a proven record of accomplishments in consensus building at all levels to assess, plan, and implement enterprise and cloud computing solutions. René is a member of the Society of Women Engineers (SWE) and a m...
If a machine can invent, does this mean the end of the patent system as we know it? The patent system, both in the US and Europe, allows companies to protect their inventions and helps foster innovation. However, Artificial Intelligence (AI) could be set to disrupt the patent system as we know it. This talk will examine how AI may change the patent landscape in the years to come. Furthermore, ways in which companies can best protect their AI related inventions will be examined from both a US and...
In his general session at 19th Cloud Expo, Manish Dixit, VP of Product and Engineering at Dice, discussed how Dice leverages data insights and tools to help both tech professionals and recruiters better understand how skills relate to each other and which skills are in high demand using interactive visualizations and salary indicator tools to maximize earning potential. Manish Dixit is VP of Product and Engineering at Dice. As the leader of the Product, Engineering and Data Sciences team at D...
Bill Schmarzo, Tech Chair of "Big Data | Analytics" of upcoming CloudEXPO | DXWorldEXPO New York (November 12-13, 2018, New York City) today announced the outline and schedule of the track. "The track has been designed in experience/degree order," said Schmarzo. "So, that folks who attend the entire track can leave the conference with some of the skills necessary to get their work done when they get back to their offices. It actually ties back to some work that I'm doing at the University of San...
When talking IoT we often focus on the devices, the sensors, the hardware itself. The new smart appliances, the new smart or self-driving cars (which are amalgamations of many ‘things'). When we are looking at the world of IoT, we should take a step back, look at the big picture. What value are these devices providing. IoT is not about the devices, its about the data consumed and generated. The devices are tools, mechanisms, conduits. This paper discusses the considerations when dealing with the...
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...
Dynatrace is an application performance management software company with products for the information technology departments and digital business owners of medium and large businesses. Building the Future of Monitoring with Artificial Intelligence. Today we can collect lots and lots of performance data. We build beautiful dashboards and even have fancy query languages to access and transform the data. Still performance data is a secret language only a couple of people understand. The more busine...