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

Macromedia's Data File Access API Architecture Unleashed

Macromedia's Data File Access API Architecture Unleashed

Like its predecessors, Macromedia's most recent installment of the Devnet Resource Kit (DRK 3) is stocked with many excellent utilities for Flash developers. Unlike previous releases, DRK 3 aims to make the lives of ColdFusion developers easier by including many applications and development tools for use in CFMX applications. One of these is an Application Programming Interface I developed called the Data File Access API (DFA API).

When I set out to design and develop the DFA API, the goal was to develop an API that would allow developers to store data in text files as either XML or CSV text, and to access and manipulate that data as easily as if it were stored in a database. With the goal of that core functionality in mind, the primary objective was to invent an architecture that would perform as optimally as possible.

In addition, two other primary objectives were to make the API very easy to use and to make it flexible enough for developers to extend or implement in any way they might need. Ideally, as developers become more familiar with the API, they will be inspired to use it as the backbone of more creative solutions to meet their applications' needs. Let's examine how the features of ColdFusion MX were used to meet these objectives.

The first thing I needed to consider was how to architect the API not only to define and store data, but also to make this data available for very fast filtering and retrieval. What I decided was to create a ColdFusion Component that houses all of the methods for working with the data and that stores all of the data in memory (as needed) in a proprietary XML DOM format, whether the data came from CSV or XML text. I refer to these as "data tables" and think of them as being analogous to database tables cached in memory.

The API needs to be flexible enough to allow data to be retrieved and filtered using XPath or SQL, so component methods exist to determine whether the query passed is XPath or SQL. XPath is applied directly to the XML DOM in memory and in order to use SQL, the XML DOM is first converted to a ColdFusion query object and then queried using Query of Queries. Any call to the API to extract data can retrieve that data as XML or as a ColdFusion query.

Another challenge in developing the API was how to physically define and store the data used in applications. I broke the data table definition task between three XML files: one that defines table definitions (column names, data types, default values, etc.); one that maps the definitions to the actual storage locations (as relative or absolute path or URL) so that the API would know where to find the data; and one XML file that contains the data itself. I chose this architecture so that developers can easily write validation routines (the data type and required properties of data table columns aren't actually used), share data table definitions between applications, etc.

In addition to the ability to retrieve data mentioned above, methods were also written to parse SQL statements that perform INSERT, UPDATE, or DELETE operations on data tables. Unlike when a SELECT statement is passed to the API, converting the XML data table to a ColdFusion query object will do no good for INSERT, UPDATE, and DELETE commands, as ColdFusion does not support these SQL statements in a Query of Queries.

Instead, the SQL is broken into its various components and then executed against the appropriate XML nodes directly. In the case of DELETE commands, working with the data directly as XML proved more efficient than converting the XML to a query object, retrieving the data not being deleted, and converting the new query object back to XML.

In addition to working with XML, the API needed to support CSV so a method was added to parse CSV text and convert it to an XML table in memory. The first row of values in the CSV content is used to create a data table definition, and all other rows populate that definition. Other methods were also added for validation of various entities being used, to make debugging easier, etc. Two other major concerns while developing the API were how to create an easy way for all developers to use the API, and how to handle concurrency issues.

In order to deal with data table memory and physical file concurrency issues, all data retrieval is performed within "read-only" named locks. When row(s) of data are inserted, updated, or deleted from a data table, the data table in memory is first manipulated within an "exclusive" named lock. Afterwards, the entire data table is written to file as an XML string, also within an "exclusive" named lock. This approach minimizes locking on the server, and prevents developers from having to lock API access in their applications, because the API is handling all of the locking - local to the code blocks that require locks.

To make the API easier for developers to use, I wrote a custom tag "wrapper" for the API CFC. The idea behind the custom tag was to give users the ability to use syntax similar to what they are already used to with the <cfquery> tag in order to query the DFA API data for their application. Like <cfquery>, when retrieving data a "name" attribute is passed to assign a name to the result set returned (may be in query or XML format). A "returntype" attribute is used to specify whether to return the results of a query as XML or a ColdFusion query object.

Also similar to <cfquery>, the SQL to SELECT data is passed as the contents of the tag. An XPath attribute is used to select data using an XPath query. Rather than passing a "datasource" name, the tag accepts a "datatable" attribute in order to determine what data table to apply XPath queries to (SQL queries simply name the data table in the SQL). There is also an "XSLT" attribute for performing XSL Transformations on the data (the attribute value is either the location or contents of an XSL stylesheet) and a "CSV" attribute for passing the location of a CSV file (or CSV content) to be parsed into a data table.

Within the tag body a SQL INSERT, UPDATE, SELECT, or DELETE command may be passed, as well as a DROP command to remove a data table from memory, and a SAVE command for committing a data table already in memory to file. The tag itself creates a DFA API instance in the application scope if one doesn't already exist (in start mode), and performs all of its "work" in end mode. The only thing required to use the tag is the existence of three request scope variables that store the locations of the DFA API component, the location of the XML file that defines data table "columns," and the location of the XML file that "maps" these definitions to physical files.

Though the API was never intended for use in large enterprise-level applications, early tests have yielded surprising performance results. The API definitely does perform very well...exactly how much data or how many concurrent users is too many is something you'll have to test for yourself. I wouldn't be surprised to find that even large-scale solutions can be delivered, driven by the API rather than by a traditional database. Even if you decide to stick with the more traditional methods of data storage, I highly recommend looking to the DFA API to serve as an example of how to best architect an API and as an example of how ColdFusion Components, Custom Tags, Query of Queries, and XML Parsing functionality in ColdFusion MX can be combined to achieve amazing results in your applications.

More Stories By Simon Horwith

Simon Horwith is the CIO at AboutWeb, LLC, a Washington, DC based company specializing in staff augmentation, consulting, and training. Simon is a Macromedia Certified Master Instructor and is a member of Team Macromedia. He has been using ColdFusion since version 1.5 and specializes in ColdFusion application architecture, including architecting applications that integrate with Java, Flash, Flex, and a myriad of other technologies. In addition to presenting at CFUGs and conferences around the world, he has also been a contributing author of several books and technical papers.

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 ...