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

ColdFusion Feature: Introducing objectBreeze

The next generation of ORM

One complaint I have heard from many developers being introduced to object-oriented programming (OOP, OO) is that it is more work than it's worth. Setting up your objects, DAOs, gateways, etc., is a lot of coding that, until you have realized the power of OO, probably does seem like quite a bit of work. Here is where an ORM tool, such as objectBreeze, steps up to the plate. In the ColdFusion community we have recently seen a few object-relational mapping (ORM) tools hit the scene. These powerful APIs allow a developer to easily interact with their data persistence layer in an object-oriented pattern with a little setup involved (or none in the case of objectBreeze).

Introduction to objectBreeze
The concept behind objectBreeze is very straightforward. By simply installing an instance of the objectBreeze controller on your Web server, any application on the server can instantly access the API with absolutely no setup or configuration. There is no need to create an object class, data access object (DAO), or gateway. Instead of concentrating on data persistence, you can concentrate on creating your application.

Since objectBreeze instantiates your object from a MasterObject class, there is absolutely no file read/write that occurs when your application accesses the object. objectBreeze is very fast, and since there is no setup involved when using objectBreeze, the learning curve is virtually nonexistent.

To introduce you to objectBreeze, I would like to walk you through creating a sample application. Let's pretend our client, Acme Algorithms, wants to create a search module for their company intranet. Simply put, they want to be able to select a department from a dropdown and/or enter some or all of an employee's name and retrieve a list of employees matching the search criteria. Their database is already designed and we pick out the tables we need for our task (see Figure 1). Seeing these tables makes us instantly think: "We can easily accomplish this with an OO approach." Using OO in this case will allow us to let our search module grow as requirements grow without rewriting large chunks of code.

Step 1: Instantiating the objectBreeze Controller
Since objectBreeze is accessible from any application on your server, you can create several instances of the objectBreeze controller for several database types/datasources in the same application. In this case, we only need one instance of the controller pointing to the client's one datasource. To keep this example simple, we'll instantiate the controller into the application scope in our Application.cfc file (see Listing 1). Then, in the Application.cfc onRequest() method we can set the controller into the variables scope. This will allow us to access objectBreeze from any template's local scope. Outside of this simple example, I would strongly recommend using an MVC pattern and a framework such as Model-Glue to facilitate this process, but this is outside the scope of this article.

In Listing 1, we first define our database type (current values are MSSQL for Microsoft SQL and MySQL) and our datasource name. We then instantiate the controller and initialize it with the defaults we set above. We now have an instantiated controller object that will allow us to access the powerful features of objectBreeze.

Step 2: Understanding the objectBreeze Controller
There are several helpful methods in the objectBreeze controller. First, objectBreeze provides you with two getters so you can access the database type and datasource name of the current instance of the controller. There are then five methods that allow interaction with objects and controllers, four of which are mentioned below:

