Adapter Design Pattern

Total Page:16

File Type:pdf, Size:1020Kb

Adapter Design Pattern Adapter Design Pattern • The primary purpose of an adapter is to make usable existing, functional code that does not directly meet the interface requirements of a new application; this is a structural design pattern • There are two main implementation techniques – Class adapter –translates the client’s method calls into calls to existing class methods – Object adapter –forwards a client’s calls to an instance of an existing class • A JTable in Java is an example of using the adapter design pattern Acknowledgements • Materials were borrowed from – Design Patterns in Java by Steven Metsker and William Wake (textbook for course) – Head First Design Patterns by Elisabeth Freeman, Eric Freeman, Bert Bates, and Kathy Sierra – The first example is borrowed from lecture notes on Design Patterns by Brian Malloy at Clemson University Example: A Java Interface for a Stack public interface Stack { public void push(int x); public void pop(); public int top(); boolean empty(); } This example is borrowed from lecture notes on Design Patterns by Brian Malloy at Clemson University The Actual Java Implementation public class FixedArray { public FixedArray() { index = -1; items = new int[10]; } public void insert(int x) { items[++index] = x; } public void removeLast() { --index; } public boolean empty() { return index == -1; } public int top() { return items[index]; } private int index; private int [] items; } Using the Java Stack public class StackTest { public static void main(String [] args) { MyStack stk = new MyStack(); stk.push(99); stk.push(7); stk.push(23); while ( !stk.empty() ) { System.out.println(stk.top()); stk.pop(); } } } The Adapter for a Java Stack using an object adapter public class MyStack implements Stack { public MyStack() { array = new FixedArray(); } public void push(int x) { array.insert(x); } public void pop() { array.removeLast(); } public int top() { return array.top(); } public boolean empty() { return array.empty(); } private FixedArray array; } Object Adapter The Adapter for a Java Stack using a class adpater public class MyStack extends FixedArray implements Stack { public MyStack() { super(); } public void push(int x) { insert(x); } public void pop() { removeLast(); } public int top() { return super.top(); } public boolean empty() { return super.empty(); } } Adapting old Java to new Java Enumeration has been present in Java since the beginning (1.0) Iterator was added in Java 1.2 Here is how we can use an adapter We use the object adapter approach The Implementation Class Adapter • The client is using a known (“required”) interface • An existing class does the same work but the methods are named differently • The class adapter is a new class that has the existing class as a parent and at the same time implements the interface • The class adapter calls the “usefulMethod” from its parent to do the work and returns this result to the client Rocket Adapter • Your task is to implement the interface RocketSim • There is an existing class that provides the necessary information, but the method calls don’t match • Design the adapter class OozinozRocket to implement the interface using the existing code Solution 3.1 Challenge 3.2 3.2 Solution Object Adapter • The client calls directly a required method from a required class; no interface is involved • The object adapter is a subclass of the RequiredClass; it will actually implement the required method • The new class will create an instance of the ExistingClass and then call the usefulMethod to do the work • The results are returned back as if the requiredMethod had done the work directly • Assume an existing class called PhysicalRocket can carry out the desired work Solution 3.3 Solution 3.4 JTable in Swing • The JTable API in Swing implements the TableModel interface; the AbstractTableModel is an abstract class in Java the implements the TableModel interface • The user of the AbstractTableModel is only required to implement three methods: getColumnCount, getRowCount, and getValueAt RocketTableModel • The table will display the name, price, and apogee of each rocket • Instances of the Rocket class will contain the necessary data • The RocketTableModel will implement: getColumnCount, getRowCount, and getValueAt RocketTableModel Code Solution 3.5 the main program MouseAdapter • The mouse adapter class implements all the methods in the MouseListerner interface • HOWEVER, all these methods are EMPTY and nonfunctional • The user must implement the methods needed for the particular application Challenge 3.6 • Are you applying the Adapter pattern when you use the MouseAdapter class? Explain how (if yes) or why not (if no). Solution 3.6.
Recommended publications
  • A Mathematical Approach to Object Oriented Design Patterns
    06.2006 J.Natn.Sci.FoundationObject oriented design Sripatterns Lanka 2008 36 (3):219-227 219 RESEARCH ARTICLE A mathematical approach to object oriented design patterns Saluka R. Kodituwakku1*and Peter Bertok2 1 Department of Statistics and Computer Science, Faculty of Science, University of Peradeniya, Peradeniya. 2 Department of Computer Science, RMIT University, Melbourne, Australia. Revised: 27 May 2008 ; Accepted: 18 July 2008 Abstract: Although design patterns are reusable design the distribution of responsibilities. For ease of learning elements, existing pattern descriptions focus on specific and reference, in1, design patterns are organized into a solutions that are not easily reusable in new designs. This paper catalogue. introduces a new pattern description method for object oriented design patterns. The description method aims at providing a The catalogue is formed by two criteria: purpose more general description of patterns so that patterns can be and scope. According to their purpose, design patterns readily reusable. This method also helps a programmer to are classified into creational, structural and behavioural, analyze, compare patterns, and detect patterns from existing software programmes. whereas the scope divides patterns into class patterns and object patterns. Class patterns capture relationships This method differs from the existing pattern description between classes and their subclasses; object patterns deal methods in that it captures both static and dynamic properties with relationships between objects. of patterns. It describes them in terms of mathematical entities rather than natural language narratives, incomplete graphical Software patterns provide reusable solutions to notations or programme fragments. It also helps users to recurring design problems. Even if we have reusable understand the patterns and relationships between them; and solutions they may not be effectively reused, because select appropriate patterns to the problem at hand.
    [Show full text]
  • The Scalable Adapter Design Pattern: Enabling Interoperability Between Educational Software Tools
    The Scalable Adapter Design Pattern: Enabling Interoperability Between Educational Software Tools Andreas Harrer, Catholic University Eichstatt-Ingolstadt,¨ Germany, Niels Pinkwart, Clausthal University of Technology, Germany, Bruce M. McLaren, Carnegie Mellon University, Pittsburgh PA, U.S.A., and DFKI, Saarbrucken,¨ Germany, and Oliver Scheuer, DFKI, Saarbrucken,¨ Germany Abstract For many practical learning scenarios, the integrated use of more than one learning tool is educationally beneficial. In these cases, interoperability between learning tools - getting the pieces to talk to one another in a coherent, well-founded manner - is a crucial requirement that is often hard to achieve. This paper describes a re-usable software design that aims at the integration of independent learning tools into one collaborative learning scenario. We motivate the usefulness and expressiveness of combining several learning tools into one integrated learning experience. Based on this we sketch software design principles that integrate several existing components into a joint technical framework. The feasibility of the approach, which we name the “Scalable Adapter” design pattern, is shown with several implementation examples from different educational technology domains, including Intelligent Tutoring Systems and collaborative learning environments. IEEE keywords: J.m Computer applications, H.5.3 Group and Organization interfaces, K.3.m Computers in Education A short version of this paper appeared in the Proceedings of the Conference on Intelligent Tutoring Systems 2008 1 The Scalable Adapter Design Pattern: Enabling Interoperability Between Educational Software Tools1 I. INTRODUCTION hypothesis and plans. In order to help the student or student In the field of educational technology, there have been groups during the different steps of this inquiry procedure, it numerous attempts in recent years to connect differently makes sense to enable them to have hypotheses, experimenta- targeted learning environments to one another.
    [Show full text]
  • Design Patterns in Ocaml
    Design Patterns in OCaml Antonio Vicente [email protected] Earl Wagner [email protected] Abstract The GOF Design Patterns book is an important piece of any professional programmer's library. These patterns are generally considered to be an indication of good design and development practices. By giving an implementation of these patterns in OCaml we expected to better understand the importance of OCaml's advanced language features and provide other developers with an implementation of these familiar concepts in order to reduce the effort required to learn this language. As in the case of Smalltalk and Scheme+GLOS, OCaml's higher order features allows for simple elegant implementation of some of the patterns while others were much harder due to the OCaml's restrictive type system. 1 Contents 1 Background and Motivation 3 2 Results and Evaluation 3 3 Lessons Learned and Conclusions 4 4 Creational Patterns 5 4.1 Abstract Factory . 5 4.2 Builder . 6 4.3 Factory Method . 6 4.4 Prototype . 7 4.5 Singleton . 8 5 Structural Patterns 8 5.1 Adapter . 8 5.2 Bridge . 8 5.3 Composite . 8 5.4 Decorator . 9 5.5 Facade . 10 5.6 Flyweight . 10 5.7 Proxy . 10 6 Behavior Patterns 11 6.1 Chain of Responsibility . 11 6.2 Command . 12 6.3 Interpreter . 13 6.4 Iterator . 13 6.5 Mediator . 13 6.6 Memento . 13 6.7 Observer . 13 6.8 State . 14 6.9 Strategy . 15 6.10 Template Method . 15 6.11 Visitor . 15 7 References 18 2 1 Background and Motivation Throughout this course we have seen many examples of methodologies and tools that can be used to reduce the burden of working in a software project.
    [Show full text]
  • A Design Pattern Generation Tool
    Project Number: GFP 0801 A DESIGN PATTERN GEN ERATION TOOL A MAJOR QUALIFYING P ROJECT REPORT SUBMITTED TO THE FAC ULTY OF WORCESTER POLYTECHNIC INSTITUTE IN PARTIAL FULFILLME NT OF THE REQUIREMEN TS FOR THE DEGREE OF BACHELOR O F SCIENCE BY CAITLIN VANDYKE APRIL 23, 2009 APPROVED: PROFESSOR GARY POLLICE, ADVISOR 1 ABSTRACT This project determines the feasibility of a tool that, given code, can convert it into equivalent code (e.g. code that performs the same task) in the form of a specified design pattern. The goal is to produce an Eclipse plugin that performs this task with minimal input, such as special tags.. The final edition of this plugin will be released to the Eclipse community. ACKNOWLEGEMENTS This project was completed by Caitlin Vandyke with gratitude to Gary Pollice for his advice and assistance, as well as reference materials and troubleshooting. 2 TABLE OF CONTENTS Abstract ....................................................................................................................................................................................... 2 Acknowlegements ................................................................................................................................................................... 2 Table of Contents ..................................................................................................................................................................... 3 Table of Illustrations .............................................................................................................................................................
    [Show full text]
  • Additional Design Pattern Examples Design Patterns--Factory Method
    Additional Design Pattern Examples • Creational – Factory method – Abstract factory • Structural – Decorator – Adapter • Behavioral – Observer Design Patterns--Factory Method • Intent--Permit a class to be reuseable with arbitrary data types. Specifically, allow the class to be independent of the classes it instantiates – Define an interface for object creation. – Let subclasses decide which class to instantiate. • Motivation – Useful for development of frameworks 1 Factory Method--Continued • Consider a document-processing framework – High-level support for creating, opening, saving documents – Consistent method calls for these commands, regardless of document type (word-processor, spreadsheet, etc.) – Logic to implement these commands delegated to specific types of document objects. – May be some operations common to all document types. Factory Method--Continued Document Processing Example-General Framework: Document Application getTitle( ) * Edits 1 newDocument( ) newDocument( ) openDocument( ) openDocument( ) ... ... MyDocument Problem: How can an Application object newDocument( ) create instances of specific document classes openDocument( ) without being application-specific itself. ... 2 Factory Method--Continued Use of a document creation “factory”: Document Application getTitle( ) * Edits 1 newDocument( ) newDocument( ) openDocument( ) openDocument( ) ... ... 1 requestor * Requests-creation creator 1 <<interface>> MyDocument DocumentFactoryIF newDocument( ) createDocument(type:String):Document openDocument( ) ... DocumentFactory
    [Show full text]
  • Design Patterns Adapter Pattern
    DDEESSIIGGNN PPAATTTTEERRNNSS -- AADDAAPPTTEERR PPAATTTTEERRNN http://www.tutorialspoint.com/design_pattern/adapter_pattern.htm Copyright © tutorialspoint.com Adapter pattern works as a bridge between two incompatible interfaces. This type of design pattern comes under structural pattern as this pattern combines the capability of two independent interfaces. This pattern involves a single class which is responsible to join functionalities of independent or incompatible interfaces. A real life example could be a case of card reader which acts as an adapter between memory card and a laptop. You plugin the memory card into card reader and card reader into the laptop so that memory card can be read via laptop. We are demonstrating use of Adapter pattern via following example in which an audio player device can play mp3 files only and wants to use an advanced audio player capable of playing vlc and mp4 files. Implementation We have a MediaPlayer interface and a concrete class AudioPlayer implementing the MediaPlayer interface. AudioPlayer can play mp3 format audio files by default. We are having another interface AdvancedMediaPlayer and concrete classes implementing the AdvancedMediaPlayer interface. These classes can play vlc and mp4 format files. We want to make AudioPlayer to play other formats as well. To attain this, we have created an adapter class MediaAdapter which implements the MediaPlayer interface and uses AdvancedMediaPlayer objects to play the required format. AudioPlayer uses the adapter class MediaAdapter passing it the desired audio type without knowing the actual class which can play the desired format. AdapterPatternDemo, our demo class will use AudioPlayer class to play various formats. Step 1 Create interfaces for Media Player and Advanced Media Player.
    [Show full text]
  • Java Design Patterns I
    Java Design Patterns i Java Design Patterns Java Design Patterns ii Contents 1 Introduction to Design Patterns 1 1.1 Introduction......................................................1 1.2 What are Design Patterns...............................................1 1.3 Why use them.....................................................2 1.4 How to select and use one...............................................2 1.5 Categorization of patterns...............................................3 1.5.1 Creational patterns..............................................3 1.5.2 Structural patterns..............................................3 1.5.3 Behavior patterns...............................................3 2 Adapter Design Pattern 5 2.1 Adapter Pattern....................................................5 2.2 An Adapter to rescue.................................................6 2.3 Solution to the problem................................................7 2.4 Class Adapter..................................................... 11 2.5 When to use Adapter Pattern............................................. 12 2.6 Download the Source Code.............................................. 12 3 Facade Design Pattern 13 3.1 Introduction...................................................... 13 3.2 What is the Facade Pattern.............................................. 13 3.3 Solution to the problem................................................ 14 3.4 Use of the Facade Pattern............................................... 16 3.5 Download the Source Code.............................................
    [Show full text]
  • Gof Design Patterns
    GoF Design Patterns CSC 440: Software Engineering Slide #1 Topics 1. GoF Design Patterns 2. Template Method 3. Strategy 4. Composite 5. Adapter CSC 440: Software Engineering Slide #2 Design Patterns Book Classic text that started Design Patterns movement written by the Gang of Four (GoF). We’ll introduce several widely used patterns from the book. Useful solutions for certain problems, but if you don’t have the problem, don’t use the pattern. CSC 440: Software Engineering Slide #3 GoF Design Patterns Catalog Behavioral Creational Structural Interpreter Factory Adapter Template Abstract Factory Bridge method Builder Chain of Composite Responsibility Prototype Decorator Command Singleton Façade Iterator Flyweight Mediator Memento Proxy Observer State Strategy Visitor CSC 440: Software Engineering Slide #4 GoF and GRASP Patterns GoF patterns are specializations and/or combinations of the more fundamental GRASP design patterns. Example: Adapter Pattern provides Protected Variations through use of Indirection and Polymorphism CSC 440: Software Engineering Slide #5 Template Method Pattern Name: Template Method Problem: How to implement an algorithm that varies in certain circumstances? Solution: Define the skeleton of the algorithm in the superclass, deferring implementation of the individual steps to the subclasses. CSC 440: Software Engineering Slide #6 Example: The Report Class class Report def output_report(format) if format == :plain puts(“*** #{@title} ***”) elsif format == :html puts(“<html><head>”) puts(“<title>#{@title}</title>”)
    [Show full text]
  • Object-Oriented Design Patterns
    Object-Oriented Design Patterns David Janzen EECS 816 Object-Oriented Software Development University of Kansas Outline • Introduction – Design Patterns Overview – Strategy as an Early Example – Motivation for Creating and Using Design Patterns – History of Design Patterns • Gang of Four (GoF) Patterns – Creational Patterns – Structural Patterns – Behavioral Patterns Copyright © 2006 by David S. 2 Janzen. All rights reserved. What are Design Patterns? • In its simplest form, a pattern is a solution to a recurring problem in a given context • Patterns are not created, but discovered or identified • Some patterns will be familiar? – If you’ve been designing and programming for long, you’ve probably seen some of the patterns we will discuss – If you use Java Foundation Classes (Swing), Copyright © 2006 by David S. 3 you have certaJiannzleyn. Aulls rieghdts rsesoervmed.e design patterns Design Patterns Definition1 • Each pattern is a three-part rule, which expresses a relation between – a certain context, – a certain system of forces which occurs repeatedly in that context, and – a certain software configuration which allows these forces to resolve themselves 1. Dick Gabriel, http://hillside.net/patterns/definition.html Copyright © 2006 by David S. 4 Janzen. All rights reserved. A Good Pattern1 • Solves a problem: – Patterns capture solutions, not just abstract principles or strategies. • Is a proven concept: – Patterns capture solutions with a track record, not theories or speculation 1. James O. Coplien, http://hillside.net/patterns/definition.html Copyright © 2006 by David S. 5 Janzen. All rights reserved. A Good Pattern • The solution isn't obvious: – Many problem-solving techniques (such as software design paradigms or methods) try to derive solutions from first principles.
    [Show full text]
  • Design Patterns Design Patterns
    Design Patterns • More design patterns (GoF) – Structural: Adapter, Bridge, Façade – Creational: Abstract Factory, Singleton – Behavioral: Observer, Iterator, State, Visitor Design Patterns-10, CS431 F06, BG Ryder/A Rountev 1 Design Patterns • Design patterns have become very popular in the last decade or so • Major source: GoF book 1995 • “Design Patterns: Elements of Reusable Object- Oriented Software” • Gamma, Helm, Johnson, Vlissides (gang of 4) • Patterns describe well-known solutions to common design problems • Used in Java libraries, especially in the GUI libraries Design Patterns-10, CS431 F06, BG Ryder/A Rountev 2 1 Design Patterns (LAR Ch26; GoF) • Structural • Concerned with how classes and objects are composed to make larger structures (Adapter, Bridge, Composite, Façade) • Creational • Abstract the instantiation process to make a system independent of how its objects are created & represented (Abstract Factory, Singleton) • Behavioral • Describe patterns of communication and interaction between objects (algorithms and responsibility assignment) (Observer, State, Strategy, Mediator) Design Patterns-10, CS431 F06, BG Ryder/A Rountev 3 Adapter Pattern: Interface Matcher • Problem: incompatible interfaces • Solution: create a wrapper that maps one interface to another • Key point: neither interface has to change and they execute in decoupled manner – Think of how you use a power plug adaptor when you travel to Europe • Example: – Client written against some interface – Server with the right functionality but with the wrong interface
    [Show full text]
  • Unit Testing Services Built on Top of a Legacy System Using Mock Objects and the Adapter Pattern Ketil Jensen Miles IT
    Unit testing services built on top of a legacy system using mock objects and the adapter pattern Ketil Jensen Miles IT Abstract Legacy systems with a growing code base has become an increasing burden in the IT industry the last couple of years. Often these systems has grown to become colossal systems with an unclear architecture and messy interfaces that are difficult to use. At the same time there is an ever-increasing need to integrate more and more IT systems in companies to meet new demands are increasing. As a consequence, exposing functionality from legacy systems as services is becoming common This is of course a good thing since clients then can more easily integrate with these legacy systems. However, one should be careful so that one does not just build yet another layer on top of an already existing pile of rotten code. The challenge The figure shows a simplified view of the architecture for the system that we will look into for the rest of this paper. Our task is to create Service layer services on top of an already existing core layer. This layer has grown into a huge unmaintainabke Core API system over many years and has a messy and DB unclear interface, in short it has all the bad signs of a legacy system which pretty soon will be a Legacy system bottleneck for the organization. The core API consists almost solely of concrete classes and instantiation of some of these classes results in an initialization of nearly all the different DB systems in the chain.
    [Show full text]
  • The Adapter Pattern
    The Adapter Pattern The Adapter Pattern • Intent – Convert the interface of a class into another interface the clients expect. Adapter lets classes work together that couldn't otherwise because of incompatible interfaces. • Also Known As – Wrapper • Motivation – Sometimes a toolkit or class library can not be used because its interface is incompatible with the interface required by an application – We can not change the library interface, since we may not have its source code – Even if we did have the source code, we probably should not change the library for each domain-specific application 1 Motivation Calling object does not need to know the type of object involved, Only the conceptual type. • Now, need to add a new shape: a circle. • Hence, create a new class – Circle – that implements the shape “circle”, to still get polymorphic behaviour. • Need to code the methods for Circle. • What we have: 2 How to Implement the Pattern If circle contained an XX_circle, it could handle the ‘communication’ with the client and let XX_circle handle the work The Pattern in its Context 3 The Adapter Pattern • Structure – A class adapter uses multiple inheritance to adapt one interface to another: The Adapter Pattern • Structure – An object adapter relies on object composition: 4 The Adapter Pattern Consequences The Adapter pattern allows for pre-existing objects to fit into new class structures without being limited by their interfaces. Implementation Contain the existing class in another class. Have the containing class match the required interface
    [Show full text]