Welcome!

Microsoft Cloud Authors: Liz McMillan, Elizabeth White, Mihai Corbuleac, Pat Romanski, David Bermingham

Related Topics: Microsoft Cloud

Microsoft Cloud: Article

Implementing Patterns with Generics

It's more than just collections

It's been a few months since Visual Studio 2005 was released. In that time you've probably seen and read quite a bit about generics. Unfortunately all those articles and presentations can leave you with the impression that generics are useful only in the context of collections (List<T>, Dictionary<K,V>, Queue<T>, and so on).

It's true that many of the most common uses of generics involve collections. But limiting your use to collections will cause you to miss many of the opportunities for creating components that you can reuse in even more ways. In fact, many idioms where developers commonly copy, paste, and modify source code can be solved with generics. You should look for these opportunities, because you'll have more functionality in a smaller code base.

Enhance a generic class, and all users of it are one recompile away from the new features. That's much better than using code snippets. It's a manual task to track down and edit all the copies of a code snippet inserted into your project.

In this article, I'll show you how to find algorithms that can be replaced with generics and how to migrate specific code to its generic counterpart. As examples, I'll show you a quick example by serializing types as XML data, and I'll build a more complicated version, implementing the Proxy class from Design Patterns (Addison-Wesley, 1995).

The Sample Application
To illustrate these topics, I built a simple application that enables you build a collage from a list of images. (See Figure 1.) This is a small sample to illustrate the concepts, so keep your copy of Photoshop for now. The sample application lets you choose a source directory for your images, copy the images onto a background, and move and scale the images. Once you have something you like, you can save the composite image.

We'll examine this application and extract two generic algorithms that you can reuse in your own applications.

Making Generics
Generics are the .NET way of creating algorithms that are loosely coupled to the types on which they operate. That's a large part of the reason why so many of the examples use collections. Collection algorithms don't normally have any dependencies on the types contained in the collections. List<int>, List<string>, List<Employee>, or anything else would work just fine.

The implementation of the collection classes isn't dependent on any properties, or behavior, defined in the type contained. In fact, different generic collections only differ in the capabilities of the collection itself; rarely do they differ in the constraints mandated on the contained type.

In my example, I've used a List<Image> for the list of images in the current collage. The list of files is a BindingList<string> because the BindingList<T> class contains extra functionality that facilitates data binding in Windows forms applications. You've probably already used both of these classes.

Another area where you can see generics used in the .NET Framework is in interfaces that are often used in collections: IEquatable<T>, IEqualityComparer<T>, and ICompar-able<T>. Once again the key to using generics is that signature of the interface is very common: The implementation will depend on the specific type and the parameters depend on the specific type, but the semantic contract is independent of the type.

So the .NET Framework has a rich set of generic classes that are great for various common uses. These classes are designed for very horizontal applications. But they probably aren't all the reusable bits of functionality you'll use in your applications or across multiple applications in your organization. As you develop more code, you'll discover that you've written bits of functionality that you want to reuse in many different ways. With a little work, you can modify these bits of code so that you can reuse them, unmodified, in many different ways.

The first example will provide a mechanism to store and retrieve the current application state. Most desktop applications will store some form of user preferences, or last actions, or similar data. I find that persisting that information using the .NET XML serialization framework is an easy way to implement that. You write a simple class that contains public properties for all the user-controlled options. Then you write two methods to load and save the options. My sample application used the specific UserPreferences class shown in Listing 1.

You'll notice that the LoadFromFile and SaveToFile methods are almost completely independent of the type used (UserSettings). You should be able to reuse these methods anywhere, right? You can. Simply factor out those two methods and put them in a generic class. The wrapper class contains a single member of the target type and provides the load and save code. It also provides a read-only property to access the embedded target object. Limiting the target object to a class type enables you to add a read-only property to modify the embedded storage and still provide appropriate access to the embedded object for the rest of the program. The generic wrapper is shown in Listing 2.

Reusing this is a simple matter of creating a new instantiation with different type information. As an example, let's add the ability of saving your current work to the sample application. Doing so will leverage the AutoSave generic class. Inside the Main form, you've got a list of images:

private List<CollageImage> listOf-Images = new List<CollageImage>();

