TweetFollow Us on Twitter

Oct 01 Cover Story

Volume Number: 17 (2001)
Issue Number: 10
Column Tag: Software Engineering

Frameworks

by Paul E. Sevinc, Switzerland

Introduction

Reuse is a key objective of software engineering. In our January 2001 article [15], we discussed how reuse is achieved by the use of patterns. To recap, we saw that patterns promote analysis, architecture, or design reuse, but never implementation reuse. A framework supplies the mechanisms that enforce a policy for interaction between software entities with open implementations [2]. As we shall see, frameworks always promote analysis, design, and implementation reuse, but not always architecture reuse.

In this article, we briefly review libraries and toolkits as a point of comparison for frameworks. Then we discuss in more detail object-oriented frameworks. Finally, we touch on the issue of black-box vs. white-box reuse.

Libraries and Toolkits

Szyperski [17, p. 134] notes that "[e]arly programming languages attempted to provide all functions that would ever be used in multiple programs. An explosion of built-in functions was the result. [...] Since then, there has been a clear tendency to take specific functionality out of languages, in favor of abstractional and structural features." The specific functionality that was taken out, as well as additional functionality, was put in libraries. (As explained at the end of this section, toolkits are just special types of libraries.) The evolution of Pascal over Modula-2 to Oberon [11] is but one witness of this tendency.

The primary purpose of software libraries is to provide software engineers with reusable pieces of code (i.e., implementation). The most common kinds of libraries are procedure libraries (also called function libraries) and class libraries.

The Mac Toolbox/Carbon [1] is an example of a procedure/function library. It is designed and implemented in a procedural fashion to be used with a procedural programming language such as Pascal or C. Note that it not only defines procedures/functions, but also data structures (i.e., RECORDs and structs).

The C++ Standard Library [16] is an example of a class library. It is designed and implemented in an object-oriented fashion to be used with an object-oriented programming language, namely C++. Just like C++ is not a purely object-oriented programming language (as opposed to Java for instance), but a hybrid programming language, the C++ Standard Library is not a pure class library. Rather, it is a library of libraries, some of which are class libraries.

Toolkits are simply class libraries whose classes are related [5]. An example is the Java Abstract Window Toolkit (AWT), a library of classes for graphical user interfaces (GUIs) [6].

Libraries vs. Frameworks

First of all, let us dispel a common misconception: frameworks are not exclusive to the realm of object orientation. Oberon microsystems, for instance, have an amazing component framework in their product line [10]. And numerous frameworks have been realized in a procedural programming language such as C. However, we have to add that in the latter case, procedure variables/function pointers are typically used to mimic polymorphism. That said, we nevertheless confine ourselves to object-oriented frameworks, nowadays the most typical kind of frameworks, in the next section.

Whatever the paradigm used, the key difference between libraries and frameworks lies in whether the client is in charge or not:


Figure 1: Library vs. Framework [9].

In procedural programming, the client of a procedure library develops the main procedure and calls library procedures at her own discretion (see Figure 1 left). In a similar manner, when using a class library, the user-defined classes are in control and determine the overall architecture of the system.

The opposite is the case when development is based on frameworks; the framework decides when the user's methods are invoked. Thus, there is an inversion of control; the framework incorporates the control logic [5, 12] (see Figure 1 right). (The way this is realized in object-oriented frameworks is explained in the next section.) This is called the Hollywood principle: "Don't call us, we'll call you!" [9] or the Greyhound principle: "Leave the driving to us." [2].

Examples: The Java Platform Math Class and Model-View-Controller in Swing

The Java Math class [6] defines mathematical functions (e.g., sin) as well constants (e.g., e) and as a whole is obviously a function library. Client code that invokes one of Math's methods relinquishes control only for a split second and does not have to worry about any side effects.

The Model-View-Controller (MVC) pattern [5, 9] depicted in Figure 2 underlies Java's Swing GUI elements [6]. In the case of a text field, for instance, the model manages the actual text in memory, the view displays the text on screen, and the controller determines the text's editability.


