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, Adobe Flex

ColdFusion: Article

CFDJ Feature: Working with Web Services in Adobe Flex 2

Flex class introspection to gain strong typing

Recently I worked on a project using Flex to create a front-end for Java-based Web Services. I ran into a favorite in the Java world: Transfer Objects/Value Objects. Early in the project, I was a bit skeptical of the transfer object model but, later on, I came to respect the value that it offers.

Transfer objects let two separate systems trade descriptive data objects without fear that either system will mistype the data or change the variable names. Transfer objects are an explicit agreement on how data will be encapsulated. They make integration easier because everyone can separate and build their system knowing what variable names and types will be traded. When someone modifies his version of the transfer object, the compile process should catch the changes and alert the file locations to fix the problems.

Flex automatically does the work of transferring a class type when using remote objects (one of the many reasons to use remote objects). However, when using SOAP Web Services, strong typing is broken because the class associations aren't automatically transferred to internal Flex classes. It's unfortunate, and leaves a bit of a gap when trying to use strong typing and compile-time error checking.

What's the value of strong typing? It makes it easier to debug the application. Instead of complaining at some obscure point when a user clicks on a certain button in the middle of a complicated workflow, it breaks during the compile process where the problem can be easily found and fixed. What could have been a two- hour search for a misnamed variable becomes a five-minute change.

The problem here though is how to get the untyped SOAP objects created by Flex into typed objects that Flex knows about - internal implementations of the transfer objects. The values themselves are typed, but there's no association between this data and the transfer object. Further, Flex can't be told that x SOAP object is actually of type y class. For example, trying to cast an incoming Web Service object into a user-defined TO class will cause a runtime error:

public var dpHistory:HistoryTo = event.result.HistoryTo as HistoryTo;

or

public var dpHistory:HistoryTo = HistoryTo(event.result.HistoryTo);

When I started trying to use strong typing of classes on the Flex side, I tried to do the transition by writing a custom transfer function for each type of class I had. For example:

var dpHistory:ArrayCollection = new ArrayCollection;
var tempObj:HistoryTo;
For (var i=0;i<webServiceReturn.result.HistoryTos.length; i++) {
tempObj = new HistoryTo;
tempobj.message = webServiceReturn.result.HistoryTos.getItemAt(i).message;
tempobj.objectName = webServiceReturn.result.HistoryTos.getItemAt(i).objectName;
.......
dpHistory.addItem(tempObj);
}

What a pain! It's error prone and doesn't allow for reuse. It's boring and adds to the amount of upkeep you have to do if anything changes. In the beginning, I avoided using transfer objects simply because that I didn't want to go through the pain of actually coding up every one of my Web Service returns like this. There are a lot of benefits to be gained by using transfer objects, but using the methodology above was horrible getting to them.

To me, the drawbacks (i.e., less code reuse, more duplicate coding, etc.) appeared to outweigh the benefits. Sure, these functions can be written up and saved as an ActionScript file somewhere and included when needed, but it looked like one transfer function was needed per transfer object. And that can be a real pain, especially in a large project with numerous transfer objects.

I figured there had to be a better way. After hunting around a bit, I came up with a solution that worked for my project. All that was needed was a generic object transfer utility to translate the incoming objects into typed classes that are created on the Flex side. Once the transfer objects have been written on the Flex side, then class introspection can be used to dynamically populate the values from untyped Web Service objects. Let me show you how I did it.

First off, create a transfer object class. One of the beautiful things about Flex is the automatic getters and setters for public variables on classes. This means that creating a transfer object can be very simple. Flex is flexible enough to use explicit getters and setters as public properties or to take public properties/variables and create automatic getters and setters for them. Creating custom transfer objects then becomes a breeze and literally takes just a few minutes to put together.

For example, a simple class might be a history display class:

package comp.myProject.to    {
public class HistoryTo {

       public var creationDate:Date = new Date;
       public var message:String = new String;
       public var objectName:String = new String;
       public var objectType:String = new String;

       public function HistoryTo() {
       }

    }
}

Once the custom class (transfer object) has been created on the Flex side, it can be used to store variables. Flex Builder knows about this class and can display hinting on the class names, warn when a property name has been misspelled, and make sure that the properties and values maintain their type across the application. The biggest challenge is filling the class with the proper information.

With a plain object or dynamic class, getting the dynamic values contained inside is done by looping through its properties (dynamic properties are values added to a dynamic class at runtime, like adding variables to a plain object). For example:

    for (item in myObject) {
       // do something here
       myVar = myObject[item];
}

Unfortunately, classes don't support this method for finding static properties. This is where class introspection comes to the rescue. Class introspection returns a listing of all static properties of a class and the types of those properties. Best of all, class introspection is actually very easy in Flex. For example, there's a function in Flex that returns an XML structure of all the class properties:

    import flash.utils.describeType;