Essentially, that's the entire storage for the current collage. So let's make a couple of modifications to the CollageImage class that will make it easier to save that via XML serialization. The images need the XMLIgnore attribute:

[XmlIgnore()]
public Image Thumbnail
{
      get
      {
         generateThumbnail();
         return thumbNail;
      }
}

      And the image path must be a read/write property:

public string ImagePath
{
      get { return path; }
      set { path = value; }
}

Next, let's build a simple class that contains the list of images. (See Listing 3.) There is one interesting problem in the generic collections with respect to XML Serialization. For some reason, the XML Serializer can't save or restore a generic IList<T>, but it can serialize and IList interface, provided the appropriate attributes are added to the property. Therefore, I've added two different IList properties to this class, one IList<CollageImage>, one IList. The second is correctly serialized.

Finally, you can use the AutoSave template to create a version of this class that can be serialized. That's it. The point is that you can reuse the AutoSave generic class with only minimal extra work.

Pondering Patterns
Load and save was fairly simple, so let's move on to the more complicated Proxy pattern. Stripped of all the glamour normally associated with a new buzzword, a design pattern is simply a standard proven solution to a common programming problem. Nothing more; nothing less. As such it's a way to reuse common solutions to common problems. Design Patterns by Gamma, Helm, Johnson, and Vlissides (Addison-Wesley, 1995) is still the definitive catalog of patterns.


More Stories By Bill Wagner