Figure 2: Components of the MVC [9].

We are not restricted to using the text field as is. Any of its three constituent parts can be replaced independent of the others by a subclass (e.g., the default controller in order to accept numerical characters only). That and the fact that the methods our subclass overrides are—or in a good design at least should be—invoked only by non-client code make the text field a framework.

Object-Oriented Frameworks

An object-oriented framework is a customizable implementation of software. It consists of a set of cooperating classes and has hot spots [9] (also called plug points [4]), which make the customization possible (see Figure 3).


Figure 3: Framework [9].

Hot spots are abstract, or at least non-final, classes. Through factory, template and hook methods [5], the framework invokes the methods on the subclasses of the hot spots (see Figure 4). But it maintains overall control and makes sure that certain core tasks are fulfilled.


Figure 4: HotSpot [9].

Example: JUnit

JUnit is a framework for unit testing in Java [7]. Its original authors are Kent Beck and Erich Gamma, but it is maintained by an open community of software engineers. JUnit's four core types are partially depicted in Figure 5.

Clients of the framework subclass TestCase to add one or more methods that actually conduct tests. That is, TestCase is a hot spot. The three TestCase methods shown in italic are not really abstract: setUp and tearDown are empty hook methods invoked by the template method run before and after runTest, respectively. And runTest's default implementation invokes the client-added test method designated by the fName field using reflection.


Figure 5: JUnit Extract (adapted from [3]).

Let us discuss the use of the fName field a little bit more. As we already mentioned, a TestCase subclass can define more than one test method to test different aspects of a class or a set of classes. Typically, runTest invokes only one client-added test method (because setUp and tearDown should be invoked before and after every test method, but only by run in order to keep the design clean). Therefore, the TestCase subclass has to be further subclassed to override runTest for each test method. Alternatively, the TestCase subclass is not subclassed further. Instead, fName is defined to contain the name of different test methods for different instances. The latter approach is obviously simpler (albeit less type safe). (Using reflection in this way within an object-oriented framework allows for what could be considered "run-time parameterizable hot-spots".)

Beck and Gamma [3] treat the core design of the JUnit framework (using the language of design patterns) in more detail.

Application and Domain-Specific Frameworks

Frameworks can be domain-specific. FEMO, for instance, is a framework for multiobjective optimization with genetic algorithms [13]. Applications that make use of FEMO relinquish control during optimization runs, but FEMO does not impose any architecture on the application as a whole. Therefore, FEMO promotes analysis, design, and implementation reuse: analysis of the domain, and design and implementation of the classes.

An application framework is a standard program that takes care of window management, menu handling, opening & saving documents, etc., but that has to be extended by the programmer to give them content. Mössenböck [9] calls this programming by difference. Metrowerks' PowerPlant [8] is a typical application framework and as such defines the overall architecture of every PowerPlant-based application.

Black-Box vs. White-Box Reuse

A black-box framework hides its implementation from its clients whereas the implementation of a white-box framework is visible to—and possibly modifiable by—its clients. A glass-box framework is a white-box framework whose implementation is not modifiable. [18] (Note that, rather confusingly, frameworks are sometimes designated as white-box as soon as they emphasize implementation inheritance over object composition [17], whether the implementation is actually visible to the client or not.)

Black-box reuse is preferable over white-box reuse. With the former, when (part of) the framework is replaced by a new release whose interface and specification have not changed, client code should not break. With the latter, the implementation may have to be studied anew, since at least informally it was part of the contract.

Listing 1

method( Type parameter )
   throws IllegalArgumentException
{
   if ( parameter == null || !inRange( parameter ) ) {
      throw new IllegalArgumentException();
   }
   ...
}

For example, after studying its source code, some clients of the white-box method method in Listing 1 might rely on NullPointerExceptions (which are unchecked exceptions in Java and thus need not be declared in the exception specification) never being thrown. In a future version, method no longer checks for null references (see Listing 2), which—let us assume—it never advertised to do anywhere in its formal documentation in the first place. At compile time, all of the existing clients will compile just fine. At run time, however, some might now behave erroneously.

