Welcome!

.NET Authors: Yeshim Deniz, Carmen Gonzalez, Greg O'Connor, Pat Romanski, Elizabeth White

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

SUNNYVALE, Calif., Oct. 20, 2014 /PRNewswire/ -- Spansion Inc. (NYSE: CODE), a global leader in embedded systems, today added 96 new products to the Spansion® FM4 Family of flexible microcontrollers (MCUs). Based on the ARM® Cortex®-M4F core, the new MCUs boast a 200 MHz operating frequency and support a diverse set of on-chip peripherals for enhanced human machine interfaces (HMIs) and machine-to-machine (M2M) communications. The rich set of periphera...

WebRTC defines no default signaling protocol, causing fragmentation between WebRTC silos. SIP and XMPP provide possibilities, but come with considerable complexity and are not designed for use in a web environment. In his session at Internet of @ThingsExpo, Matthew Hodgson, technical co-founder of the Matrix.org, will discuss how Matrix is a new non-profit Open Source Project that defines both a new HTTP-based standard for VoIP & IM signaling and provides reference implementations.
SYS-CON Events announced today that Aria Systems, the recurring revenue expert, has been named "Bronze Sponsor" of SYS-CON's 15th International Cloud Expo®, which will take place on November 4-6, 2014, at the Santa Clara Convention Center in Santa Clara, CA. Aria Systems helps leading businesses connect their customers with the products and services they love. Industry leaders like Pitney Bowes, Experian, AAA NCNU, VMware, HootSuite and many others choose Aria to power their recurring revenue business and deliver exceptional experiences to their customers.
The Internet of Things (IoT) is going to require a new way of thinking and of developing software for speed, security and innovation. This requires IT leaders to balance business as usual while anticipating for the next market and technology trends. Cloud provides the right IT asset portfolio to help today’s IT leaders manage the old and prepare for the new. Today the cloud conversation is evolving from private and public to hybrid. This session will provide use cases and insights to reinforce the value of the network in helping organizations to maximize their company’s cloud experience.
The Internet of Things (IoT) is making everything it touches smarter – smart devices, smart cars and smart cities. And lucky us, we’re just beginning to reap the benefits as we work toward a networked society. However, this technology-driven innovation is impacting more than just individuals. The IoT has an environmental impact as well, which brings us to the theme of this month’s #IoTuesday Twitter chat. The ability to remove inefficiencies through connected objects is driving change throughout every sector, including waste management. BigBelly Solar, located just outside of Boston, is trans...
SYS-CON Events announced today that Matrix.org has been named “Silver Sponsor” of Internet of @ThingsExpo, which will take place on November 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA. Matrix is an ambitious new open standard for open, distributed, real-time communication over IP. It defines a new approach for interoperable Instant Messaging and VoIP based on pragmatic HTTP APIs and WebRTC, and provides open source reference implementations to showcase and bootstrap the new standard. Our focus is on simplicity, security, and supporting the fullest feature set.
Predicted by Gartner to add $1.9 trillion to the global economy by 2020, the Internet of Everything (IoE) is based on the idea that devices, systems and services will connect in simple, transparent ways, enabling seamless interactions among devices across brands and sectors. As this vision unfolds, it is clear that no single company can accomplish the level of interoperability required to support the horizontal aspects of the IoE. The AllSeen Alliance, announced in December 2013, was formed with the goal to advance IoE adoption and innovation in the connected home, healthcare, education, aut...
SYS-CON Events announced today that Red Hat, the world's leading provider of open source solutions, will exhibit at Internet of @ThingsExpo, which will take place on November 4–6, 2014, at the Santa Clara Convention Center in Santa Clara, CA. Red Hat is the world's leading provider of open source software solutions, using a community-powered approach to reliable and high-performing cloud, Linux, middleware, storage and virtualization technologies. Red Hat also offers award-winning support, training, and consulting services. As the connective hub in a global network of enterprises, partners, a...
The only place to be June 9-11 is Cloud Expo & @ThingsExpo 2015 East at the Javits Center in New York City. Join us there as delegates from all over the world come to listen to and engage with speakers & sponsors from the leading Cloud Computing, IoT & Big Data companies. Cloud Expo & @ThingsExpo are the leading events covering the booming market of Cloud Computing, IoT & Big Data for the enterprise. Speakers from all over the world will be hand-picked for their ability to explore the economic strategies that utility/cloud computing provides. Whether public, private, or in a hybrid form, clo...
Software AG helps organizations transform into Digital Enterprises, so they can differentiate from competitors and better engage customers, partners and employees. Using the Software AG Suite, companies can close the gap between business and IT to create digital systems of differentiation that drive front-line agility. We offer four on-ramps to the Digital Enterprise: alignment through collaborative process analysis; transformation through portfolio management; agility through process automation and integration; and visibility through intelligent business operations and big data.
The Transparent Cloud-computing Consortium (abbreviation: T-Cloud Consortium) will conduct research activities into changes in the computing model as a result of collaboration between "device" and "cloud" and the creation of new value and markets through organic data processing High speed and high quality networks, and dramatic improvements in computer processing capabilities, have greatly changed the nature of applications and made the storing and processing of data on the network commonplace.
Be Among the First 100 to Attend & Receive a Smart Beacon. The Physical Web is an open web project within the Chrome team at Google. Scott Jenson leads a team that is working to leverage the scalability and openness of the web to talk to smart devices. The Physical Web uses bluetooth low energy beacons to broadcast an URL wirelessly using an open protocol. Nearby devices can find all URLs in the room, rank them and let the user pick one from a list. Each device is, in effect, a gateway to a web page. This unlocks entirely new use cases so devices can offer tiny bits of information or simple i...
Things are being built upon cloud foundations to transform organizations. This CEO Power Panel at 15th Cloud Expo, moderated by Roger Strukhoff, Cloud Expo and @ThingsExpo conference chair, will address the big issues involving these technologies and, more important, the results they will achieve. How important are public, private, and hybrid cloud to the enterprise? How does one define Big Data? And how is the IoT tying all this together?
The Internet of Things (IoT) is going to require a new way of thinking and of developing software for speed, security and innovation. This requires IT leaders to balance business as usual while anticipating for the next market and technology trends. Cloud provides the right IT asset portfolio to help today’s IT leaders manage the old and prepare for the new. Today the cloud conversation is evolving from private and public to hybrid. This session will provide use cases and insights to reinforce the value of the network in helping organizations to maximize their company’s cloud experience.
TechCrunch reported that "Berlin-based relayr, maker of the WunderBar, an Internet of Things (IoT) hardware dev kit which resembles a chunky chocolate bar, has closed a $2.3 million seed round, from unnamed U.S. and Switzerland-based investors. The startup had previously raised a €250,000 friend and family round, and had been on track to close a €500,000 seed earlier this year — but received a higher funding offer from a different set of investors, which is the $2.3M round it’s reporting."
The Industrial Internet revolution is now underway, enabled by connected machines and billions of devices that communicate and collaborate. The massive amounts of Big Data requiring real-time analysis is flooding legacy IT systems and giving way to cloud environments that can handle the unpredictable workloads. Yet many barriers remain until we can fully realize the opportunities and benefits from the convergence of machines and devices with Big Data and the cloud, including interoperability, data security and privacy.
All major researchers estimate there will be tens of billions devices - computers, smartphones, tablets, and sensors - connected to the Internet by 2020. This number will continue to grow at a rapid pace for the next several decades. Over the summer Gartner released its much anticipated annual Hype Cycle report and the big news is that Internet of Things has now replaced Big Data as the most hyped technology. Indeed, we're hearing more and more about this fascinating new technological paradigm. Every other IT news item seems to be about IoT and its implications on the future of digital busines...
Cultural, regulatory, environmental, political and economic (CREPE) conditions over the past decade are creating cross-industry solution spaces that require processes and technologies from both the Internet of Things (IoT), and Data Management and Analytics (DMA). These solution spaces are evolving into Sensor Analytics Ecosystems (SAE) that represent significant new opportunities for organizations of all types. Public Utilities throughout the world, providing electricity, natural gas and water, are pursuing SmartGrid initiatives that represent one of the more mature examples of SAE. We have s...
The Internet of Things needs an entirely new security model, or does it? Can we save some old and tested controls for the latest emerging and different technology environments? In his session at Internet of @ThingsExpo, Davi Ottenheimer, EMC Senior Director of Trust, will review hands-on lessons with IoT devices and reveal privacy options and a new risk balance you might not expect.
IoT is still a vague buzzword for many people. In his session at Internet of @ThingsExpo, Mike Kavis, Vice President & Principal Cloud Architect at Cloud Technology Partners, will discuss the business value of IoT that goes far beyond the general public's perception that IoT is all about wearables and home consumer services. The presentation will also discuss how IoT is perceived by investors and how venture capitalist access this space. Other topics to discuss are barriers to success, what is new, what is old, and what the future may hold.