objectBreeze.objectCreate("tableName")

  • objectCreate() will return an empty object that contains all the properties of the database table. Remember, objectBreeze requires that the table contain a primary key.

    objectBreeze.list(table_name, order_by_list)

  • list() returns all records in the table as a queryObject. You may send an optional order by statement, which is a list of properties to order by (ASC/DESC permitted).

    objectBreeze.getByProperty(table_name, property_name, property_value,
    order_by_list (optional))

  • getByProperty() allows you to specify a single property to query by and returns a query object.

    objectBreeze.getByWhere(table_name, SQL_where_clause, order_by_list (optional)

  • getByWhere() allows you to send a where statement to the query. This statement should not contain 'WHERE'. You may also specify a list to order by.
objectCreate() allows us to create a new object. List(), getByProperty(), and getByWhere() act as an interface to the objectBreeze gateways methods. In this article, we won't be dealing with collectionCreate(), but please feel free to read the documentation at www.objectBreeze.com for more information on using collections in objectBreeze.

Step 3: Understanding the queryObject
The objectBreeze gateway methods return values as a queryObject. This object encapsulates the query and allows easy retrieval of the recordset as objects:

queryObject.getQuery()

  • getQuery() returns the query as type query.

    queryObject.getRecordCount()

  • getRecordCount() returns the number of records in the query object.

    queryObject.hasPrevious()

  • hasPrevious() returns boolean result as to whether or not there is a previous record in the query.

    queryObject.hasNext()

  • hasNext() returns boolean result as to whether or not there is a next record in the query.

    queryObject.getPrevious()

  • getPrevious() returns the previous record in the query as an object.

    queryObject.getNext()

  • getNext() returns the previous record in the query as an object.
As you can see, you may still access the query recordset directly by invoking getQuery(). By checking your current position in the query with hasPrevious() and hasNext(), you can easily loop over the queryObject, returning each individual record as an object. This then allows you to compound each object as necessary and output, commit, etc.

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 (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
SYS-CON Italy News Desk 03/12/06 06:12:43 PM EST

One complaint I have heard from many developers being introduced to object-oriented programming (OOP, OO) is that it is more work than it's worth. Setting up your objects, DAOs, gateways, etc., is a lot of coding that, until you have realized the power of OO, probably does seem like quite a bit of work. Here is where an ORM tool, such as objectBreeze, steps up to the plate. In the ColdFusion community we have recently seen a few object-relational mapping (ORM) tools hit the scene. These powerful APIs allow a developer to easily interact with their data persistence layer in an object-oriented pattern with a little setup involved (or none in the case of objectBreeze).

SYS-CON India News Desk 03/12/06 04:34:28 PM EST

One complaint I have heard from many developers being introduced to object-oriented programming (OOP, OO) is that it is more work than it's worth. Setting up your objects, DAOs, gateways, etc., is a lot of coding that, until you have realized the power of OO, probably does seem like quite a bit of work. Here is where an ORM tool, such as objectBreeze, steps up to the plate. In the ColdFusion community we have recently seen a few object-relational mapping (ORM) tools hit the scene. These powerful APIs allow a developer to easily interact with their data persistence layer in an object-oriented pattern with a little setup involved (or none in the case of objectBreeze).

@ThingsExpo Stories
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.
Cloud-enabled transformation has evolved from cost saving measure to business innovation strategy -- one that combines the cloud with cognitive capabilities to drive market disruption. Learn how you can achieve the insight and agility you need to gain a competitive advantage. Industry-acclaimed CTO and cloud expert, Shankar Kalyana presents. Only the most exceptional IBMers are appointed with the rare distinction of IBM Fellow, the highest technical honor in the company. Shankar has also receive...
"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.
Business professionals no longer wonder if they'll migrate to the cloud; it's now a matter of when. The cloud environment has proved to be a major force in transitioning to an agile business model that enables quick decisions and fast implementation that solidify customer relationships. And when the cloud is combined with the power of cognitive computing, it drives innovation and transformation that achieves astounding competitive advantage.
The Founder of NostaLab and a member of the Google Health Advisory Board, John is a unique combination of strategic thinker, marketer and entrepreneur. His career was built on the "science of advertising" combining strategy, creativity and marketing for industry-leading results. Combined with his ability to communicate complicated scientific concepts in a way that consumers and scientists alike can appreciate, John is a sought-after speaker for conferences on the forefront of healthcare science,...
Data is the fuel that drives the machine learning algorithmic engines and ultimately provides the business value. In his session at Cloud Expo, Ed Featherston, a director and senior enterprise architect at Collaborative Consulting, discussed the key considerations around quality, volume, timeliness, and pedigree that must be dealt with in order to properly fuel that engine.
Explosive growth in connected devices. Enormous amounts of data for collection and analysis. Critical use of data for split-second decision making and actionable information. All three are factors in making the Internet of Things a reality. Yet, any one factor would have an IT organization pondering its infrastructure strategy. How should your organization enhance its IT framework to enable an Internet of Things implementation? In his session at @ThingsExpo, James Kirkland, Red Hat's Chief Archi...
The current age of digital transformation means that IT organizations must adapt their toolset to cover all digital experiences, beyond just the end users’. Today’s businesses can no longer focus solely on the digital interactions they manage with employees or customers; they must now contend with non-traditional factors. Whether it's the power of brand to make or break a company, the need to monitor across all locations 24/7, or the ability to proactively resolve issues, companies must adapt to...
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 settl...
Organizations planning enterprise data center consolidation and modernization projects are faced with a challenging, costly reality. Requirements to deploy modern, cloud-native applications simultaneously with traditional client/server applications are almost impossible to achieve with hardware-centric enterprise infrastructure. Compute and network infrastructure are fast moving down a software-defined path, but storage has been a laggard. Until now.
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...
DXWorldEXPO LLC announced today that the upcoming DXWorldEXPO | CloudEXPO New York event will feature 10 companies from Poland to participate at the "Poland Digital Transformation Pavilion" on November 12-13, 2018.
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...
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...
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...
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.
@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.
"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.
As data explodes in quantity, importance and from new sources, the need for managing and protecting data residing across physical, virtual, and cloud environments grow with it. Managing data includes protecting it, indexing and classifying it for true, long-term management, compliance and E-Discovery. Commvault can ensure this with a single pane of glass solution – whether in a private cloud, a Service Provider delivered public cloud or a hybrid cloud environment – across the heterogeneous enter...
DXWorldEXPO LLC announced today that ICC-USA, a computer systems integrator and server manufacturing company focused on developing products and product appliances, will exhibit at the 22nd International CloudEXPO | DXWorldEXPO. DXWordEXPO New York 2018, colocated with CloudEXPO New York 2018 will be held November 11-13, 2018, in New York City. ICC is a computer systems integrator and server manufacturing company focused on developing products and product appliances to meet a wide range of ...