Listing 2

method( Type parameter )
   throws IllegalArgumentException
{
   if ( !inRange( parameter ) ) {
      throw new IllegalArgumentException();
   }
   ...
}

To Probe Further

Mössenböck's Objektorientierte Programmierung in Oberon-2 [9] is an excellent book on object orientation in general. The latest edition features a chapter on frameworks. Unfortunately, this edition has never been translated to English.

Gamma et al.'s Design Patterns [5] is first and foremost a book on, well, design patterns. Nevertheless, it also quickly introduces frameworks and discusses the important relationship between patterns and frameworks.

Szyperski's Component Software [17] is a seminal work on component orientation. It features a chapter discussing reuse in general, including a concise treatment of frameworks.

Acknowledgments

This article is partly based on a chapter in my M.S. thesis [14] that was proofread and commented on by Prof. Dr. Rachid Guerraoui, Dr. Jean-Philippe Martin-Flatin, Luc Girardin, and Dani Seelhofer.

I would like to thank the contributing reviewers for this article, Nate Little and Peter "Primetime" Taylor from Trilogy Software, Inc.

References

  • [1] Apple Computer, Inc. Carbon Developer Documentation. Home Page. Located at
    http://developer.apple.com/techpubs/macosx/Carbon/carbon.html.
  • [2] B. Appleton. "Patterns and Software: Essential Concepts and Terminology". Available at
    http://www.enteract.com/~bradapp/docs/.
  • [3] K. Beck and E. Gamma. "JUnit: A Cook's Tour". Java Report, Vol. 4, No. 5, May 1999.
  • [4] D.F. D'Souza and A.C. Wills. Objects, Components, and Frameworks with UML: The Catalysis Approach. Addison-Wesley, Reading (Massachusetts), 1999.
  • [5] E. Gamma, R. Helm, R. Johnson, and J. Vlissides. Design Patterns: Elements of Reusable Object-Oriented Software. Addison-Wesley, Reading (Massachusetts), 1995.
  • [6] C.S. Horstmann and G. Cornell. Core Java: Fundamentals. Sun Microsystems Press, Palo Alto, 5th edition 2001.
  • [7] JUnit.org. JUnit, Testing Resources for Extreme Programming. Home Page. Located at
    http://www.junit.org/.
  • [8] A. Montgomery. "First Steps". MacTech Magazine, Vol. 17, No. 4, April 2001.
  • [9] H. Mössenböck. Objektorientierte Programmierung in Oberon-2. Springer, Heidelberg, 3rd edition 1998.
  • [10] Oberon microsystems, Inc. BlackBox Component Builder. Home Page. Located at
    http://www.oberon.ch/prod/BlackBox/index.html.
  • [11] M. Reiser and N. Wirth. Programming in Oberon: Steps beyond Pascal and Modula. Addison-Wesley, Reading (Massachusetts), 1992.
  • [12] S.R. Schoch. Classical and Object-Oriented Software Engineering: With UML and Java. McGraw-Hill, Boston, 4th edition 1999.
  • [13] P.E. Sevinç. Ein C++-Framework für die Mehrzieloptimierung mit genetischen Algorithmen. Semester Thesis, Swiss Federal Institute of Technology Zurich, January 1999.
  • [14] P.E. Sevinç. Design Patterns for the Management of IP Networks. M.S. Thesis, Swiss Federal Institute of Technology Zurich, February 2000.
  • [15] P.E. Sevinç. "Patterns". MacTech Magazine, Vol. 17, No. 1, January 2001.
  • [16] B. Stroustrup. The C++ Programming Language. Addison-Wesley, Reading (Massachusetts), 3rd edition 1997.
  • [17] C. Szyperski. Component Software: Beyond Object-Oriented Programming. Addison-Wesley, Reading (Massachusetts), 1998.
  • [18] C. Szyperski. "Components and Objects Together". Software Development, Vol. 7, No. 5, May 1999. Available at
    http://www.sdmagazine.com/breakrm/features/s995f2.shtml.

