Welcome!

.NET Authors: Srinivasan Sundara Rajan, Pat Romanski, Tad Anderson, Adine Deford, Daniel Keeney

Related Topics: .NET

.NET: 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
DevOps Summit 2015 New York, co-located with the 16th International Cloud Expo - to be held June 9-11, 2015, at the Javits Center in New York City, NY - announces that it is now accepting Keynote Proposals. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time to wait for long development cycles that produce software that is obsolete at launch. DevOps may be disruptive, but it is essential.
“In the past year we've seen a lot of stabilization of WebRTC. You can now use it in production with a far greater degree of certainty. A lot of the real developments in the past year have been in things like the data channel, which will enable a whole new type of application," explained Peter Dunkley, Technical Director at Acision, in this SYS-CON.tv interview at @ThingsExpo, held Nov 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that Windstream, a leading provider of advanced network and cloud communications, has been named “Silver Sponsor” of SYS-CON's 16th International Cloud Expo®, which will take place on June 9–11, 2015, at the Javits Center in New York, NY. Windstream (Nasdaq: WIN), a FORTUNE 500 and S&P 500 company, is a leading provider of advanced network communications, including cloud computing and managed services, to businesses nationwide. The company also offers broadband, phone and digital TV services to consumers primarily in rural areas.
The major cloud platforms defy a simple, side-by-side analysis. Each of the major IaaS public-cloud platforms offers their own unique strengths and functionality. Options for on-site private cloud are diverse as well, and must be designed and deployed while taking existing legacy architecture and infrastructure into account. Then the reality is that most enterprises are embarking on a hybrid cloud strategy and programs. In this Power Panel at 15th Cloud Expo (http://www.CloudComputingExpo.com), moderated by Ashar Baig, Research Director, Cloud, at Gigaom Research, Nate Gordon, Director of T...
The Internet of Things is not new. Historically, smart businesses have used its basic concept of leveraging data to drive better decision making and have capitalized on those insights to realize additional revenue opportunities. So, what has changed to make the Internet of Things one of the hottest topics in tech? In his session at @ThingsExpo, Chris Gray, Director, Embedded and Internet of Things, discussed the underlying factors that are driving the economics of intelligent systems. Discover how hardware commoditization, the ubiquitous nature of connectivity, and the emergence of Big Data a...

ARMONK, N.Y., Nov. 20, 2014 /PRNewswire/ --  IBM (NYSE: IBM) today announced that it is bringing a greater level of control, security and flexibility to cloud-based application development and delivery with a single-tenant version of Bluemix, IBM's platform-as-a-service. The new platform enables developers to build ap...

"BSQUARE is in the business of selling software solutions for smart connected devices. It's obvious that IoT has moved from being a technology to being a fundamental part of business, and in the last 18 months people have said let's figure out how to do it and let's put some focus on it, " explained Dave Wagstaff, VP & Chief Architect, at BSQUARE Corporation, in this SYS-CON.tv interview at @ThingsExpo, held Nov 4-6, 2014, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that IDenticard will exhibit at SYS-CON's 16th International Cloud Expo®, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY. IDenticard™ is the security division of Brady Corp (NYSE: BRC), a $1.5 billion manufacturer of identification products. We have small-company values with the strength and stability of a major corporation. IDenticard offers local sales, support and service to our customers across the United States and Canada. Our partner network encompasses some 300 of the world's leading systems integrators and security s...
"People are a lot more knowledgeable about APIs now. There are two types of people who work with APIs - IT people who want to use APIs for something internal and the product managers who want to do something outside APIs for people to connect to them," explained Roberto Medrano, Executive Vice President at SOA Software, in this SYS-CON.tv interview at Cloud Expo, held Nov 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA.
Nigeria has the largest economy in Africa, at more than US$500 billion, and ranks 23rd in the world. A recent re-evaluation of Nigeria's true economic size doubled the previous estimate, and brought it well ahead of South Africa, which is a member (unlike Nigeria) of the G20 club for political as well as economic reasons. Nigeria's economy can be said to be quite diverse from one point of view, but heavily dependent on oil and gas at the same time. Oil and natural gas account for about 15% of Nigera's overall economy, but traditionally represent more than 90% of the country's exports and as...
The Internet of Things is a misnomer. That implies that everything is on the Internet, and that simply should not be - especially for things that are blurring the line between medical devices that stimulate like a pacemaker and quantified self-sensors like a pedometer or pulse tracker. The mesh of things that we manage must be segmented into zones of trust for sensing data, transmitting data, receiving command and control administrative changes, and peer-to-peer mesh messaging. In his session at @ThingsExpo, Ryan Bagnulo, Solution Architect / Software Engineer at SOA Software, focused on desi...
"At our booth we are showing how to provide trust in the Internet of Things. Trust is where everything starts to become secure and trustworthy. Now with the scaling of the Internet of Things it becomes an interesting question – I've heard numbers from 200 billion devices next year up to a trillion in the next 10 to 15 years," explained Johannes Lintzen, Vice President of Sales at Utimaco, in this SYS-CON.tv interview at @ThingsExpo, held Nov 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA.
"For over 25 years we have been working with a lot of enterprise customers and we have seen how companies create applications. And now that we have moved to cloud computing, mobile, social and the Internet of Things, we see that the market needs a new way of creating applications," stated Jesse Shiah, CEO, President and Co-Founder of AgilePoint Inc., in this SYS-CON.tv interview at 15th Cloud Expo, held Nov 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA.
SYS-CON Events announced today that Gridstore™, the leader in hyper-converged infrastructure purpose-built to optimize Microsoft workloads, will exhibit at SYS-CON's 16th International Cloud Expo®, which will take place on June 9-11, 2015, at the Javits Center in New York City, NY. Gridstore™ is the leader in hyper-converged infrastructure purpose-built for Microsoft workloads and designed to accelerate applications in virtualized environments. Gridstore’s hyper-converged infrastructure is the industry’s first all flash version of HyperConverged Appliances that include both compute and storag...
Today’s enterprise is being driven by disruptive competitive and human capital requirements to provide enterprise application access through not only desktops, but also mobile devices. To retrofit existing programs across all these devices using traditional programming methods is very costly and time consuming – often prohibitively so. In his session at @ThingsExpo, Jesse Shiah, CEO, President, and Co-Founder of AgilePoint Inc., discussed how you can create applications that run on all mobile devices as well as laptops and desktops using a visual drag-and-drop application – and eForms-buildi...
We certainly live in interesting technological times. And no more interesting than the current competing IoT standards for connectivity. Various standards bodies, approaches, and ecosystems are vying for mindshare and positioning for a competitive edge. It is clear that when the dust settles, we will have new protocols, evolved protocols, that will change the way we interact with devices and infrastructure. We will also have evolved web protocols, like HTTP/2, that will be changing the very core of our infrastructures. At the same time, we have old approaches made new again like micro-services...
Code Halos - aka "digital fingerprints" - are the key organizing principle to understand a) how dumb things become smart and b) how to monetize this dynamic. In his session at @ThingsExpo, Robert Brown, AVP, Center for the Future of Work at Cognizant Technology Solutions, outlined research, analysis and recommendations from his recently published book on this phenomena on the way leading edge organizations like GE and Disney are unlocking the Internet of Things opportunity and what steps your organization should be taking to position itself for the next platform of digital competition.
The 3rd International Internet of @ThingsExpo, co-located with the 16th International Cloud Expo - to be held June 9-11, 2015, at the Javits Center in New York City, NY - announces that its Call for Papers is now open. The Internet of Things (IoT) is the biggest idea since the creation of the Worldwide Web more than 20 years ago.
As the Internet of Things unfolds, mobile and wearable devices are blurring the line between physical and digital, integrating ever more closely with our interests, our routines, our daily lives. Contextual computing and smart, sensor-equipped spaces bring the potential to walk through a world that recognizes us and responds accordingly. We become continuous transmitters and receivers of data. In his session at @ThingsExpo, Andrew Bolwell, Director of Innovation for HP's Printing and Personal Systems Group, discussed how key attributes of mobile technology – touch input, sensors, social, and ...
In their session at @ThingsExpo, Shyam Varan Nath, Principal Architect at GE, and Ibrahim Gokcen, who leads GE's advanced IoT analytics, focused on the Internet of Things / Industrial Internet and how to make it operational for business end-users. Learn about the challenges posed by machine and sensor data and how to marry it with enterprise data. They also discussed the tips and tricks to provide the Industrial Internet as an end-user consumable service using Big Data Analytics and Industrial Cloud.