A frequent writer and speaker, Bill's work is published in ASP.NET Pro and Visual Studio Magazine. He is the author of C# Core Language Little Black Book and Effective C#. You can reach Bill at [email protected]

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
With major technology companies and startups seriously embracing IoT strategies, now is the perfect time to attend @ThingsExpo 2016 in New York and Silicon Valley. Learn what is going on, contribute to the discussions, and ensure that your enterprise is as "IoT-Ready" as it can be! Internet of @ThingsExpo, taking place Nov 3-5, 2015, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 17th Cloud Expo and will feature technical sessions from a rock star conference faculty ...
Join us at Cloud Expo | @ThingsExpo 2016 – June 7-9 at the Javits Center in New York City and November 1-3 at the Santa Clara Convention Center in Santa Clara, CA – and deliver your unique message in a way that is striking and unforgettable by taking advantage of SYS-CON's unmatched high-impact, result-driven event / media packages.
SYS-CON Events announced today that BMC Software has been named "Siver Sponsor" of SYS-CON's 18th Cloud Expo, which will take place on June 7-9, 2015 at the Javits Center in New York, New York. BMC is a global leader in innovative software solutions that help businesses transform into digital enterprises for the ultimate competitive advantage. BMC Digital Enterprise Management is a set of innovative IT solutions designed to make digital business fast, seamless, and optimized from mainframe to mo...
The IoTs will challenge the status quo of how IT and development organizations operate. Or will it? Certainly the fog layer of IoT requires special insights about data ontology, security and transactional integrity. But the developmental challenges are the same: People, Process and Platform. In his session at @ThingsExpo, Craig Sproule, CEO of Metavine, will demonstrate how to move beyond today's coding paradigm and share the must-have mindsets for removing complexity from the development proc...
18th Cloud Expo, taking place June 7-9, 2016, at the Javits Center in New York City, NY, 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 strategy. Meanwhile, 94% of enterprises are using some...
SoftLayer operates a global cloud infrastructure platform built for Internet scale. With a global footprint of data centers and network points of presence, SoftLayer provides infrastructure as a service to leading-edge customers ranging from Web startups to global enterprises. SoftLayer's modular architecture, full-featured API, and sophisticated automation provide unparalleled performance and control. Its flexible unified platform seamlessly spans physical and virtual devices linked via a world...
In his keynote at 18th Cloud Expo, Andrew Keys, Co-Founder of ConsenSys Enterprise, will provide 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 ...
SYS-CON Events announced today that Tintri Inc., a leading producer of VM-aware storage (VAS) for virtualization and cloud environments, will exhibit at the 18th International CloudExpo®, which will take place on June 7-9, 2016, at the Javits Center in New York City, New York, and the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA.
Designing IoT applications is complex, but deploying them in a scalable fashion is even more complex. A scalable, API first IaaS cloud is a good start, but in order to understand the various components specific to deploying IoT applications, one needs to understand the architecture of these applications and figure out how to scale these components independently. In his session at @ThingsExpo, Nara Rajagopalan is CEO of Accelerite, will discuss the fundamental architecture of IoT applications, ...
The IoT is changing the way enterprises conduct business. In his session at @ThingsExpo, Eric Hoffman, Vice President at EastBanc Technologies, discuss how businesses can gain an edge over competitors by empowering consumers to take control through IoT. We'll cite examples such as a Washington, D.C.-based sports club that leveraged IoT and the cloud to develop a comprehensive booking system. He'll also highlight how IoT can revitalize and restore outdated business models, making them profitable...
SYS-CON Events announced today that Commvault, a global leader in enterprise data protection and information management, has been named “Bronze Sponsor” of SYS-CON's 18th International Cloud Expo, which will take place on June 7–9, 2016, at the Javits Center in New York City, NY, and the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Commvault is a leading provider of data protection and information management...
Companies can harness IoT and predictive analytics to sustain business continuity; predict and manage site performance during emergencies; minimize expensive reactive maintenance; and forecast equipment and maintenance budgets and expenditures. Providing cost-effective, uninterrupted service is challenging, particularly for organizations with geographically dispersed operations.
SYS-CON Events announced today Object Management Group® has been named “Media Sponsor” of SYS-CON's 18th International Cloud Expo, which will take place on June 7–9, 2016, at the Javits Center in New York City, NY, and the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that Alert Logic, Inc., the leading provider of Security-as-a-Service solutions for the cloud, will exhibit at SYS-CON's 18th International Cloud Expo®, which will take place on June 7-9, 2016, at the Javits Center in New York City, NY. Alert Logic, Inc., provides Security-as-a-Service for on-premises, cloud, and hybrid infrastructures, delivering deep security insight and continuous protection for customers at a lower cost than traditional security solutions. Ful...
SYS-CON Events announced today that MobiDev will exhibit at SYS-CON's 18th International Cloud Expo®, which will take place on June 7-9, 2016, at the Javits Center in New York City, NY. MobiDev is a software company that develops and delivers turn-key mobile apps, websites, web services, and complex software systems for startups and enterprises. Since 2009 it has grown from a small group of passionate engineers and business managers to a full-scale mobile software company with over 200 develope...
WebRTC is bringing significant change to the communications landscape that will bridge the worlds of web and telephony, making the Internet the new standard for communications. Cloud9 took the road less traveled and used WebRTC to create a downloadable enterprise-grade communications platform that is changing the communication dynamic in the financial sector. In his session at @ThingsExpo, Leo Papadopoulos, CTO of Cloud9, will discuss the importance of WebRTC and how it enables companies to fo...
SYS-CON Events announced today that EastBanc Technologies will exhibit at SYS-CON's 18th International Cloud Expo®, which will take place on June 7-9, 2016, at the Javits Center in New York City, NY. EastBanc Technologies has been working at the frontier of technology since 1999. Today, the firm provides full-lifecycle software development delivering flexible technology solutions that seamlessly integrate with existing systems – whether on premise or cloud. EastBanc Technologies partners with p...
SYS-CON Events announced today TechTarget has been named “Media Sponsor” of SYS-CON's 18th International Cloud Expo, which will take place on June 7–9, 2016, at the Javits Center in New York City, NY, and the 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. TechTarget is the Web’s leading destination for serious technology buyers researching and making enterprise technology decisions. Its extensive global networ...
SYS-CON Events announced today BZ Media LLC has been named “Media Sponsor” of SYS-CON's 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. BZ Media LLC is a high-tech media company that produces technical conferences and expositions, and publishes a magazine, newsletters and websites in the software development, SharePoint, mobile development and Commercial Drone markets.
SYS-CON Events announced today that MangoApps will exhibit at SYS-CON's 18th International Cloud Expo®, which will take place on June 7-9, 2016, at the Javits Center in New York City, NY. MangoApps provides modern company intranets and team collaboration software, allowing workers to stay connected and productive from anywhere in the world and from any device. For more information, please visit https://www.mangoapps.com/.