Paul E. Sevinç is back in Europe after spending three fantastic months in Austin, Texas going through Trilogy University, the corporate boot camp of Trilogy Software, Inc. You can reach him at paul.sevinc@ubilab.org.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

jAlbum Pro 12.6.4 - Organize your digita...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code!... Read more
jAlbum 12.6.4 - Create custom photo gall...
With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly, with pro results Simply drag and drop photos into groups, choose a design... Read more
Microsoft Remote Desktop 8.0.16 - Connec...
With Microsoft Remote Desktop, you can connect to a remote PC and your work resources from almost anywhere. Experience the power of Windows with RemoteFX in a Remote Desktop client designed to help... Read more
Spotify 1.0.4.90. - Stream music, create...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue puts... Read more
djay Pro 1.1 - Transform your Mac into a...
djay Pro provides a complete toolkit for performing DJs. Its unique modern interface is built around a sophisticated integration with iTunes and Spotify, giving you instant access to millions of... Read more
Vivaldi 1.0.118.19 - Lightweight browser...
Vivaldi browser. In 1994, two programmers started working on a web browser. Our idea was to make a really fast browser, capable of running on limited hardware, keeping in mind that users are... Read more
Stacks 2.6.11 - New way to create pages...
Stacks is a new way to create pages in RapidWeaver. It's a plugin designed to combine drag-and-drop simplicity with the power of fluid layout. Features: Fluid Layout: Stacks lets you build pages... Read more
xScope 4.1.3 - Onscreen graphic measurem...
xScope is powerful set of tools that are ideal for measuring, inspecting, and testing on-screen graphics and layouts. Its tools float above your desktop windows and can be accessed via a toolbar,... Read more
Cyberduck 4.7 - FTP and SFTP browser. (F...
Cyberduck is a robust FTP/FTP-TLS/SFTP browser for the Mac whose lack of visual clutter and cleverly intuitive features make it easy to use. Support for external editors and system technologies such... Read more
Labels & Addresses 1.7 - Powerful la...
Labels & Addresses is a home and office tool for printing all sorts of labels, envelopes, inventory labels, and price tags. Merge-printing capability makes the program a great tool for holiday... Read more

Discover Your Reflexes With Minimalist G...
Discover O, BYOF Studios, may look simple at first with its' color matching premise and swipe controls, but as you speed up the task becomes more daunting. [Read more] | Read more »
Here's Another Roundup of Notable A...
Now that the Apple Watch is publically available (kind of), even more apps and games have been popping up for it. Some of them are updates to existing software, others are brand new. The main thing is that they're all for the Apple Watch, and if you... | Read more »
Use Batting Average and the Apple Watch...
Batting Average, by Pixolini, is designed to help you manage your statistics. Every time you go to bat, you can use your Apple Watch to track  your swings, strikes, and hits. [Read more] | Read more »
Celebrate Studio Pango's 3rd Annive...
It is time to party, Pangoland pals! Studio Pango is celebrating their 3rd birthday and their gift to you is a new update to Pangoland. [Read more] | Read more »
Become the World's Most Important D...
Must Deliver, by cherrypick games, is a top-down endless-runner witha healthy dose of the living dead. [Read more] | Read more »
SoundHound + LiveLyrics is Making its De...
SoundHound Inc. has announced that SoundHound + LiveLyrics, will be one of the first third-party apps to hit the Apple Watch. With  SoundHound you'll be able to tap on your watch and have the app recognize the music you are listening to, then have... | Read more »
Adobe Joins the Apple Watch Lineup With...
A whole tidal wave of apps are headed for the Apple Watch, and Adobe has joined in with 3 new ways to enhance your creativity and collaborate with others. The watch apps pair with iPad/iPhone apps to give you total control over your Adobe projects... | Read more »
Z Steel Soldiers, Sequel to Kavcom'...
Kavcom has released Z Steel Soldiers, which continues the story of the comedic RTS originally created by the Bitmap Brothers. [Read more] | Read more »
Seene Lets You Create 3D Images With You...
Seene, by Obvious Engineering, is a 3D capture app that's meant to allow you to create visually stunning 3D images with a tap of your finger, and then share them as a 3D photo, video or gif. [Read more] | Read more »
Lost Within - Tips, Tricks, and Strategi...
Have you just downloaded Lost Within and are you in need of a guiding hand? While it’s not the toughest of games out there you might still want some helpful tips to get you started. [Read more] | Read more »

Price Scanner via MacPrices.net

Zoho Business Apps for Apple Watch Put Select...
Pleasanton, California based Zoho has launched Zoho Business Apps for Apple Watch, a line of apps that extends Zoho business applications to let users perform select functions from an Apple Watch.... Read more
Universal Stylus Initiative Launched to Creat...
OEMs, stylus and touch controller manufacturers have announced the launch of Universal Stylus Initiative (USI), a new organization formed to develop and promote an industry specification for an... Read more
Amazon Shopping App for Apple Watch
With the new Amazon shopping app for Apple Watch, Amazon customers with one of the wearable devices can simply tap the app on the watch to purchase items in seconds, or save an idea for later. The... Read more
Intel Compute Stick: A New Mini-Computing For...
The Intel Compute Stick, a new pocket-sized computer based on a quad-core Intel Atom processor running Windows 8.1 with Bing, is available now through Intel Authorized Dealers across much of the... Read more
Heal to Launch First One-Touch House Call Doc...
Santa Monica, California based Heal, a pioneer in on-demand personal health care services — will offer the first one-touch, on-demand house call doctor app for the Apple Watch. Heal’s Watch app,... Read more
Mac Notebooks: Avoiding MagSafe Power Adapter...
Apple Support says proper usage, care, and maintenance of Your Mac notebook’s MagSafe power adapter can substantially increase the the adapter’s service life. Of course, MagSafe itself is an Apple... Read more
12″ Retina MacBook In Shootout With Air And P...
BareFeats’ rob-ART morgan has posted another comparison of the 12″ MacBook with other Mac laptops, noting that the general goodness of all Mac laptops can make which one to purchase a tough decision... Read more
FileMaker Go for iPad and iPhone: Over 1.5 Mi...
FileMaker has announced that its FileMaker Go for iPad and iPhone app has surpassed 1.5 million downloads from the iTunes App Store. The milestone confirms the continued popularity of the FileMaker... Read more
Sale! 13-inch 2.7GHz Retina MacBook Pro for $...
 Best Buy has the new 2015 13″ 2.7GHz/128GB Retina MacBook Pro on sale for $1099 – $200 off MSRP. Choose free shipping or free local store pickup (if available). Price for online orders only, in-... Read more
Minimalist MacBook Confirms Death of Steve Jo...
ReadWrite’s Adriana Lee has posted a eulogy for the “Digital Hub” concept Steve Jobs first proposed back in 2001, declaring the new 12-inch MacBook with its single, over-subscribed USB-C port to be... Read more

Jobs Board

*Apple* Client Systems Solution Specialist -...
…drive revenue and profit in assigned sales segment and/or region specific to the Apple brand and product sets. This person will work directly with CDW Account Managers Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Support Technician IV - Jack Henry a...
Job Description Jack Henry & Associates is seeking an Apple Support Technician. This position while acting independently, ensures the proper day-to-day control of Read more
*Apple* Client Systems Solution Specialist -...
…drive revenue and profit in assigned sales segment and/or region specific to the Apple brand and product sets. This person will work directly with CDW Account Managers Read more
*Apple* Software Support - Casper (Can work...
…experience . Full knowledge of Mac OS X and prior . Mac OSX / Server . Apple Remote Desktop . Process Documentation . Ability to prioritize multiple tasks in a fast pace Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.