var classInfo:XML = describeType(HistoryTo);

The function describeType returns an XML structure that can be looped over to get a listing of the public static properties, class methods, class name, and class base reference (if it extends a class). The function describeType won't return dynamic properties, private properties, or private functions. In the example, the classInfo variable now contains an XML object that can be looped through and/or treated like any other XML-type data source. For instance, it could output the results in a tree (a la the old object inspector for Flex 1.5). In this case, it can be used to loop through the Flex-side transfer classes, pull out the variables and types, check them against the Web Service objects, and transfer the Web Service object values to the appropriate class variables.

The root node contains the name of the class and the name of the class that it extends (if any):

var className:String = [email protected];

To get the list of public variables on the class is relatively simple as well.

The classInfo..variable contains an array of variable names and variable types. Looping through them allows for assignment from one variable to the next:

var vName:String;
var vType:String;

for each (var v:XML in classInfo..variable) {
    // set the xml name and type options to strings for easy comparison
vName = [email protected];
    vType = [email protected];
//do something here
}


More Stories By John Hirschi

Jon Hirschi is a Senior Web Developer at eBay Inc. specializing in content and knowledge management systems. He has been using ColdFusion since version 4.0.

Comments (4) 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
Joel Marks 12/20/06 06:43:54 PM EST

Is this utility only meant for Cold Fusion because I tried to test it out using a regular Axis web service and the translators only return null.

Thanks

n d 08/27/06 03:26:23 PM EDT

Recently I worked on a project using Flex to create a front-end for Java-based Web Services. I ran into a favorite in the Java world: Transfer Objects/Value Objects. Early in the project, I was a bit skeptical of the transfer object model but, later on, I came to respect the value that it offers.

n d 08/27/06 12:11:43 PM EDT

Recently I worked on a project using Flex to create a front-end for Java-based Web Services. I ran into a favorite in the Java world: Transfer Objects/Value Objects. Early in the project, I was a bit skeptical of the transfer object model but, later on, I came to respect the value that it offers.

n d 08/27/06 11:35:16 AM EDT

Recently I worked on a project using Flex to create a front-end for Java-based Web Services. I ran into a favorite in the Java world: Transfer Objects/Value Objects. Early in the project, I was a bit skeptical of the transfer object model but, later on, I came to respect the value that it offers.

IoT & Smart Cities Stories
The challenges of aggregating data from consumer-oriented devices, such as wearable technologies and smart thermostats, are fairly well-understood. However, there are a new set of challenges for IoT devices that generate megabytes or gigabytes of data per second. Certainly, the infrastructure will have to change, as those volumes of data will likely overwhelm the available bandwidth for aggregating the data into a central repository. Ochandarena discusses a whole new way to think about your next...
DXWorldEXPO LLC announced today that Big Data Federation to Exhibit at the 22nd International CloudEXPO, colocated with DevOpsSUMMIT and DXWorldEXPO, November 12-13, 2018 in New York City. Big Data Federation, Inc. develops and applies artificial intelligence to predict financial and economic events that matter. The company uncovers patterns and precise drivers of performance and outcomes with the aid of machine-learning algorithms, big data, and fundamental analysis. Their products are deployed...
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...
All in Mobile is a place where we continually maximize their impact by fostering understanding, empathy, insights, creativity and joy. They believe that a truly useful and desirable mobile app doesn't need the brightest idea or the most advanced technology. A great product begins with understanding people. It's easy to think that customers will love your app, but can you justify it? They make sure your final app is something that users truly want and need. The only way to do this is by ...
CloudEXPO | DevOpsSUMMIT | 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.
Digital Transformation and Disruption, Amazon Style - What You Can Learn. Chris Kocher is a co-founder of Grey Heron, a management and strategic marketing consulting firm. He has 25+ years in both strategic and hands-on operating experience helping executives and investors build revenues and shareholder value. He has consulted with over 130 companies on innovating with new business models, product strategies and monetization. Chris has held management positions at HP and Symantec in addition to ...
Cell networks have the advantage of long-range communications, reaching an estimated 90% of the world. But cell networks such as 2G, 3G and LTE consume lots of power and were designed for connecting people. They are not optimized for low- or battery-powered devices or for IoT applications with infrequently transmitted data. Cell IoT modules that support narrow-band IoT and 4G cell networks will enable cell connectivity, device management, and app enablement for low-power wide-area network IoT. B...
The hierarchical architecture that distributes "compute" within the network specially at the edge can enable new services by harnessing emerging technologies. But Edge-Compute comes at increased cost that needs to be managed and potentially augmented by creative architecture solutions as there will always a catching-up with the capacity demands. Processing power in smartphones has enhanced YoY and there is increasingly spare compute capacity that can be potentially pooled. Uber has successfully ...
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...
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...